generator-eslint-shopify

generator-eslint-shopify

A Yeoman generator for creating a Shopify-focused ESLint config.

Installation

First, install Yeoman and generator-esnext-test using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-eslint-shopify

Then generate your ESLint configuration:

yo eslint-shopify

What You Get

The following is installed by this generator (test/.eslintrc is only installed when the needsTest option/ prompt is true, and the test directory can be configured with the testDir option/ prompt):

|-- .eslintrc
|-- .eslintignore
|-- test/
  |-- .eslintrc

The generator prompts will take you through setting up your config, including what environments you are working in and what directories/ rules to ignore. The package.json file is created if it does not exist, and the scripts property is augmented with a lint command.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.