stylelint-formatter-utils

Helpful utilities for building custom stylelint formatters.

Install

npm install stylelint-formatter-utils

Usage

The stylelint-formatter-utils module has the following exports:

Table

This is a class for outputting tabular data:

const {Table} = require('stylelint-formatter-utils')
const table = new Table({
  delimiter: ',',
  columns: ['source', 'line']
})
console.log(table.format([
  {source: 'x.css', line: 10},
  {source: 'y.css', line: 5}
])
// outputs:
// source,line
// x.css,10
// y.css,5

Want to generate a Markdown table? Get it from the markdown exports.

getHeadRef()

Get the git head ref, which is useful for generating links to source code.

const {getHeadRef} = require('stylelint-formatter-utils')
const {repository} = require('./package.json')
const head = getHeadRef()
console.log(`browse this ref: https://github.com/${repository}/tree/${ref}`)

getRepoURL()

Get the repo URL from the git origin remote.

const {getRepoURL} = require('stylelint-formatter-utils')
console.log(`check out this repo: ${getRepoURL()}`)

stripCwd(path[, cwd])

Strip the current working directory from the lefthand side of the input path. If cwd is not provided or empty, we get it from process.cwd().

const {stripCwd} = require('stylelint-formatter-utils')
console.log(`this file is: ${stripCwd(__filename)}`)

Markdown

You can get a couple of Markdown-specific helpers from the stylelint-formatter-utils/markdown endpoint:

MarkdownTable

const {MarkdownTable, link} = require('stylelint-formatter-utils/markdown')
const table = new MarkdownTable({
  columns: [
    {title: 'rule', format: ({rule}) => {
      return link(rule, `https://stylelint.io/user-guide/rules/${rule}`)
    }},
    {title: 'path', format: ({source, line}) => {
      return link(`${source}@${line}`, `https://github.com/my/repo/blob/master/${source}#L${line}`)
    }}
  ]
})

markdown.link(text, url)

Returns a Markdown link in the format [text](url).

markdown.code(text)

Returns the string wrapped in backticks.