# @compgen/code-quality

> A robust generator for installing your favorite code quality tools for your project.

Latest version **0.3.8** (published 2021-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @compgen/code-quality
pnpm add @compgen/code-quality
yarn add @compgen/code-quality
bun add @compgen/code-quality
```

Provides the command `code-quality`.

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.8 |
| Published | 2021-03-30 |
| First published | 2020-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 5 |
| Unpacked size | 15.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | michal.jarnot |

## Links

- npm: https://www.npmjs.com/package/@compgen/code-quality
- npm.io page: https://npm.io/package/@compgen/code-quality

## Dependencies (5)

- [@compgen/core](https://npm.io/package/@compgen/core.md) ^0.9.0
- [@compgen/eslint](https://npm.io/package/@compgen/eslint.md) ^0.3.8
- [@compgen/prettier](https://npm.io/package/@compgen/prettier.md) ^0.3.7
- [@compgen/stylelint](https://npm.io/package/@compgen/stylelint.md) ^0.3.7
- [@compgen/editor-config](https://npm.io/package/@compgen/editor-config.md) ^0.1.14

## Recent versions

- 0.3.8 (latest) — 2021-03-30
- 0.3.7 — 2021-03-27
- 0.3.6 — 2021-03-27
- 0.3.5 — 2021-02-21
- 0.3.4 — 2021-02-21
- 0.3.3 — 2021-02-21
- 0.3.2 — 2021-02-21
- 0.3.1 — 2021-02-21
- 0.3.0 — 2021-02-20
- 0.2.2 — 2021-02-20
- 0.2.1 — 2021-02-20
- 0.2.0 — 2021-02-20
- 0.1.3 — 2021-02-19
- 0.1.2 — 2021-02-19
- 0.1.1 — 2021-02-19
- … 2 more at https://npm.io/package/@compgen/code-quality/versions

## README

# @compgen/code-quality

A robust generator for installing your favorite code quality tools for your project.

#### Micro Generators Included

- [@compgen/editor-config](/packages/micro-generators/editor-config)
- [@compgen/eslint](/packages/micro-generators/eslint)
- [@compgen/prettier](/packages/micro-generators/prettier)
- [@compgen/stylelint](/packages/micro-generators/stylelint)

### CLI

I highly recommend using `npx` so that you don't have to install anything globally, and you can always get the latest version from npm.

- **optional** `--path=target_folder`

```bash
npx @compgen/code-quality
```

### Programmatically

You have to generate JSON schema and use `execute` function from `@compgen/core`:

```ts
// src/index.ts
import {
  execute,
  AppType,
  askAppType,
  getProjectFolder,
} from '@compgen/core'
import { createSchema } from '@compgen/code-quality'

const generate = async () => {
  const projectFolder = getProjectFolder() ?? '.'
  const appType = await askAppType()

  const codeQualitySchema = createSchema({ appType })
  await execute(codeQualitySchema, projectFolder)
}

generate()
```

Now all you have to do is run:

```
ts-node src/index.ts
```

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