eslint-config-shopify

This package provides Shopify's .eslintrc as an extensible shared config.

Usage

React

Install this module, as well as the other eslint modules on which it is dependent:

npm install --save-dev eslint babel-eslint eslint-plugin-react eslint-plugin-shopify # dependencies
npm install --save-dev eslint-config-shopify

then, extend the React version of this configuration in your own .eslintrc.json:

{
  "extends": "shopify/react"
}

ES2015 and Beyond Projects

Install this module, as well as the other eslint modules on which it is dependent:

npm install --save-dev eslint babel-eslint eslint-plugin-shopify # dependencies
npm install --save-dev eslint-config-shopify

then, extend the base version of this configuration in your own .eslintrc:

{
  "extends": "shopify"
}

ES5 Projects

Projects with a legacy codebase or that target a tool that targets node may continue to use ES5. To lint these projects, first install this module, as well as the other eslint modules on which it is dependent:

npm install --save-dev eslint eslint-plugin-shopify # dependencies
npm install --save-dev eslint-config-shopify

then, extend the ES5 version of this configuration in your own .eslintrc:

{
  "extends": "shopify/es5"
}