# @wiz-creative/eslint-config

> WizのESLintルールセットです。

Latest version **1.1.0** (published 2021-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wiz-creative/eslint-config
pnpm add @wiz-creative/eslint-config
yarn add @wiz-creative/eslint-config
bun add @wiz-creative/eslint-config
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-06-23 |
| First published | 2021-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | wiz-creative |
| Maintainers | woohyeonwoo, taku_kodama, mt816 |
| Keywords | eslint |

## Links

- npm: https://www.npmjs.com/package/@wiz-creative/eslint-config
- Repository: https://github.com/wiz-creative/eslint-config
- Homepage: https://github.com/wiz-creative/eslint-config#readme
- Issues: https://github.com/wiz-creative/eslint-config/issues
- npm.io page: https://npm.io/package/@wiz-creative/eslint-config

## Dependencies (15)

- [prettier](https://npm.io/package/prettier.md) ^2.2.1
- [eslint-plugin-vue](https://npm.io/package/eslint-plugin-vue.md) ^7.5.0
- [eslint-config-next](https://npm.io/package/eslint-config-next.md) ^11.0.1
- [eslint-plugin-node](https://npm.io/package/eslint-plugin-node.md) ^11.1.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.22.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.22.1
- [eslint-plugin-promise](https://npm.io/package/eslint-plugin-promise.md) ^4.2.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^7.2.0
- [eslint-config-standard](https://npm.io/package/eslint-config-standard.md) ^16.0.2
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.3.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^4.14.1
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.2.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^4.14.1
- [@secretlint/secretlint-rule-no-dotenv](https://npm.io/package/@secretlint/secretlint-rule-no-dotenv.md) ^2.1.1
- [@secretlint/secretlint-rule-preset-recommend](https://npm.io/package/@secretlint/secretlint-rule-preset-recommend.md) ^2.1.1

## 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

- 1.1.0 (latest) — 2021-06-23
- 1.0.13 — 2021-06-17
- 1.0.12 — 2021-06-11
- 1.0.11 — 2021-06-07
- 1.0.10 — 2021-06-04
- 1.0.9 — 2021-06-04
- 1.0.8 — 2021-06-03
- 1.0.7 — 2021-06-01
- 1.0.6 — 2021-05-26
- 1.0.5 — 2021-05-26
- 1.0.4 — 2021-05-26
- 1.0.3 — 2021-05-26
- 1.0.2 — 2021-05-24
- 1.0.1 — 2021-05-24
- 1.0.0 — 2021-05-24

## README

# @wiz-creative/eslint-config
WizのESLintルールセットです。

このパッケージは、Wizでの使用を目的としています。  
現在開発中のため、ルールが変更される可能性がありますのでご注意下さい。

## 導入手順
### 1. パッケージインストール
- eslint
- @wiz-creative/eslint-config
```
npm install --save-dev eslint @wiz-creative/eslint-config
```

### 2. .eslintrc.js作成
プロジェクトに応じて以下を記述して下さい。

- JavaScript
```
module.exports = {
  extends: ['@wiz-creative/eslint-config'],
}
```
- TypeScript
```
module.exports = {
  extends: ['@wiz-creative/eslint-config/presets/typescript'],
}
```
- React
```
module.exports = {
  extends: ['@wiz-creative/eslint-config/presets/react'],
}
```
- React + TypeScript
```
module.exports = {
  extends: ['@wiz-creative/eslint-config/presets/react-typescript'],
}
```
- Vue
```
module.exports = {
  extends: ['@wiz-creative/eslint-config/presets/vue'],
}
```
- Vue + TypeScript
```
module.exports = {
  extends: ['@wiz-creative/eslint-config/presets/vue-typescript'],
}
```
- Next.js
```
module.exports = {
  extends: ['@wiz-creative/eslint-config/presets/next'],
}
```
### 3. package.json修正
○○はそれぞれの拡張子に変更して下さい。
```
"scripts": {
  ...
  "lint": "eslint './src/**/*.○○'",           
  "lint:fix": "eslint --fix './src/**/*.○○'"
}
```

## 使用方法
### Lintエラー検出
```
npm run lint
```
### Lintエラー検出・自動補完
```
npm run lint:fix
```
## 各Lintルール・エラー詳細
- [base](docs/base.md)
- [TypeScript](docs/typescript.md)
- [React](docs/react.md)
- [Vue](docs/vue.md)

## 補足
### Lintルールを変更する場合
`.eslintrc.js`
```
module.exports = {
  extends: "@wiz-creative/~~",
  // 追記
  rules: {
    ~~~
  }
}
```

### Lint管理を除外する場合
`.eslintrc.js`
```
module.exports = {
  extends: "@wiz-creative/~~",
  // 除外フォルダのパスを指定
  ignorePatterns: ['/~~']
}
```

### Lintエラーが表示されない or Prettierの自動フォーマットが効かない場合
以下お試し下さい。

- VS Codeを再起動して下さい。
- VS Codeのプラグイン【ESLint】をインストールして下さい。
- VS Codeのsettings.jsonで以下設定をfalseに変更して下さい。
```
"editor.formatOnSave": false  
"○○.format.enable": false  
```

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