Work in progress...
✔: Enabled in the recommended configuration.
🔧: Fixable with eslint --fix.
| ✔ | 🔧 | Rule | Description |
|---|---|---|---|
| ✔ | 🔧 | avensia/require-comment-for-hook-ignore | Prevent ignoring exhaustive-deps or rules-of-hooks without describing why |
See eslint documentation for more information about working with ESLint rules.
An important note about contributing right now is that there is a problem in the markdown-magic package which is currently at 2.6.0. It has a dependency called @technote-space/doctoc that completely removed the possiblity to use require() and instead wants import(). The package has not been properly updated yet, so if you want to run the npm run generate-list-of-rules command, you have to open node_modules\markdown-magic\lib\transforms\toc.js and change:
// this
const { transform } = require('@technote-space/doctoc')
// to this
const { transform } = import('@technote-space/doctoc')And you should now be able to properly update README.md with your new rules. Once markdown-magic pins a non-broken version of @technote-space/doctoc things should work great again. So ^2.6.1 hopefully. (See versions here: https://www.npmjs.com/package/markdown-magic?activeTab=versions)
avensia-eslint is licensed under the MIT License.