Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fuhlig/stylelint-config-copilot
Shareable stylelint config for standard and plugin rules. Highly opinionated.
https://github.com/fuhlig/stylelint-config-copilot
code-conventions linter-config scss stylelint stylelint-config
Last synced: 3 months ago
JSON representation
Shareable stylelint config for standard and plugin rules. Highly opinionated.
- Host: GitHub
- URL: https://github.com/fuhlig/stylelint-config-copilot
- Owner: fuhlig
- License: mit
- Created: 2019-05-18T16:57:18.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T05:05:11.000Z (3 months ago)
- Last Synced: 2024-10-10T09:31:36.916Z (3 months ago)
- Topics: code-conventions, linter-config, scss, stylelint, stylelint-config
- Language: JavaScript
- Homepage:
- Size: 4.1 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stylelint-config-copilot [](https://circleci.com/gh/fuhlig/stylelint-config-copilot/tree/main) [](https://lerna.js.org/)
> A copilot that helps you navigating through authoring styleesheets. Highly opinionated stylelint configurations.
⚠ Current Status: ⚠
_This project is very much work-in-progress. Right now it's about testing out different rules, combinations and plugins_
Collection of shareable configurations for [Stylelint](https://stylelint.io/) and [Stylelint plugins](https://stylelint.io/user-guide/plugins).
The configs are separated into dedicated packages:
- [base](/packages/stylelint-config-copilot-base): Stylelint's built-in rules
- [scss](/packages/stylelint-config-copilot-scss): Sass (scss syntax) specific rules
- [plugins](/packages/stylelint-config-copilot-plugins): rules from various Stylelint plugins
- [order](/packages/stylelint-config-copilot-order) - order specific rules
- [stylistic](/packages/stylelint-config-copilot-stylistic) - stylistic rules in plugin form (previously built-in Stylelint rules)
Usage information are in the packages' documentations.
## Usage
See the [official documentation on configuration](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/configuration.md).
Example configuration to extend copilot-configs.
```js
module.exports = {
extends: [
'stylelint-config-copilot-',
],
// enter files to ignore (e.g. dependencies, libs, styleguide styles)
ignoreFiles: [
'**/node_modules/**',
],
// define severity level
defaultSeverity: 'warning',
// custom-rules & overwrites
rules: {
},
};
```
The `defaultSeverity` is set to `warning`. Some rules are set to `error`.
Warnings are considered violations to coding guidelines while errors (may) cause defective code.
While only errors exit with an exit code, using a _zero tolerance policy_ is recommended by setting `--max-warnings 0` (`--mw 0`) in combination with a [Git-Hook](https://git-scm.com/docs/githooks). To simplify the setup of hooks, consider using [husky](https://github.com/typicode/husky).
Linting your stylesheets automated via CLI or during build is great, but linting warnings & errors as soon as they happen is the most effective. Consider using [editor plugins](https://stylelint.io/user-guide/complementary-tools/#editor-plugins) to get short feedback loops.
Using a linter for the first time or changed the config and it all turns into colorful warnings and errors? Don't worry - this is quite normal. Your code (and you) have to get used to the rules. Start small and adjust your code over time.
If you do not agree with a rule - change or disable it. When there are exceptions and the linter should be bypassed, [disable them selectively within the stylesheet](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/configuration.md#turning-rules-off-from-within-your-css).
Using the [formatter](https://stylelint.io/user-guide/node-api#formatter), a report can be generated to go through the potential violations step-by-step.
### Development
#### Setup
```bash
npm install
```
#### Test
Test will run `ESLint` and find potentially unused Stylelint rules in the base config
```bash
npm test
```