https://github.com/xt0rted/stylelint-actions-formatters

Stylelint formatters that work with GitHub Actions problem matchers
https://github.com/xt0rted/stylelint-actions-formatters

github-actions stylelint stylelint-formatter

Last synced: 22 days ago
JSON representation

Stylelint formatters that work with GitHub Actions problem matchers

• Host: GitHub
• URL: https://github.com/xt0rted/stylelint-actions-formatters
• Owner: xt0rted
• License: mit
• Created: 2019-11-18T05:04:35.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-19T00:10:59.000Z (4 months ago)
• Last Synced: 2024-10-24T04:46:28.700Z (26 days ago)
• Topics: github-actions, stylelint, stylelint-formatter
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/stylelint-actions-formatters
• Size: 832 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stylelint-actions-formatters

[![CI](https://github.com/xt0rted/stylelint-actions-formatters/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/xt0rted/stylelint-actions-formatters/actions/workflows/ci.yml)

[![CodeQL](https://github.com/xt0rted/stylelint-actions-formatters/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/xt0rted/stylelint-actions-formatters/actions/workflows/codeql-analysis.yml)

[![npm version](https://img.shields.io/npm/v/stylelint-actions-formatters)](https://www.npmjs.com/package/stylelint-actions-formatters)

These are copies of the built-in [Stylelint](https://github.com/stylelint/stylelint) formatters with modified file paths so that `Checks Annotations` can be created on `GitHub Actions` when your `package.json` is not in the root of the repository.

This package should be used with the [stylelint-problem-matcher](https://github.com/xt0rted/stylelint-problem-matcher) action.

To help with compatibility the version of this package matches the version of StyleLint that the formatters came from.

It also has a peer dependency on that version.

## Usage

### String formatter

```console

 stylelint "scss/**/*.scss" --custom-formatter=stylelint-actions-formatters

```

### Verbose formatter

```console

 stylelint "scss/**/*.scss" --custom-formatter=stylelint-actions-formatters/src/verboseFormatter.mjs

```

> Note: If you're not running on GitHub Actions then these reporters will function the same as the ones that ship with Stylelint.