/checkup

A health checkup for your project.

Primary LanguageTypeScriptMIT LicenseMIT

Checkup: A health checkup for your project

CI Build License Dependabot Volta Managed TypeScript Code Style: prettier

⚠️ Checkup is pre-release and still in active development.

Checkup aims to provide you with insights into your codebase. It runs tasks that leverage existing infrastructure to provide information about key characteristics of your codebase. Task results are output as SARIF, and can be integrated into your development workflow.

Checkup sample output

Checkup can help you with making resourcing decisions, planning and prioritizing the general health of your codebase.

Tasks can gather information about

  • code structure
  • dependency health
  • test health
  • migration status

Features

  • 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, Ember, and Ember Octane.

Usage

See the CLI README for information on usage.

Installation and Contributing

To contribute to Checkup, you'll need to clone and setup the repository. See the installation documentation to start. To contribute, please read the CONTRIBUTING guidelines.

Spec

Read more about the mission, vision, and overall direction of checkup in the spec document.