42sh is a powerful and user-friendly interactive shell designed to provide a seamless command-line interface for users. Built with efficiency and extensibility in mind, it aims to enhance the user experience in navigating and executing commands on a Unix-like system.
git clone [email protected]:ErwannLesech/42-Sh.git
cd 42-Sh
./42-install.sh
cd src/There are 3 ways to run 42sh program :
Usage: ./42sh {OPTIONS} [SCRIPT] [ARGUMENTS ...]- Read from an shell script
$ ./42sh <shell script path>- Read from a string, with option
-c
$ ./42sh -c "<string>"- Read from standard input
$ ./42sh < <shell script path>
$ cat <shell script path> | ./42shThere are 2 more options that can be activated by inserting these flags into arguments.
$ ./42sh --logger # Print some informations during process
$ ./42sh --pretty-print # Print the parser ASTIn case of pretty-print option, a .gv file is generated. To convert it to a .png to visualise the ast, here is the line:
dot -Tpng pretty_print.gv -o ast.png
display ast.pngIn the 42sh project, our primary objective was to implement a comprehensive set of POSIX features.
These features include, but are not limited to, what follows :
Each step represents every week working on the project.
- Conditionnal operators (if, elif, else, fi)
- Commands list (echo ; ls)
- Single quote strings (echo 'It is an \'exemple\'')
- Comments (echo exem# it is a comment)
- Simple commands (echo, ls, cat, tr, ...)
- Simple builtins (true, false, echo -enE)
- Redirections (>, <, >>, >&, <&, >|, <>)
- Pipes (echo dad | tr a e)
- Negation (! true)
- Basic loops (while, until)
- Operators (&&, ||)
-
Double quote strings (echo "This variable
$a is an amount in $ ") -
Variables (a=2,
$a, $ #, $*, $RANDOM, $UID, $IFS, ...) - For loops
All contributions are done by doing a merge request when you are done working on your own branch
Please, follow these conventions for the repository property :
^(<type>/<name>)$^(<type>(<scope>): <description>
<BLANK LINE>
<body>)$The type refers to the purpose or nature of the commit. It is mandatory.
featCommits, that adds or remove a new featurefixCommits, that fixes a bugrefactorCommits, that rewrite/restructure your code, however does not change any API behaviourperfCommits are specialrefactorcommits, that improve performance
styleCommits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)testCommits, that add missing tests or correcting existing testsdocsCommits, that affect documentation onlybuildCommits, that affect build components like build tool, ci pipeline, dependencies, project version, ...opsCommits, that affect operational components like infrastructure, deployment, backup, recovery, ...choreMiscellaneous commits e.g. modifying.gitignore
The scope refers to the module, component, or area of the project that your commit affects. It is optional.
The description contains a concise description of the change. It is mandatory.
- Use the imperative, present tense: "change" not "changed" nor "changes"
- Don't capitalize the first letter
- No dot (.) at the end
The body provides a more in-depth explanation of the changes made in the commit. It is optional but highly recommended.
- Use the imperative, present tense: "change" not "changed" nor "changes"
fix(http_parser): use the correct HTTP response code for wrong version
Use the HTTP error 405 instead of 400 if the request contains an unsupported HTTP version.
Powered by LESECH Erwann.
At every push/pull_request to master and dev, the CI is executed to check some rules and deploy the result to gh-pages.
Here are main rules to respect in order to check the CI program:
-
configure.acandMakefile.amare used to compile and run the testsuite of 42Sh. -
.clang-formatis used to diff the whole project and check if it's clang-format compliant. -
github/workflows/clang_tidy.shis a shell script that verify if the 42Sh is clang-tidy compliant. -
Doxyfilemust be pushed to be used withdoxygenin order to generate the documentation.