Skip to content
This repository has been archived by the owner on May 10, 2023. It is now read-only.

Latest commit

 

History

History
48 lines (33 loc) · 872 Bytes

README.md

File metadata and controls

48 lines (33 loc) · 872 Bytes

eslint-plugin-patterns

Eslint rules specifically for Patterns to help encourage best practice usage.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install @etchteam/eslint-plugin-patterns:

npm install @etchteam/eslint-plugin-patterns --save-dev

Usage

Add @etchteam/patterns to the plugins section of your .eslintrc configuration file:

{
    "plugins": [
        "'@etchteam/patterns'"
    ]
}

Then configure the rules you want to use under the rules section. Recommended config is below.

{
    "rules": {
        "@etchteam/patterns/dont-touch-src": "warn",
        "@etchteam/patterns/dont-add-classes-to-components": "warn"
    }
}

Supported Rules

  • @etchteam/patterns/dont-touch-src
  • @etchteam/patterns/dont-add-classes-to-components