eslint-plugin-shopify

eslint-plugin-shopify

Shopify’s ESLint rules and configs.

Installation

You'll first need to install ESLint:

With Yarn

yarn add --dev eslint

With npm

$ npm i eslint --save-dev

Next, install eslint-plugin-shopify:

With Yarn

yarn add --dev eslint-plugin-shopify

With npm

$ 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

Shopify’s ESLint configs come bundled in this package. In order to use them, you simply extend the relevant configuration in your project’s .eslintrc. For example, the following will extend the ESNext (ES2015 and later) config:

{
  "extends": "plugin:shopify/esnext"
}

If using React, extend the React version of the configuration (which adds some React-specific rules to those in the ESNext config):

{
  "extends": "plugin:shopify/react"
}

If working on an ES5 project, extend the ES5 version of the configuration:

{
  "extends": "plugin:shopify/es5"
}

You can also add some "augmenting" configs on top of the "core" config by extending an array of linting configs. For example, this package provides a jest config, which can be added to the ESNext config with the following configuration file:

{
  "extends": [
    "plugin:shopify/esnext",
    "plugin:shopify/jest",
  ]
}

Provided configurations

This plugin provides the following core configurations:

• esnext: Use this for anything written with ES2015+ features.
• react: Use this for React projects.
• es5: Use this for legacy projects.

This plugin also provides the following tool-specific configurations, which can be used on top of the core configurations:

• graphql: Use this for projects that use graphql-config for graphql validation.
• polaris: Use this for projects that use Shopify’s React Polaris components.
• prettier: Use prettier for consistent formatting. Extending this Shopify's prettier config will override the default Shopify eslint rules in favor of prettier formatting. Prettier must be installed within your project, as eslint-plugin-shopify does not provide the dependency itself.
• typescript-prettier: Use prettier on typescript projects. Prettier must be installed within your project, as eslint-plugin-shopify does not provide the dependency itself.
• webpack: Use this for projects built by webpack.

node

If you are working on a node module, we also provide the node configuration for you. Note that this configuration needs to be used in conjunction with one of the core configurations (either es5 or esnext). If you plan to transpile your code using Babel, use the esnext config. If you do not plan to do so, the config you choose depends on the version of node you wish to support, and how many ESNext features are natively available in that version. You can see a detailed list of what version of node supports what new JavaScript features by visiting http://node.green.

A node project that will use Babel for transpilation would need the following ESLint config:

{
  "extends": [
    "plugin:shopify/esnext",
    "plugin:shopify/node"
  ]
}

Plugin-Provided Rules

This plugin provides the following custom rules, which are included as appropriate in all core linting configs:

• binary-assignment-parens: Require (or disallow) assignments of binary, boolean-producing expressions to be wrapped in parentheses.
• class-property-semi: Require (or disallow) semicolons for class properties.
• images-no-direct-imports: Prevent images from being directly imported.
• jest/no-snapshots: Disallows jest snapshots.
• jest/no-try-expect: Prevent catch assertions in tests.
• jest/no-vague-titles: Prevent the usage of vague words in test statements.
• jsx-no-complex-expressions: Disallow complex expressions embedded in in JSX.
• jsx-no-hardcoded-content: Disallow hardcoded content in JSX.
• jsx-prefer-fragment-wrappers: Disallow useless wrapping elements in favour of fragment shorthand in JSX.
• no-useless-computed-properties: Prevent the usage of unnecessary computed properties.
• polaris-no-bare-stack-item: Disallow the use of Polaris’s Stack.Item without any custom props.
• polaris-prefer-sectioned-prop: Prefer the use of the sectioned props in Polaris components instead of wrapping all contents in a Section component.
• prefer-class-properties: Prefer class properties to assignment of literals in constructors.
• prefer-early-return: Prefer early returns over full-body conditional wrapping in function declarations.
• no-ancestor-directory-import: Prefer imports from within a directory extend to the file from where they are importing without relying on an index file.
• prefer-module-scope-constants: Prefer that screaming snake case variables always be defined using const, and always appear at module scope.
• prefer-twine: Prefer Twine over Bindings as the name for twine imports.
• react-hooks-strict-return: Restrict the number of returned items from React hooks.
• react-initialize-state: Require that React component state be initialized when it has a non-empty type.
• react-no-multiple-render-methods: Disallow multiple render methods in React component classes.
• react-prefer-private-members: Prefer all non-React-specific members be marked private in React class components.
• react-type-state: Require that React component state be typed in TypeScript.
• restrict-full-import: Prevent importing the entirety of a package.
• sinon-no-restricted-features: Restrict the use of specified sinon features.
• sinon-prefer-meaningful-assertions: Require the use of meaningful sinon assertions through sinon.assert or sinon-chai.
• strict-component-boundaries: Prevent module imports between components.
• typescript/prefer-pascal-case-enums: Prefer TypeScript enums be defined using Pascal case.
• typescript/prefer-singular-enums: Prefer TypeScript enums be singular.
• webpack/no-unnamed-dynamic-imports: Require that all dynamic imports contain a webpackChunkName comment.

Creating New Rules

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 can be run using npm test.