https://github.com/brightspaceui/stylelint-config
Common Brightspace stylelint configs.
https://github.com/brightspaceui/stylelint-config
Last synced: 4 months ago
JSON representation
Common Brightspace stylelint configs.
- Host: GitHub
- URL: https://github.com/brightspaceui/stylelint-config
- Owner: BrightspaceUI
- License: apache-2.0
- Created: 2020-07-06T17:23:27.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-26T13:17:16.000Z (12 months ago)
- Last Synced: 2025-07-06T14:05:43.902Z (11 months ago)
- Language: JavaScript
- Size: 445 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# stylelint-config
[](https://www.npmjs.org/package/@brightspace-ui/stylelint-config)
[](https://www.npmjs.com/package/@brightspace-ui/stylelint-config)
Common Brightspace [stylelint](https://stylelint.io/) configs.
## Installation
Install the `stylelint-config` and `stylelint`.
```shell
npm i @brightspace-ui/stylelint-config
npm i stylelint
```
## Usage
Simply specify the `extends` property in the `.stylelintrc.json` file as shown below. The default config contains rules to avoid errors, and also to enforce consistent formatting.
```json
{
"extends": "@brightspace-ui/stylelint-config"
}
```
Then run `stylelint`, for example by defining a script in your `package.json`.
```json
"scripts": {
"lint:style": "stylelint \"**/*.js\""
},
```
## Contributing
Contributions are welcome, please submit a pull request!
### Code Style
This repository is configured with [EditorConfig](http://editorconfig.org) rules and contributions should make use of them.
### 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.