Update: I will no longer maintain this project. Nevertheless, it is still usable and can serve the same purpose.
StrexLang ("Strange expression language") is used to train regular expressions in JavaScript. Also a bit of parser design in a hopefully not so boring way. It is a project where a mentor and trainee can work together in a predefined environment.
The Goal is to create an AST in JavaScript that can be serialized. Also to get to know regular expressions in combination with .replace (and what ever fits your needs as well). To get into it you should start with regular expressions that you can rewrite later with a tokenizer.
To test regular expressions the website https://regex101.com/ can be used (in JavaScript mode). Later on (phase 8) the regular expressions are replaced with a tokenizer for a process called "lexical analysis" to give more control over the parser.
An overview of the StrexLang can be found in docs/language.md.
Clone this repository locally:
git clone git@github.com:MartinHelmut/strex-lang.git && cd strex-langor even better fork this repository. This also makes it easier to update your repository later.
After this install the necessary NPM dependencies:
npm iNote: If you forked this repository to implement your parser, it would be lovely if you send a PR to add it to the list of possible implementations 🎉
Open the file src/parser/index.js in your favorite code editor and read the comments included for further guidance.
To test your progress you can execute npm test and see how many green you get 🚀. All tests for the parser, separated by the phases, can be found in the folder src/parser/__tests__. Tests can also provide further documentation.
Development can be done in phases to get step by step to a more sophisticated language.
- Basic language
- Advanced types and calculations
- Error handling
- If expressions
- Nested if expressions
- "And" and "or" if expressions
- Error messages for if expressions
- Human readable error messages
- Multi line expressions
Phases can also be tested running npm test -- phase-01 (for the first phase). If a later phase is tested all phases before are executed as well to ensure nothing broke.
Note: running npm test will execute not only all phases but the compiler tests as well. If you only want to execute compiler tests you can run npm test -- compiler.