Giter VIP home page Giter VIP logo

eslint-plugin-srp-hints's Introduction

eslint-plugin-srp-hints

NPM version

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

eslint-plugin-srp-hints's People

Contributors

eliasm307 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.