README.md

@woltapp/stylelint-plugin-browserbug

Lint rules for documenting, and eventually removing, browser bug workarounds.

Usage

You'll first need to install Stylelint:

npm i stylelint --save-dev

Step 1: Installation

npm i @woltapp/stylelint-plugin-browserbug --save-dev

Step 2: Configuration

Add browserbug to the plugins section of your stylelint configuration file.

{
  "plugins": ["@woltapp/stylelint-plugin-browserbug"],
  "rules": {
    "@woltapp/browserbug-comment-no-outdated": true
  }
}

Note: for the rules to practically work, you must also specify a browserslist config. Any of the supported browserslist methods would work, for example a browserslist entry in package.json.

Step 3: Usage in code

The plugin works via code comments.

Comments are prefixed as @browserbug, and include a list of descriptors. Descriptors can be comma separated. A comment can follow the list of descriptors, starting with --.

/* The no-outdated rule will report an error if the specified range is no longer supported. */
/* @browserbug safari lower-than-or-equal 15.4 -- Some comment here */
/* @browserbug safari lte 15.4 */
/* @browserbug safari lower-than 16.0 */
/* @browserbug safari lt 16.0 */
/* @browserbug chrome equal 117 */
/* @browserbug chrome between 117 120 -- Inclusive range */

/* These descriptors are equivalent to 'equal' and 'between' for the purposes of no-outdated. Additionally, the last-checked-updated rule will report an error if there is a newer version of the specified versions available. */
/* @browserbug chrome last-checked 121 */
/* @browserbug chrome last-checked-between 117 121 -- Same as last-checked, but documents when a workaround started */

Rules

💼 Configurations enabled in.
✅ Set in the recommended configuration.

Name	Description	💼
no-outdated	Ensures that no browserbug comment exists, if browserslist support for that browser is outside the specified range.	✅