is-it-ready

CLI that runs your project's formatting, linting, tests, inventory, and security checks in one dashboard.

Installation

• Global: npm install -g is-it-ready
• Dev only (in your project): npm install --save-dev is-it-ready
• One-off: npx is-it-ready

Usage

is-it-ready [--silent] [--fix] [--watch] [--config <path>] [-h | --help] [-v | --version]

Flags

• -h, --help - Show usage.
• -v, --version - Show version number.
• --config <path> - Use a specific config file instead of searching defaults.
• --silent - Keep the summary table but skip the detailed failure output.
• --fix - Automatically run fix commands for tasks that support it (labels show *).
• --watch - Re-run tasks whenever project files change.

The table shows live status, timings, and overall issue counts. Exit code is 0 when everything passes and 1 otherwise.

Configuration

To get started, you must create a config file in the root directory of your project (i.e., in the same directory as your package.json). However, this tool may be installed globally, in which case you may place the config file in your home directory for global support.

• Supported filenames: .is-it-ready.config.js, .is-it-ready.config.cjs, .is-it-ready.config.mjs (CommonJS module.exports or ESM export default).
• When installed locally the tool also looks for a "is-it-ready" key inside package.json.
• Pass --config <path> (e.g., is-it-ready --config configs/staging.mjs) to point the CLI at a specific file.
• Each file must export an object with a tasks array. Every task entry must specify the tool name and its command, and may provide fixCommand overrides.

Example .is-it-ready.config.mjs:

export default {
  tasks: [
    {
      tool: "Prettier",
      command: "npm run prettier",
      fixCommand: "npm run prettier -- --write",
    },
    {
      tool: "ESLint",
      command: "npm run lint",
    },
  ],
};

Tool support

Currently, this tool only provides support for the following packages/tools:

• ESLint
• Knip
• MarkdownLint (markdownlint-cli2)
• Prettier
• TypeScript
• Vitest

It also provides support for some npm commands

• npm audit

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for detailed guidelines on code standards, testing, and the pull request process.