Output Checkstyle XML reports of stylelint results, which might be handy if you use the Jenkins Checkstyle Plugin, so you can have graphs and be professional.

There are now two ways to use this package:

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.

For more information, read the stylelint documentation about using formatters and follow those instructions.

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.

This project has initial been written by David Clark under the name stylelint-checkstyle-formatter.