https://github.com/brightspace/eslint-config-brightspace

Common Brightspace eslint configs.
https://github.com/brightspace/eslint-config-brightspace

Last synced: 5 days ago
JSON representation

Common Brightspace eslint configs.

• Host: GitHub
• URL: https://github.com/brightspace/eslint-config-brightspace
• Owner: Brightspace
• License: apache-2.0
• Created: 2015-09-29T19:43:57.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T12:44:29.000Z (9 days ago)
• Last Synced: 2024-11-06T13:49:13.252Z (9 days ago)
• Language: JavaScript
• Homepage:
• Size: 443 KB
• Stars: 1
• Watchers: 52
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# eslint-config-brightspace

[![NPM version](https://img.shields.io/npm/v/eslint-config-brightspace.svg)](https://npmjs.org/package/eslint-config-brightspace-url)

Common Brightspace eslint configs.

## Installation

```shell

npm install eslint-config-brightspace

```

## Usage

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

```json

{

  "extends": "brightspace/"

}

```

### Environment Specific Configs

| Environment | Description |

|--|--|

| `browser-config` | use with code that runs in a browser |

| `lit-config` | use with [Lit](https://lit.dev/) projects |

| `testing-config` | use with [@brightspace-ui/testing](https://github.com/BrightspaceUI/testing) test code |

| `node-config` | use with [Node.js](https://nodejs.org) projects |

| `react-config` | use with [React](https://react.dev/) projects |

Example:

```json

{

  "extends": "brightspace/lit-config"

}

```

See the [eslint rules](https://eslint.org/docs/latest/rules/) for more details on rule configuration.  See the [eslint shareable configs](https://eslint.org/docs/latest/extend/shareable-configs.html) 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](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.