Checkup is a framework that uses static analysis and gain insights to help drive maintenance decisions. It provides a framework to run tasks to gather information about the craftsmanship and quality of your codebase. Task results are output as SARIF, which provides a consistent schema for data processing, and can be integrated into your development workflow through IDE integrations.
Checkup allows you to determine the important information you care about, and provides the infrastructure to gather and output that data.
Tasks can gather insights on things like
- Code structure - to give shape to your project, which can help you understand the codebase and identify areas of improvement
- Dependency health - such as which dependency versions are out of date, or outside supported ranges
- Test health - to identify types of tests used, which tests are being skipped, and what the shape of the test infrastructure is
- API compatability - to identify which APIs are being used, and which are not
- Migration status - to give practical insight into how your codebase is being migrated
- Anything else you can dream up... 💡
- Task Runner CLI - A CLI that runs tasks that can be loaded via plugins.
- Code Generators - A collection of generators allowing you to generate a checkup config file, plugin project structure, and task files and tests.
- Plugins - Existing plugins for JavaScript and Ember.
See the documentation for information on installation and usage.
To contribute, please read the CONTRIBUTING guidelines.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!