Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

eslint-plugin-clean-code

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-plugin-clean-code

Clean code ESLint plugin

  • 0.1.12
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
569
increased by29.02%
Maintainers
1
Weekly downloads
 
Created
Source

eslint-plugin-clean-code

Clean code ESLint plugin

Installation

You'll first need to install ESLint:

$ npm install --save-dev eslint 

Next, install eslint-plugin-clean-code:

$ npm install --save-dev eslint-plugin-clean-code

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-clean-code globally.

Usage

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

{
    "plugins": [
        "clean-code"
    ]
}

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

{
    "rules": {
        "clean-code/feature-envy": 2
    }
}

Supported Rules

| Rule name         | Description                                                                      |
--------------------------------------------------------------------------------------------------------
| feature-envy      | Reports the "Feature Envy" code smell. Feature envy is defined as occurring when |
|                   | a method calls methods on another class three or more times. Feature envy is     |
|                   | often an indication that functionality is located in the wrong class.            |

Todo

  • Allow end-user configuration of object name/class for which feature envy is not reported

  • Chain of 'instanceof' checks

    Reports any chains of if-else statements all of whose conditions are instanceof expressions or class equality
    expressions (e.g. comparison with String.class). Such constructions usually indicate a failure of object-oriented
    design, which dictates that such type-based dispatch should be done via polymorphic method calls rather than 
    explicit chains of type tests. 
    
  • 'if' statement with too many branches

    Reports if statements with too many branches. Such statements may be confusing, and are often the sign of 
    inadequate levels of design abstraction.
    
  • 'switch' statement outside of factory class/method

  • Method call violates Law of Demeter

  • Overly complex boolean expression

Contributing

Feel free to contribute to any of above Todos or supply your own clean code rule not given in Todos.

Keywords

FAQs

Package last updated on 23 Feb 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc