# grunt-stylelint-reporter

> stylelint htmlreporter

Latest version **2.0.0** (published 2016-04-07) · 0 weekly downloads

## Install

```sh
npm install grunt-stylelint-reporter
pnpm add grunt-stylelint-reporter
yarn add grunt-stylelint-reporter
bun add grunt-stylelint-reporter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2016-04-07 |
| First published | 2015-12-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.12.7 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | 35n139e |
| Maintainers | 35n139e |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-stylelint-reporter
- Repository: https://github.com/35n139e/grunt-stylelint-reporter
- Issues: https://github.com/35n139e/grunt-stylelint-reporter/issues
- npm.io page: https://npm.io/package/grunt-stylelint-reporter

## Dependencies (1)

- [ejs](https://npm.io/package/ejs.md) ^2.4.1

## Recent versions

- 2.0.0 (latest) — 2016-04-07
- 0.1.9 — 2016-01-07
- 0.1.8 — 2016-01-06
- 0.1.7 — 2016-01-06
- 0.1.6 — 2016-01-06
- 0.1.5 — 2015-12-21
- 0.1.4 — 2015-12-17
- 0.1.2 — 2015-12-17
- 0.1.1 — 2015-12-17
- 0.1.0 — 2015-12-11

## README

# grunt-stylelint-reporter
[![Build Status](https://travis-ci.org/35n139e/grunt-stylelint-reporter.svg?branch=master)](https://travis-ci.org/35n139e/grunt-stylelint-reporter)

## Getting Started

```
stylelint rules changed "color-no-named" to "color-named" etc.
[stylelint rules](http://github.com/stylelint/stylelint/tree/master/src/rules)
```

This plugin requires Grunt `~1.0.0`


If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-stylelint-reporter --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-stylelint-reporter');
```

## The "reporter" task

### Overview
In your project's Gruntfile, add a section named `reporter` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
	reporter: {
		options: {
			temp: 'test/template.ejs',
			files: 'test/test.css',
			syntax: 'css',
			configFile: 'test/stylelintConfig',
			ports: 5963,
			outputJson:{
				flag:true,
				path:'test/test.json'
			}
		}
	}
});
```

### Options

#### options.temp
Type: `String`
Default value: `null`

ejs template file

#### options.files
Type: `String`
Default value: `null`

lint target files

#### options.syntax
Type: `String`
Default value: `'css'`

if lint target scss , `'scss'`

#### options.configFile
Type: `String`
Default value: `null`

If nothing is set , you will see the `.stylelintrc` that are placed directly under the root.
If in case you want to put the config in any directory , please specify a file path from the root as Overview.
(At this time, the extension of the file should be in `.json`, or `.js`, Please do extension is not included in the `configFile`.)

#### options.ports
Type: `Num`
Default value: `5963`
ports

#### options.outputJson

##### options.outputJson.flag
Type: `boolean`
Default value: `false`
if you want json output file,  `true` this.

##### options.outputJson.path
Type: `String`
Default value: `null`
json output file path

## Release History
* 2016-01-06 v2.0.0 grunt 1.0.0, stylelint 5.3.0, ejs2.4.1 updates.
* 2016-01-06 v0.1.9 stylelint update.
* 2016-01-06 v0.1.7 Dependencies hotfix.
* 2016-01-06 v0.1.6 ejs template modifired and "stylelint-config-suitcss" deleted.
* 2015-12-21 v0.1.5 A configuration file it has to be specified in any directory.
* 2015-12-17 v0.1.4 package.json bugfix.
* 2015-12-17 v0.1.3 package.json dependencies modifired.
* 2015-12-17 v0.1.2 package.json bugfix.
* 2015-12-17 v0.1.1 Initial release.

---
_Source: https://npm.io/package/grunt-stylelint-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._