eslint-plugin-srp-hints v0.0.0

eslint-plugin-srp-hints

ESLint plugin to offer hints for whether there might be an issue regarding the Single Responsibility Princible of SOLID software development

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-srp-hints:

npm install eslint-plugin-srp-hints --save-dev

Usage with Recommended Configuration

To use the recommended configuration for this plugin, add plugin:srp-hints/recommended to the extends array in the eslintrc file, ie:

{
  extends: [ 'plugin:srp-hints/recommended' ],
}

More details for the recommended configuration can be found here.

Usage with Custom Rules

Add srp-hints to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["srp-hints"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "srp-hints/function-description": 10
  }
}

Supported Rules

• function-description