# eslint-init

> integrate eslint to a fe project

Latest version **0.1.12** (published 2018-05-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-init
pnpm add eslint-init
yarn add eslint-init
bun add eslint-init
```

Provides the command `eslint-init`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.12 |
| Published | 2018-05-02 |
| First published | 2018-02-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 45.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | lucaPeng |
| Maintainers | jancy1991 |
| Keywords | eslint, integrate |

## Links

- npm: https://www.npmjs.com/package/eslint-init
- Repository: https://github.com/LucaPeng/eslint-init
- Homepage: https://github.com/LucaPeng/eslint-init#readme
- Issues: https://github.com/LucaPeng/eslint-init/issues
- npm.io page: https://npm.io/package/eslint-init

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.3.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.1
- [@types/node](https://npm.io/package/@types/node.md) ^8.9.1
- [@types/shelljs](https://npm.io/package/@types/shelljs.md) ^0.7.8
- [command-exists](https://npm.io/package/command-exists.md) ^1.2.2
- [detect-installed](https://npm.io/package/detect-installed.md) ^2.0.4

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.12 (latest) — 2018-05-02
- 0.1.11 — 2018-04-26
- 0.1.10 — 2018-04-25
- 0.1.9 — 2018-04-18
- 0.1.8 — 2018-04-16
- 0.1.7 — 2018-03-12
- 0.1.6 — 2018-03-12
- 0.1.5 — 2018-03-08
- 0.1.4 — 2018-03-08
- 0.1.3 — 2018-03-08
- 0.1.2 — 2018-03-06
- 0.1.1 — 2018-03-06
- 0.1.0 — 2018-02-27
- 0.0.9 — 2018-02-26
- 0.0.8 — 2018-02-14
- … 7 more at https://npm.io/package/eslint-init/versions

## README

## eslint-init

Fast & simple integrate eslint into your project and your git flow.

Support es6, node, react, vue project, and typescript.

## Installament & Usage

install
``` 
  yarn add eslint-lint
  // npm install eslint-lint
```

use
```
  const eslintInit = require('eslint-init');
  eslintInit.init({
    type: 'node',
    silent: false,
    supportTypeScript: false,
    ciSolution: eslintInit.CiSolution.husky
  });
```

you can use the sharable eslint config maintained by yourself, use the sharedEslintConfig like: 

```
  eslintInit.init({
    type: 'node',
    ciSolution: eslintInit.CiSolution.husky,
    sharedEslintConfig: {
      'eslint-config-mfe': '0.0.7'
    }
  });
```

Only need to make sure it has same structure with [eslint-config-mfe](https://www.npmjs.com/package/eslint-config-mfe) to make the generated eslintrc config effective!!!

you can use the package management tool you want, like npm、cnpm、yarn。

add pmTool to config, like 

```
{
  pmTool: 'yarn'
}
```

## CLI

install globally
```
  npm install eslint-init -g
```

proceed
```
  eslint-init --node
```
under your project path;

Please use --react --vue --es6 to specify the type,

and add `--ts` param in command to support ts, add `--silent` to be silent.

what's more, defaultly use husky as ci solution.

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