Commit 40157412 authored by Manuel Munz's avatar Manuel Munz

update readme, changelog, license and package.json

parent d798e144
Pipeline #22157 failed with stage
in 9 seconds
# 0.1.0
- Initial release
- Initial release based on stylelint-config-standard. Add stylelint-scss plugin and a set of custom rules.
The MIT License (MIT)
Copyright (c) 2016 stylelint
Copyright (c) 2019 TEAM23
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
......
......@@ -2,8 +2,70 @@
> Standard SCSS config for TEAM23
Extends [`stylelint-config-team23-standard`](https://git.team23.de/mmunz/stylelint-config-team23-standard).
Rules for linting SCSS at TEAM23 with stylelint.
Extends [`stylelint-config-team23-standard`](https://git.team23.de/mmunz/stylelint-config-team23-standard), which
enables error checking and a lot of stylistic rules based on best practices.
Used plugins:
-[`stylelint-scss`](https://github.com/kristerkari/stylelint-scss).
- [`stylelint-scss`](https://github.com/kristerkari/stylelint-scss).
## Proposing rule changes
For proposing changes to the ruleset please open either
- a merge request
- a ticket
## Installation
```bash
npm install git+https://git.team23.de/mmunz/stylelint-config-team23-scss.git --save-dev
```
## Usage
If you've installed `stylelint-config-team23-scss` locally within your project, just set your `stylelint` config to:
```json
{
"extends": "stylelint-config-team23-scss"
}
```
If you've globally installed `stylelint-config-team23-scss` using the `-g` flag, then you'll need to use the absolute path to `stylelint-config-team23-scss` in your config e.g.
```json
{
"extends": "/absolute/path/to/stylelint-config-team23-scss"
}
```
Since [stylelint 9.7.0](https://github.com/stylelint/stylelint/blob/9.7.0/CHANGELOG.md#970), you can simply use the globally installed configuration name instead of the absolute path:
```json
{
"extends": "stylelint-config-team23-scss"
}
```
### Extending the config
Simply add a `"rules"` key to your config, then add your overrides and additions there.
For example, to change the `at-rule-no-unknown` rule to use its `ignoreAtRules` option, change the `indentation` to tabs, turn off the `number-leading-zero` rule,and add the `unit-whitelist` rule:
```json
{
"extends": "stylelint-config-team23-scss",
"rules": {
"scss/at-extend-no-missing-placeholder": true,
# ...
}
}
```
## [Changelog](CHANGELOG.md)
## [License](LICENSE)
......@@ -8,11 +8,11 @@
"scss",
"team23"
],
"author": "stylelint",
"author": "TEAM23",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/stylelint/stylelint-config-standard.git"
"url": "https://git.team23.de/mmunz/stylelint-config-team23-scss"
},
"main": "index.js",
"files": [
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment