stylelint-checkstyle-reporter/README.md

Output Checkstyle XML reports of stylelint results

# stylelint-checkstyle-reporter

[![Build Status](https://travis-ci.org/lucavb/stylelint-checkstyle-reporter.svg?branch=master)](https://travis-ci.org/lucavb/stylelint-checkstyle-reporter)

Output [Checkstyle](http://checkstyle.sourceforge.net/) XML reports of stylelint results,
which might be handy if you use the Jenkins [Checkstyle Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Checkstyle+Plugin), so you can have graphs and be professional.

## Usage

There are now two ways to use this package:

### Through --custom-formatter

You will want to run this command

`stylelint "**/*.css" --custom-formatter node_modules/stylelint-checkstyle-reporter/dist/stylelint-checkstyle-reporter.mjs -o stylelint.xml >/dev/null 2>&1`

The pipe to `/dev/null` is optional but spares you the XML output on your console.

You can also use this project in a JavaScript file of yours to customise the output. An example can be found
[here](examples/prettyprint.cjs).

For more information, read the [stylelint](https://github.com/stylelint/stylelint) documentation about using formatters
and follow those instructions.

### Through Bash pipes

The alternative would be to use a bash pipe

`stylelint -f json "**/*.css" 2>&1 | npx stylelint-checkstyle-reporter > stylelint-result.xml`

The benefit would be the somewhat shorter syntax compared to the first approach.

## Credit

This project has initial been written by [David Clark](https://github.com/davidtheclark)
under the name [stylelint-checkstyle-formatter](https://github.com/davidtheclark/stylelint-checkstyle-formatter).