Ark
Ark copied to clipboard
Add more tests
We never have enough tests (may they be in ArkScript or C++).
We need to have more tests, to ensure every language construct continue to work properly, and that our C++/ArkScript integration is working properly.
I am interested in working on this issue. Can you just guide me how should I start?
Sure!
- You will probably want to see if you can build the project correctly before starting, we have a guide at https://arkscript-lang.dev/tutorials/building.html#from-source
- Then you will probably want to get familiar with the language and/or the API (https://arkscript-lang.dev/impl/ and https://arkscript-lang.dev/tutorials/language.html)
- All the tests are in tests/, we have different directories for:
- the tests written in ArkScript itself,
- in C++ to test the integration of ArkScript (running code in the VM, instanciated in c++, getting values from C++, adding functions in C++ to the VM, etc)
- The AST, which can be obtained as plain JSON (this ensure that the lexer, parser, macro processor and optimizer are doing their job correctly)
- When you think you are ready, make sure to read the contributor guide (https://github.com/ArkScript-lang/Ark/blob/dev/CONTRIBUTING.md), which lists coding guidelines and contains a schema of the project's architecture
The goal of this issue is somewhat linked to #328: we lack test coverage, currently on the builtins (in ArkScript itself), on the C++ integration and on error behaviours as stated in #328 (checking that we are actually detecting errors for a given code, either in the lexer, parser, macro processor, compiler or VM).
If you have questions along the way, feel free to ask.