eslint-config-brightspace

eslint-config-brightspace

Common Brightspace eslint configs.

Installation

npm install eslint-config-brightspace

Usage

Set the extends property in the .eslintrc.json file, replacing <environment> with the desired environment-specific config.

{
  "extends": "brightspace/<environment>"
}

Environment Specific Configs

Environment	Description
browser-config	use with code that runs in a browser
lit-config	use with Lit projects
testing-config	use with @brightspace-ui/testing test code
node-config	use with Node.js projects
react-config	use with React projects

Example:

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

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

Developing and Contributing

After cloning the repo, run npm install to install dependencies.

Versioning and Releasing

This repo is configured to use semantic-release. Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to main.

To learn how to create major releases and release from maintenance branches, refer to the semantic-release GitHub Action documentation.