# TODOs

This our _"backlog"_. Contributions are highly welcome.

- Add semantic versioning and conventional commits
- Introduce a changelog
- Add custom syntax for other frameworks such as mocha or QUnit
- Add info to README that without using the custom syntax, certain functionality such as _pretty output_ (colorful, good error messages, ...) will not come out of the box
- Add an `.archignore` or similar a la `.gitignore` for files that should never be considered by our tests
- Auto generate an architecture documentation based on the tests
- Add a `.because(...)` function a la ArchUnit. Should be used for the error message in case of a failing test as well as for the above auto generate arch-docs
- Enable checking dependencies on node_module files too. However, this needs a careful eye regarding performance. Also keep caching issues in mind if solved via parameters for example.
- Check if its possible to "trick" the tests by using barrell files in a certain way for example. If so, write a guide on what to be careful with!
- Make documentation responsive, in particular mobile friendly
- Add more and robust integration tests
- Logged paths, eg. from failing tests, are not clickable in IntelliJ (in VSCode they are though)
- File/graph/class extraction across all modules (files and metrics in particular) is not DRY enough
- Sometimes there occurrs a bug when using metrics() without specifying a path. An easy workaround is to just specify the tsconfig path, however, this needs to be fixed