AwesomeHamster / eslint-config

Common ESLint configuration used in Hamster

eslint-config

Common ESLint configuration used in Hamster

Install

npm i --save-dev eslint @hamster-bot/eslint-config
# Or use yarn
yarn add --dev eslint @hamster-bot/eslint-config

---

If you are using TypeScript as well, you need to install typescript-eslint plugin and eslint-import-resolver-typescript.

npm i --save-dev @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript
# Or use yarn
yarn add --dev @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript

Usage

Create an eslint configuration file like .eslintrc.json and append the following:

{
  "extends": [
    "@hamster-bot"
  ]
}

---

TypeScript user should use @hamster-bot/eslint-config/typescript:

{
  "extends": [
    "@hamster-bot/eslint-config/typescript"
  ]
}

License

This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.