@shopify/eslint-plugin

What is @shopify/eslint-plugin?

@shopify/eslint-plugin is an ESLint plugin designed to enforce Shopify's JavaScript and TypeScript coding standards. It provides a set of rules and configurations that help maintain code quality and consistency across projects.

What are @shopify/eslint-plugin's main functionalities?

Enforcing Shopify's JavaScript Style Guide

This configuration extends Shopify's ESLint rules for ESNext and Node.js environments. It also includes specific rules like `@shopify/prefer-early-return` to enforce early return patterns and `@shopify/no-ancestor-directory-import` to prevent importing from ancestor directories.

module.exports = {
  extends: [
    'plugin:@shopify/esnext',
    'plugin:@shopify/node'
  ],
  rules: {
    '@shopify/prefer-early-return': 'error',
    '@shopify/no-ancestor-directory-import': 'error'
  }
};

TypeScript Support

This configuration extends Shopify's ESLint rules for TypeScript. It includes rules like `@shopify/typescript/prefer-pascal-case-enums` to enforce PascalCase for TypeScript enums.

module.exports = {
  extends: [
    'plugin:@shopify/typescript'
  ],
  rules: {
    '@shopify/typescript/prefer-pascal-case-enums': 'error'
  }
};

React Support

This configuration extends Shopify's ESLint rules for React. It includes rules like `@shopify/jsx-no-hardcoded-content` to prevent hardcoded content in JSX.

module.exports = {
  extends: [
    'plugin:@shopify/react'
  ],
  rules: {
    '@shopify/jsx-no-hardcoded-content': 'error'
  }
};

Other packages similar to @shopify/eslint-plugin

eslint-plugin-airbnb

eslint-plugin-airbnb provides a set of ESLint rules based on Airbnb's JavaScript style guide. It is widely used and offers comprehensive rules for JavaScript and React, similar to @shopify/eslint-plugin but with a different style guide.

eslint-plugin-standard

eslint-plugin-standard enforces JavaScript Standard Style. It is simpler and less opinionated compared to @shopify/eslint-plugin, making it a good choice for projects that prefer a minimalistic approach.

eslint-plugin-prettier

eslint-plugin-prettier integrates Prettier with ESLint, allowing code formatting rules to be enforced as ESLint rules. While it focuses on formatting rather than code quality, it can be used alongside @shopify/eslint-plugin for a comprehensive setup.

README

@shopify/eslint-plugin

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 @shopify/eslint-plugin:

With Yarn

yarn add --dev @shopify/eslint-plugin

With npm

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

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

Usage

As of version 46.0.0, this package uses Eslint's "Flat Config" format, not the legacy "eslintrc" format. To upgrade your Eslint configuration, follow the Configuration Migration Guide.

---

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

import shopifyEslintPlugin from '@shopify/eslint-plugin';

export default [...shopifyEslintPlugin.configs.esnext];

If you are working on an ES5 project, use the ES5 version of the configuration:

import shopifyEslintPlugin from '@shopify/eslint-plugin';

export default [...shopifyEslintPlugin.configs.es5];

You can also add some "augmenting" configs on top of the "core" config by using an array of linting configs. For example, the following configuration would provide a base ESNext config that is augmented by a React config:

import shopifyEslintPlugin from '@shopify/eslint-plugin';

export default [
  ...shopifyEslintPlugin.configs.esnext,
  ...shopifyEslintPlugin.configs.react,
];

Likewise, if you are using TypeScript and React, the following configuration uses the TypeScript base config with the React-specific rules provided by the React configuration file. To demonstrate multiple augmentations, we've also added the Prettier config, which disables rules that will conflict in projects using prettier.

import shopifyEslintPlugin from '@shopify/eslint-plugin';

export default [
  ...shopifyEslintPlugin.configs.typescript,
  ...shopifyEslintPlugin.configs.react,
  ...shopifyEslintPlugin.configs.prettier,
];

Provided configurations

This plugin provides the following core configurations:

• esnext: Use this for anything written with ES2015+ features.
• typescript: Use this for Typescript projects. The rules enabled in this config do not require type-checking to run. To enable all Typescript rules, you must augment this config with the typescript-type-checking config mentioned below.
• 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:

• typescript-type-checking Use this config to augment the typescript config to enable all TypeScript rules, including those that require type checking. These rules are slower to run and and you will need to specify a path to your tsconfig.json file in the "project" property of "parserOptions". The following example would provide all of the TypeScript rules, assuming the tsconfig.json is in the same directory as you ESlint configuration.

import shopifyEslintPlugin from '@shopify/eslint-plugin';

export default [
  ...shopifyEslintPlugin.configs.typescript,
  ...shopifyEslintPlugin.configs['typescript-type-checking'],
  {
    languageOptions: {
      parserOptions: {
        project: 'tsconfig.json',
      },
    },
  },
];

• react: Use this for React projects.
• polaris: Use this for projects that use Shopify’s React Polaris components.
• prettier: Use prettier for consistent formatting. Using 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 @shopify/eslint-plugin 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:

import shopifyEslintPlugin from '@shopify/eslint-plugin';

export default [
  ...shopifyEslintPlugin.configs.esnext,
  ...shopifyEslintPlugin.configs.node,
];

Supported Typescript version

The supported version of TypeScript is constrained by the @typescipt-eslint parser support that is installed.

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.
• 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-namespace-imports: Prevent namespace import declarations.
• no-useless-computed-properties: Prevent the usage of unnecessary computed properties.
• polaris-no-bare-stack-item: Disallow the use of Polaris’s Stack.Item and LegacyStack.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.
• typescript/prefer-build-client-schema: Prefer buildClientSchema for schema building.
• webpack/no-unnamed-dynamic-imports: Require that all dynamic imports contain a webpackChunkName comment.

Suggested additional configs

For applications that use graphql we recommend using the operations-recommended preset from @graphql-eslint/eslint-plugin. This is not included as part of this plugin because graphql has a large install footprint and not everybody needs it.