Jest preset for stylelint plugins.
Install the preset alongside jest and stylelint:
npm install jest-preset-stylelint jest stylelint --save-dev
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:
-
Create
jest.setup.js
in the root of your project. Provideplugins
option togetTestRule()
:const getTestRule = require("jest-preset-stylelint/getTestRule"); global.testRule = getTestRule({ plugins: ["./"] });
-
Add
jest.setup.js
to yourjest.config.js
orjest
field inpackage.json
:{ "preset": "jest-preset-stylelint", "setupFiles": ["jest.setup.js"] }
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
}
]
}
]
});
Accept test cases.
Config to pass to the rule.
Default: false
(Optional).
Turn on autofix.
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 test cases.
Name of the rule being tested. Usually exported from the plugin.
Default: false
(Optional).
Skip basic checks, e.g. an empty source.
Maps to stylelint's syntax
option.
Used within both accept
and reject
test cases.
The code of the test case.
Optional.
Description of the test case.
Default: false
(Optional).
Maps to Jest's test.skip.
Default: false
(Optional).
Maps to Jest's test.only.
Use the warnings
property, rather than message
, line
and column
, if the test case is expected to produce more than one warning.
Optional.
Expected column number of the warning.
Optional if fix
isn't true
.
Expected fixed code of the test case.
Optional.
Expected line number of the warning.
Optional if warnings
is used.
Expected message from the test case. Usually exported from the plugin.
Default: false
(Optional).
Don't check the fixed
code.
Optional if message
is used.
Warning Objects containing expected message
, line
and column
.