jest-preset-stylelint

jest-preset-stylelint

Jest preset for stylelint plugins.

Installation

Install the preset alongside jest and stylelint:

npm install jest-preset-stylelint jest stylelint --save-dev

Setup

Add the preset to your jest.config.js or jest field in package.json:

{
  "preset": "jest-preset-stylelint"
}

Optionally, you can avoid specifying plugins in every schema by defining your own setup file to configure the testRule function. This is useful if you have many tests. There are two additional steps to do this:

1. Create jest.setup.js in the root of your project. Provide plugins option to getTestRule():

   const stylelint = require("stylelint");
   const getTestRule = require("jest-preset-stylelint/getTestRule");
   
   global.testRule = getTestRule(stylelint, { plugins: ["./"] });
   

2. Add jest.setup.js to your jest.config.js or jest field in package.json:

   {
     "preset": "jest-preset-stylelint",
     "setupFiles": ["jest.setup.js"]
   }
   

Usage

The preset exposes a global testRule function that you can use to efficiently test your plugin using a schema.

For example, we can test a plugin that enforces and autofixes kebab-case class selectors:

// my-plugin.test.js
const { messages, ruleName } = require(".");

testRule({
  plugins: ["."],
  ruleName,
  config: [true, { type: "kebab" }],
  fix: true,

  accept: [
    {
      code: ".class {}",
      description: "simple class selector"
    },
    {
      code: ".my-class {}",
      description: "kebab class selector"
    }
  ],

  reject: [
    {
      code: ".myClass {}",
      fixed: ".my-class {}",
      description: "camel case class selector",
      message: messages.expected(),
      line: 1,
      column: 1
    },
    {
      code: ".MyClass,\n.MyOtherClass {}",
      fixed: ".my-class,\n.my-other-class {}",
      description: "two pascal class selectors in a selector list",
      warnings: [
        {
          message: messages.expected(),
          line: 1,
          column: 1
        },
        {
          message: messages.expected(),
          line: 2,
          column: 1
        }
      ]
    }
  ]
});

Schema properties

accept [array<Object>]

Accept test cases.

config [array]

Config to pass to the rule.

fix [boolean]

Default: false (Optional).

Turn on autofix.

plugins [array<string>]

Maps to stylelint's plugins configuration property.

Path to the file that exports the plugin object, relative to the root. Usually it's the same path as a main property in plugin's package.json.

If you're testing a plugin pack, it's the path to the file that exports the array of plugin objects.

Optional, if plugins option was passed to advanced configuration with getTestRule().

reject [array<Object>]

Reject test cases.

ruleName [string]

Name of the rule being tested. Usually exported from the plugin.

skipBasicChecks [boolean]

Default: false (Optional).

Skip basic checks, e.g. an empty source.

syntax <string>

Maps to stylelint's syntax option.

Shared test case properties

Used within both accept and reject test cases.

code [string]

The code of the test case.

description [string]

Optional.

Description of the test case.

skip [boolean]

Default: false (Optional).

Maps to Jest's test.skip.

only [boolean]

Default: false (Optional).

Maps to Jest's test.only.

Reject test case properties

Use the warnings property, rather than message, line and column, if the test case is expected to produce more than one warning.

column [number]

Optional.

Expected column number of the warning.

fixed [string]

Optional if fix isn't true.

Expected fixed code of the test case.

line [number]

Optional.

Expected line number of the warning.

message [string]

Optional if warnings is used.

Expected message from the test case. Usually exported from the plugin.

unfixable [boolean]

Default: false (Optional).

Don't check the fixed code.

warnings [array<Object>]

Optional if message is used.

Warning Objects containing expected message, line and column.

Changelog

License

Changelog

2.0.0

• Removed: support for stylelint versions less than 13.
• Removed: support for node@8.
• Removed: settings not related to plugin testing.
• Changed: testRule signature to only accept schema as argument.
• Added: warnings to reject schema property.
• Added: plugins schema property.
• Added: only schema property.
• Added: skip schema property.
• Fixed: TypeError: stylelint is not a function.