@dareharu/eslint-config
Dareharu projects.
Shareable ESLint configuration forStrongly inspired by @sapphiredev/eslint-config.
Table of Contents
🚀 Installation
Note In the following example commands we use
npm install
to fit best suited to the basic environment, feel free to replacenpm 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
- Fork it!
- Create your feature branch:
git switch -c my-new-feature
- Commit your changes:
git commit -am 'Add awesome feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request!
License
Released under the MIT License.