eslint-config-sunrun v1.0.0

eslint-config-sunrun

This is the sunrun eslint common configuration for multiple Node development environments.

Installation

$ npm install @sunrun/eslint-config-sunrun

or

$ yarn add @sunrun/eslint-config-sunrun

Usage

This eslint config plugin provides two specific environments:

• cloud-common (default)
• frontend

and two extensions for cloud specific providets:

• gcp-extension
• aws-extension

To use this plugin install module as noted above and then edit the .eslintrc.json file in the root of your project to look like below.

{
  "extends": "@sunrun/eslint-config-sunrun",
  "rules": {
  }
}

This will include the cloud-common definitions. Note: Any addtional rules that appear in the rules section will override the base settings.

You can also specify the exact envionment as follows:

{
  "extends": "@sunrun/eslint-config-sunrun/frontend",
  "rules": {
  }
}

or add a specific cloud extensions as follows:

{
  "extends": [
    "@sunrun/eslint-config-sunrun",
    "@sunrun/eslint-config-sunrun/gcp-extension"
    // "@sunrun/eslint-config-sunrun/aws-extension"
  ],
  "rules": {
  }
}