CH ✅

UI Code Health Check - a simple CLI helper tool that automates your project's key quality checks—linting, testing, TypeScript and spell checking, and building—with a single command. Instead of running each script separately, this tool executes your predefined scripts in order, saving you time and ensuring consistency across your workflow.

- Installation
- Usage
- How It Works
- Example package.json

Features

- Linting: Checks code style with ESLint.
- Testing: Runs your test suite (e.g., Vitest).
- Spell Checking: Finds typos with cspell.
- Type Checking: Verifies types with TypeScript.
- Build: Runs your build process (e.g., Vite).
- Smart Skipping: Skips any missing scripts automatically.

Installation

Add this package as a dev dependency:

``bash
npm install --save-dev ui-code-health-check


or

pnpm add -D ui-code-health-check

or

yarn add -D ui-code-health-check
`

Usage

After installation, you can run the health check from your project root:

`bash
npx ch
`

Or add it as a script in your package.json (example):

`json
{
"scripts": {
"your-script-name": "ch"
}
}
`

How It Works

The tool checks your package.json for the following scripts and runs them in order if they exist:

1. lint
2. test
3. cspell
4. ts-ch
5. build

If a script is missing, that step is skipped.

Then run:

`bash
npm run
`

Example package.json

`json
{
"scripts": {
"lint": "eslint .",
"test": "vitest run",
"cspell": "cspell \"src/*/.{ts,tsx,md}\"",
"ts-ch": "npx tsc --noemit",
"build": "tsc && vite build"
}
}
`

> Note:
> The cspell and ts-ch scripts are enforced by this tool and cannot be renamed or customized.
> Other scripts like lint, test, and build` are chosen for compatibility with industry standards.