|
| 1 | +# @trigen/stylelint-config |
| 2 | + |
| 3 | +[![NPM version][npm]][npm-url] |
| 4 | +[![Node version][node]][node-url] |
| 5 | +[![Peer dependencies status][peer-deps]][peer-deps-url] |
| 6 | +[![Dependencies status][deps]][deps-url] |
| 7 | +[![Build status][build]][build-url] |
| 8 | +[![Dependabot badge][dependabot]][dependabot-url] |
| 9 | + |
| 10 | +[npm]: https://img.shields.io/npm/v/%40trigen/stylelint-config.svg |
| 11 | +[npm-url]: https://npmjs.com/package/@trigen/stylelint-config |
| 12 | + |
| 13 | +[node]: https://img.shields.io/node/v/%40trigen/stylelint-config.svg |
| 14 | +[node-url]: https://nodejs.org |
| 15 | + |
| 16 | +[peer-deps]: https://david-dm.org/TrigenSoftware/scripts/peer-status.svg?path=packages/stylelint-config |
| 17 | +[peer-deps-url]: https://david-dm.org/TrigenSoftware/scripts?type=peer&path=packages/stylelint-config |
| 18 | + |
| 19 | +[deps]: https://david-dm.org/TrigenSoftware/scripts.svg?path=packages/stylelint-config |
| 20 | +[deps-url]: https://david-dm.org/TrigenSoftware/scripts?path=packages/stylelint-config |
| 21 | + |
| 22 | +[build]: https://img.shields.io/github/actions/workflow/status/TrigenSoftware/scripts/ci.yml?branch=main |
| 23 | +[build-url]: https://github.com/TrigenSoftware/scripts/actions |
| 24 | + |
| 25 | +[dependabot]: https://api.dependabot.com/badges/status?host=github&repo=TrigenSoftware/scripts |
| 26 | +[dependabot-url]: https://dependabot.com/ |
| 27 | + |
| 28 | +Trigen's Stylelint config |
| 29 | + |
| 30 | +## Install |
| 31 | + |
| 32 | +```bash |
| 33 | +npm i -D @trigen/stylelint-config |
| 34 | +#or |
| 35 | +yarn add -D @trigen/stylelint-config |
| 36 | +``` |
| 37 | + |
| 38 | +## Configure |
| 39 | + |
| 40 | +Create `.stylelintrc` with next content: |
| 41 | + |
| 42 | +```json |
| 43 | +{ |
| 44 | + "extends": "@trigen/stylelint-config" |
| 45 | +} |
| 46 | +``` |
| 47 | + |
| 48 | +### Other configs |
| 49 | + |
| 50 | +There are other configs for different syntax: |
| 51 | + |
| 52 | +| Config | Description | |
| 53 | +|--------|-------------| |
| 54 | +| @trigen/stylelint-config/css | Rules for CSS code. | |
| 55 | +| @trigen/stylelint-config/scss | Rules for SCSS code. | |
| 56 | +| @trigen/stylelint-config/stylable | Rules for Stylable code. | |
| 57 | + |
| 58 | +Example: |
| 59 | + |
| 60 | +```json |
| 61 | +{ |
| 62 | + "extends": [ |
| 63 | + "@trigen/stylelint-config" |
| 64 | + "@trigen/stylelint-config/scss" |
| 65 | + ] |
| 66 | +} |
| 67 | +``` |
0 commit comments