Authoring Plugins

Plugins provide a way to combine Tasks together in logical groupings. They can be configured to run in @checkup/cli as a whole plugin, or individually.

Generate a plugin

Plugins can be generated using the CLI's generate command.

npx

npx checkup generate plugin <plugin-name>

Yarn

yarn checkup generate plugin <plugin-name>

This will generate the following structure:

TypeScript

├── .eslintignore
├── .eslintrc
├── .gitignore
├── .prettierrc.js
├── README.md
├── __tests__
│   └── .gitkeep
├── jest.config.js
├── package.json
├── src
│   ├── index.ts
│   ├── results
│   │   └── .gitkeep
│   ├── tasks
│   │   └── .gitkeep
│   └── types
│       └── index.ts
├── tsconfig.json
└── yarn.lock

JavaScript

├── .eslintignore
├── .eslintrc
├── .gitignore
├── .prettierrc.js
├── README.md
├── **tests**
│   └── .gitkeep
├── jest.config.js
├── package.json
├── src
│   ├── index.js
│   ├── results
│   │   └── .gitkeep
│   └── tasks
│      └── .gitkeep
└── yarn.lock

Plugin commands

Build a plugin (TypeScript only)

yarn build

Or in watch mode:

yarn build:watch

Run tests

yarn test

Run linting

yarn lint

Generate plugin documentation

yarn docs:generate