stylelint-junit-formatter

Output JUnit XML reports of stylelint results

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
stylelint-junit-formatter
0.2.24 years ago7 years agoMinified + gzip package size for stylelint-junit-formatter in KB

Readme

stylelint-junit-formatter
Build Status
Output JUnit XML reports of stylelint results (that can be parsed by CircleCI or Bamboo).

Usage

With CircleCI

Before:
image
After:
image
Install stylelint-junit-formatter (and stylelint and optionally, a config)
$ npm install stylelint-junit-formatter stylelint stylelint-config-standard --save-dev

Add a .stylelintrc, e.g.:
{
  "extends": "stylelint-config-standard",
  "ignoreFiles": "node_modules/**/*",
}

Add a .circleci/config.yml that runs stylelint and saves the results, e.g.:
version: 2
jobs:
  build:
    docker:
      - image: circleci/node:10

    steps:
      - checkout
      # Download and cache dependencies
      - restore_cache:
          keys:
            - v1-dependencies-{{ checksum "package-lock.json" }}
            - v1-dependencies-

      - run:
          name: Build
          command: if [ ! -d "node_modules" ]; then npm ci; fi

      - save_cache:
          paths:
            - node_modules
          key: v1-dependencies-{{ checksum "package-lock.json" }}

      - run:
          name: Lint
          command: |
            mkdir -p reports/stylelint
            npm run lint -s -- --custom-formatter 'node_modules/stylelint-junit-formatter' > reports/stylelint/test-results.xml

      - store_test_results:
          path: reports

With Bamboo

TODO (PRs welcome!)

With the Stylelint Node API:

const fs = require('fs');
const stylelint = require('stylelint');
const junitFormatter = require('stylelint-junit-formatter');

const stylelintOptions = {
  files: '**/*.css',
  formatter: junitFormatter,
};

stylelint.lint(stylelintOptions)
  .then((resultObject) => {
    // Do something with the result, e.g. write a report.xml to disk:
    // fs.writeFile('report.xml', resultObject.output, (error) => {…});
  });

…or read the stylelint documentation about using formatters and follow those instructions.
The formatter will generate a .xml-report with the following look:
<?xml version="1.0" encoding="utf-8"?>
<testsuites package="stylelint.rules">
  <testsuite name="path/to/css/file1.css" failures="0" errors="0" tests="1">
    <testcase name="stylelint.passed"/>
  </testsuite>
  <testsuite name="path/to/css/file2.css" failures="0" errors="0" tests="1">
    <testcase name="stylelint.passed"/>
  </testsuite>
  <testsuite name="path/to/css/file3.css" failures="0" errors="0" tests="1">
    <testcase name="stylelint.passed"/>
  </testsuite>
  <testsuite name="path/to/css/file4.css" failures="0" errors="0" tests="1">
    <testcase name="stylelint.passed"/>
  </testsuite>
</testsuites>

In the event of errors, those are presented in a way that CircleCI/Bamboo can interpret:
<?xml version="1.0" encoding="utf-8"?>
<testsuites package="stylelint.rules">
  <testsuite name="path/to/css/file.css" failures="0" errors="0" tests="1">
    <testcase name="stylelint.passed"/>
  </testsuite>
  <testsuite name="/path/to/css/file.css" failures="2" errors="2" tests="2">
    <testcase name="declaration-block-properties-order">
      <failure type="error"
               message="Expected "color" to come before "font-weight" (declaration-block-properties-order)">
       On line 7, column 3 in /path/to/css/file.css
      </failure>
    </testcase>
    <testcase name="shorthand-property-no-redundant-values">
      <failure type="error"
               message="Unexpected longhand value '0 2rem 1.5rem 2rem' instead of '0 2rem 1.5rem' (shorthand-property-no-redundant-values)">
       On line 8, column 3 in /path/to/css/file.css
      </failure>
    </testcase>
  </testsuite>
  <testsuite name="path/to/css/file.css" failures="0" errors="0" tests="1">
    <testcase name="stylelint.passed"/>
  </testsuite>
</testsuites>