# @jills-office/code-health

> Formatting, linting, static analysis, etc.

Latest version **2.2.2** (published 2023-05-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jills-office/code-health
pnpm add @jills-office/code-health
yarn add @jills-office/code-health
bun add @jills-office/code-health
```

Provides the command `health`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2023-05-09 |
| First published | 2023-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jill's Office |
| Maintainers | bthurgood, electrovir |

## Links

- npm: https://www.npmjs.com/package/@jills-office/code-health
- npm.io page: https://npm.io/package/@jills-office/code-health

## Dependencies (3)

- [virmator](https://npm.io/package/virmator.md) ^6.5.1
- [@augment-vir/common](https://npm.io/package/@augment-vir/common.md) ^13.4.0
- [@augment-vir/node-js](https://npm.io/package/@augment-vir/node-js.md) ^13.4.0

## Recent versions

- 2.2.2 (latest) — 2023-05-09
- 2.0.0-beta1 (beta) — 2023-01-20
- 2.2.1 — 2023-05-09
- 2.2.0 — 2023-02-20
- 2.1.1 — 2023-01-20
- 2.1.0 — 2023-01-20
- 2.0.0 — 2023-01-20

## README

# jills-office-code-health

Formatting, linting, static analysis, etc.

# Currently implemented commands

## `format`

Command: `health format`

Formats code through [Prettier](https://prettier.io). Check formatting using the standard Prettier [CLI flag `--check`](https://prettier.io/docs/en/cli.html#--check).

Config files are `.prettierrc.js` and `.prettierignore`.

## `lint`

Command: `health lint`

Lints code through [ESLint](https://eslint.org).

Config files are `.eslintrc.js` and `.eslintignore`.

## `spellcheck`

Command: `health spellcheck`

Spellchecks code through [CSpell](https://cspell.org).

Config file is `cspell.config.js`.

### Examples

```bash
# format all code
npx health format

# check formatting for all code
npx health format --check

# only run formatting for a specific file
npx health format ./src/my-file.ts
```

---
_Source: https://npm.io/package/@jills-office/code-health · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._