https://github.com/stackbit/stylelint-config
Stackbit's shareable config for stylelint
https://github.com/stackbit/stylelint-config
config linting
Last synced: 4 months ago
JSON representation
Stackbit's shareable config for stylelint
- Host: GitHub
- URL: https://github.com/stackbit/stylelint-config
- Owner: stackbit
- License: mit
- Created: 2019-07-31T08:29:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-05T15:06:21.000Z (almost 6 years ago)
- Last Synced: 2025-02-21T05:04:11.864Z (5 months ago)
- Topics: config, linting
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@stackbit/stylelint-config
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# stylelint-config [](https://www.npmjs.com/package/@stackbit/stylelint-config)
Stackbit's [shareable config](https://stylelint.io/user-guide/configuration#extends) for [stylelint](https://stylelint.io/)
## Installation
Install stylelint and `@stackbit/stylelint-config`:
```
npm install --save-dev stylelint @stackbit/stylelint-config
```
### Prettier
`@stackbit/eslint-config` should be used in conjunction with [Prettier](https://prettier.io/). See the [`@stackbit/prettier-config` installation guide](https://github.com/stackbithq/prettier-config#installation) for more details.
## Usage
Stackbit's stylelint rules come bundled in `@stackbit/stylelint-config`. To enable these rules, add a `stylelint` property in your `package.json`. See the [stylelint configuration docs](https://stylelint.io/user-guide/configuration/) for more details.
```
"stylelint": {
"extends": ["@stackbit/stylelint-config"]
}
```
Now you can run stylelint by adding the following scripts to your `package.json`. See the [stylelint CLI docs](https://stylelint.io/user-guide/cli/) for more details.
```
"scripts": {
"lint:css": "stylelint '**/*.{css,scss}'",
"format:css": "npm run lint:css -- --fix"
}
```
Lint it:
```
npm run lint:css
```
Format it:
```
npm run format:css
```
## [CHANGELOG](CHANGELOG.md)
## [LICENSE](LICENSE)