@dareharu/eslint-config

Shareable ESLint configuration for Dareharu projects.

Strongly inspired by @sapphiredev/eslint-config.

---

Table of Contents

• Installation
• Usage
• Meta
  • Contributing
  • License

🚀 Installation

Note In the following example commands we use npm install to fit best suited to the basic environment, feel free to replace npm install with your package manager of choice (yarn, pnpm or whatever).

First install the Peer Dependencies.

npm install --save-dev eslint typescript @typescript-eslint/{parser,eslint-plugin}

Then install the Optional Dependencies (Optional).

npm install --save-dev eslint-plugin-import

Finally install @dareharu/eslint-config.

npm install --save-dev @dareharu/eslint-config

🌟 Usage

Add the ESLint config to your package.json:

{
  "eslintConfig": {
    "extends": "@dareharu"
  }
}

Or to eslintrc.js / .eslintrc.json:

module.exports = require('@dareharu/eslint-config')

{
  "extends": "@dareharu"
}

Create tsconfig.eslint.json next to the eslint config file, for example with content:

{
  "extends": "./tsconfig.json",
  "include": ["src", "tests"]
}

🔗 Meta

Contributing

1. Fork it!
2. Create your feature branch: git switch -c my-new-feature
3. Commit your changes: git commit -am 'Add awesome feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request!

License

Released under the MIT License.