eslint-config-brightspace

eslint-config-brightspace

Common Brightspace eslint configs.

Installation

npm install eslint-config-brightspace

Usage

Simply specify the extends property in the .eslintrc file as shown below. Note: omit the "eslint-config" when specifying the module, since eslint assumes it.

Default Config

Specify the extends property in the .eslintrc.json file:

{
  "extends": "brightspace"
}

Environment Specific Configs

Specify the desired config for the extends property:

• browser-config : sets up browser globals
• lit-config : sets up env for browser globals and lit rules for lit elements
• node-config : sets up node globals including es6 env features
• react-config : sets up env for jsx and es6, including globals for jest
• open-wc-testing-config : sets up env for @open-wc/testing
• polymer-config : sets up env for browser globals and polymer web components
• polymer-3-config : sets up env for browser globals and polymer web components for polymer 3
• wct-config : sets up env for web component tester tests
• wct-polymer-3-config : sets up env for web component tester tests for polymer 3

{
  "extends": "brightspace/react-config"
}

To use react-config, consumers should install the eslint-plugin-react plugin to enable use of the rules it provides.

To use polymer-config, consumers should install the eslint-plugin-html plugin to extract and lint JavaScript contained in .html web component files. eslint-plugin-sort-class-members plugin is required to ensure consistency in class format

To use lit-config, consumers should install the eslint-plugin-html, eslint-plugin-sort-class-members, and eslint-plugin-lit plugins.

See the eslint rules for more details on rule configuration. See the eslint shareable configs for more details on creating configs.

Contributing

Contributions are welcome, please submit a pull request!

Code Style

This repository is configured with EditorConfig rules and contributions should make use of them.