@inventi/eslint-plugin-doc
v1.0.2
Published
Require readme for your project.
Downloads
226
Readme
@inventi/eslint-plugin-doc
Require readme for your project.
Installation
Assuming you already have ESLint installed, run:
# npm
npm install @inventi/eslint-plugin-doc --save-dev
# yarn
yarn add @inventi/eslint-plugin-doc --dev
Configuration
{
"plugins": [
// ...
"@inventi/doc"
],
"rules": {
// ...
'@inventi/doc/require-doc': [
'error',
{ directories: ['src/App'], ignore: '**/acl' },
],
}
}
License
MIT
Development
yarn remove @inventi/eslint-plugin-doc
yarn add --dev file:./src/@packages/eslintPluginDoc
Add plugin to eslint config - see section Custom Configuration above