space48/grumphp-stylelint-task

A GrumPHP extension that adds CSS linting support with stylelint.

1.0.1 2021-11-11 16:22 UTC

Requires

• phpro/grumphp: ~0.19 || ^1.3

MIT

README

Adds a stylelint linting task to GrumPHP.

Installation

Install through composer:

composer require --dev space48/grumphp-stylelint-task

Configuration

Example configuration:

# grumphp.yml
grumphp:
  tasks:
    stylelint:
      bin: "node_modules/.bin/stylelint"
      triggered_by: ["css", "scss"]
      allowed_paths: 
        - /^resources\/css/
      ignore_paths: 
        - /^ignored-folder\/css/
      max_warnings: 3
  extensions:
    - Space48\GrumPHPStylelintTask\Extension

Available options:

bin

Default: null

By default, the task will use stylelint from your $PATH. Use this option to override that. You can specify a path to the stylelint executable as a string, or a command to execute stylelint as an array, for example, to run stylelint through npx: bin: ["npx", "stylelint"]

triggered_by

Default: ["css", "less", "scss", "sass", "pcss"]

Define the list of file extensions that will trigger the stylelint task.

allowed_paths

Default: []

This option allows you to specify a list of regex patterns to filter the files that will be linted by the task.

config

Default: null

Specify an alternative configuration file for stylelint. If not specified, will let stylelint decide which configuration file will be used (stylelint.io).

disable_default_ignores

Default: false

Prevent stylelint from automatically ignoring files in certain directories, such as node_modules (stylelint.io).

format

Default: null

Specify the output format. Will use stylelint's default output format if not specified. You can find the list of valid options on stylelint.io.

max_warnings

Default: null

Specify the maximum number of warnings allowed before the linter will exit with an error (stylelint.io).

quiet

Default: false

Output only errors, not warnings (stylelint.io).

Changelog

See CHANGELOG.md.

License

This project is licensed unded the MIT License.