Roadmap
- Rules
- Initial rule engine working as expected and unit tested. A small handful of rules selected for unit testing.
- Support for multiple language grammars that follow the tree-sitter standard.
- Initial grammar for Salesforce Apex code via tree-sitter-sfapex
- Approach to how rules are configured and extended 90% finalized.
- Initial work on rule 'packages' that can be loaded dynamically.
- CLI
- CLI built to provide a feature-rich client for the library. Part of the initial ecosystem.
- Documentation
- Basic guidance for execution and rule customization and a quick introduction to the tree-sitter query syntax.
- This wiki
- Initial ruleset of ~60 will have progress posted on this Wiki and updated as the queries and the rules themselves are validated.
- Ongoing documentation: tree-sitter queries, predicates, directives, quantifiers, etc. Landmines and performance considerations
- Rules
- A comprehensive, working set of Apex rules that are already being used by other static analysis tools and will be familiar to users
- An initial mechanism that allows shared functionality between rules. This could be achieved using decorators or another applicable design patter. At a high level:
- Fully functional rule package imports.