forked from azat-io/eslint-plugin-perfectionist
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
77 additions
and
311 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# FAQ | ||
|
||
### What is `dont`? | ||
|
||
`dont` is an acronym. | ||
|
||
### What does it do? | ||
|
||
`eslint-plugin-dont` is a collection of state-of-the-art ESLint rules that will help you write better code. | ||
|
||
### How do I use it? | ||
|
||
Install it: | ||
|
||
```sh | ||
npm install --save-dev eslint eslint-plugin-dont | ||
``` | ||
|
||
Add it to your `.eslintrc` or `eslint.config.js`: | ||
|
||
::: code-group | ||
|
||
```json [.eslintrc] | ||
// .eslintrc | ||
{ | ||
"plugins": [ | ||
"dont" | ||
], | ||
"rules": { | ||
"dont/emoji": 2 | ||
} | ||
} | ||
``` | ||
|
||
```js [Flat config: eslint.config.js - recommended rules] | ||
// eslint.config.js | ||
import dont from 'eslint-plugin-dont' | ||
|
||
export default [ | ||
dont, | ||
] | ||
``` | ||
|
||
```js [Flat config: eslint.config.js - custom rules] | ||
// eslint.config.js | ||
import dont from 'eslint-plugin-dont' | ||
|
||
export default [ | ||
{ | ||
plugins: {dont}, | ||
rules: { | ||
'dont/emoji': 2, | ||
}, | ||
} | ||
] | ||
``` | ||
|
||
::: | ||
|
||
### Something is broken, what do I do? | ||
|
||
Ideally, just spend your time doing something interesting or useful. If you don't want to, you can open an issue or PR | ||
on [GitHub](https://github.com/lzear/eslint-plugin-dont). | ||
|
||
### Can I also suggest a rule? | ||
|
||
Sure. | ||
|
||
### Do you recommend using this in my projects or at my workplace? | ||
|
||
`dont` |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.