@checkup/cli

@checkup/cli

A CLI that provides health check information about your project.

• @checkup/cli
  • Usage
  • Configuration
  • Commands

Usage

Install checkup CLI globally:

$ yarn global add @checkup/cli

# or

$ npm install -g @checkup/cli

First use the config generator to create a config file in your project's directory:

$ checkup generate config

The checkup CLI is now available to run. Use the run command to run Checkup against your project directory:

$ checkup run .
Checking up on your project...

Run Command

checkup run PATH

A CLI that provides health check information about your project

USAGE
  $ checkup run PATH

ARGUMENTS
  PATH  [default: .] The path referring to the root directory that Checkup will run in

OPTIONS
  -c, --config=config                      Use this configuration, overriding .checkuprc.* if present
  -f, --force
  -h, --help                               show CLI help
  -o, --reportOutputPath=reportOutputPath  [default: .]
  -r, --reporter=stdout|json|pdf           [default: stdout]
  -s, --silent
  -t, --task=task
  -v, --version                            show CLI version

See code: src/commands/run.ts

Generate Command

Checkup comes with a few generators to help generate Checkup plugins and tasks.

checkup generate plugin PLUGIN_NAME PATH

Generate a checkup plugin.

USAGE
  $ checkup generate plugin PLUGIN_NAME PATH

ARGUMENTS
  NAME  name of the plugin (kebab-case)
  PATH  [default: .] The path referring to the directory that the generator will run in

OPTIONS
  --defaults         use defaults for every setting
  --force            overwrite existing files
  --options=options  (typescript)

checkup generate task TASK_NAME PATH

Generate a task within a Checkup plugin.

USAGE
  $ checkup generate task TASK_NAME PATH

ARGUMENTS
  NAME  name of the task (kebab-case)
  PATH  [default: .] The path referring to the directory that the generator will run in

OPTIONS
  --defaults         use defaults for every setting
  --force            overwrite existing files
  --options=options  (typescript)

See code: src/commands/generate.ts

Configuration

Checkup is designed to be completely configurable via a configuration object.

Checkup uses cosmiconfig to find and load your configuration object. Starting from the current working directory, it looks for the following possible sources:

• a .checkuprc file
• a checkup.config.js file exporting a JS object

The search stops when one of these is found, and Checkup uses that object.

The .checkuprc file (without extension) can be in JSON or YAML format. You can add a filename extension to help your text editor provide syntax checking and highlighting:

• .checkup.json
• .checkup.yaml / .checkup.yml
• .checkup.js

You can also specify an explicit path to a configuration via the command line, which will override any configurations found in any .checkuprc.* files

$ checkup --config /some/path/to/my/config/.checkuprc

The configuration object has the following properties:

Plugins

Checkup supports the use of plugins. Before using the plugin, you have to install it using npm/yarn.

$ yarn add -D @checkup/plugin-ember

To configure plugins, use the plugins key in your configuration file, which contains a list of plugin names.

{
  "plugins": ["@checkup/plugin-ember"]
}

Changelog

v0.0.7 (2020-04-16)

:rocket: Enhancement

• #246 Using volta to pin node && yarn versions (@carakessler)

:bug: Bug Fix

• cli
  • #247 Fixing task flag (@scalvert)

:memo: Documentation

• #252 Adding badges to top-level readme (@scalvert)

:house: Internal

• cli, core, plugin-ember-octane, plugin-ember, test-helpers
  • #262 Refactoring build to utilize typescript project references (@scalvert)
• cli
  • #257 Modifying reporter results to use pdf hook (@carakessler)
  • #222 Implementing numerical-card (@carakessler)
• cli, core, plugin-ember-octane, plugin-ember
  • #221 Removing undefined from ReportResultData, and adding mock results to all existing tasks (@carakessler)
• cli, core, test-helpers
  • #256 Updating task ordering to sort by category then priority (@scalvert)
• cli, core, parser-eslint, plugin-ember-octane
  • #251 Extracting parsers to @checkup/core package (@scalvert)
• Other
  • #250 Use volta-cli/action for CI (@rwjblue)
• cli, core, parser-eslint, plugin-ember-octane, test-helpers
  • #245 Adding --no-cache for jest tests to address test caching issues (@scalvert)
• cli, core
  • #237 Implementing table (@carakessler)

Committers: 4

• Robert Jackson (@rwjblue)
• Steve Calvert (@scalvert)
• @carakessler
• @dependabot-preview[bot]