Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wikimedia/grunt-stylelint
Stylelint adapter for the Grunt task runner. Moved to Wikimedia GitLab.
https://github.com/wikimedia/grunt-stylelint
coding-standards grunt-plugins stylelint
Last synced: 3 months ago
JSON representation
Stylelint adapter for the Grunt task runner. Moved to Wikimedia GitLab.
- Host: GitHub
- URL: https://github.com/wikimedia/grunt-stylelint
- Owner: wikimedia
- License: mit
- Archived: true
- Created: 2016-05-17T12:50:34.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T14:27:37.000Z (8 months ago)
- Last Synced: 2024-06-18T14:08:07.654Z (7 months ago)
- Topics: coding-standards, grunt-plugins, stylelint
- Language: JavaScript
- Homepage: https://gitlab.wikimedia.org/repos/ci-tools/grunt-stylelint
- Size: 944 KB
- Stars: 28
- Watchers: 15
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://badge.fury.io/js/grunt-stylelint)
[](https://www.npmjs.org/package/grunt-stylelint)
# grunt-stylelint
Grunt plugin for running [stylelint](http://stylelint.io/)
## Getting started
If this is the first time you're using [Grunt](http://gruntjs.com/), the [getting started guide](http://gruntjs.com/getting-started) will show you how to get up and running.
Once you have that installed, with a [Gruntfile](http://gruntjs.com/sample-gruntfile) set for your code, you can install the plugin with:
npm install grunt-stylelint stylelint --save-dev
Note that this installs both grunt-stylelint and the stylelint tool itself, which is a peer dependency. If you do not explicitly depend on stylelint in your `package.json` file and do not have it available, grunt-stylelint will not work. Modern versions of npm will warn you of such unmet peer dependencies.
In your Gruntfile, add the line:
grunt.loadNpmTasks( 'grunt-stylelint' );
## Running and configuring `stylelint` task
_Run this task with the `grunt stylelint` command._
You can specify the targets and options for the task using the normal Grunt configuration – see Grunt's [guide on how to configure tasks](http://gruntjs.com/configuring-tasks) in general.
For more explanations of the lint errors stylelint will throw at you please visit http://stylelint.io/.
### Usage examples
#### Example simple config
In this example, running `grunt stylelint:all` (or `grunt stylelint` because `stylelint` is a [multi task](http://gruntjs.com/configuring-tasks#task-configuration-and-targets)) will lint the project's CSS and Sass files in the `css` and `sass` directories and their subdirectories, using the default stylelint options or the options specified in the `.stylelintrc` in the root of the project. For an example config see http://stylelint.io/user-guide/example-config/.
```js
// Project configuration.
grunt.initConfig({
stylelint: {
all: ['css/**/*.css', 'sass/**/*.scss']
}
});
```
#### Example full config
A full set of config with default options would be:
```js
// Project configuration.
grunt.initConfig( {
stylelint: {
options: {
configFile: '.stylelintrc',
formatter: 'string',
ignoreDisables: false,
failOnError: true,
outputFile: '',
reportNeedlessDisables: false,
fix: false,
syntax: ''
},
src: [
'src/**/*.{css,less,scss}',
…,
'!src/badstyles/*.css'
]
}
}
```
### Options
The `options` object is passed through to `stylelint`. Options you may wish to set are:
#### formatter
Type: `function` or `string`
Default value: `"string"`
Values: `"string"`|`"verbose"`|`"json"`
In which output format would you like results. If `grunt` is run with `--verbose` and this is not explicitly set, it will act as though you passed in `"verbose"`.
#### ignoreDisables
Type: `boolean`
Default value: `false`
Whether to ignore inline comments that disable stylelint.
#### outputFile
Type: `string`
Output the report to a file.
#### reportNeedlessDisables
Type: `boolean`
Default value: `false`
Whether to ignore inline comments that disable stylelint and report which ones did not block a lint warning.
#### failOnError
Type: `boolean`
Default value: `true`
Whether to fail if stylelint detects an error.
#### fix
Type: `boolean`
Default value: `false`
Automatically fix, where possible, violations reported by rules. If `grunt` is run with `--fix` and this is not explicitly set, it will be set to `true`.