eslint-plugin-shopify

eslint-plugin-shopify

Shopify-specific ESLint rules.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-shopify:

$ npm install eslint-plugin-shopify --save-dev

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

Usage

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

{
  "plugins": [
    "shopify"
  ]
}

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

{
  "rules": {
    "shopify/require-flow": 2
  }
}

Supported Rules

• require-flow: Requires (or disallows) @flow declarations be present at the top of each file.
• binary-assignment-parens: Requires (or disallows) assignments of binary, boolean-producing expressions to be wrapped in parentheses.

Contributing

The easiest way to add new rules is to use the ESLint Yeoman generator. Running yo eslint:rule from the root of this project should add the required main file, docs, and test for your new rules. Make sure that these are all filled out and consistent with the other rules before merging. All tests (including linting) can be run using npm test.