stylelint-test-rule-node


A Stylelint rule tester using Node.js built-in test runner (node:test).

Installation

Install the tester package alongside Stylelint:

``shell
npm install stylelint-test-rule-node stylelint --save-dev
`

Usage

First, write a test file for rules you want to test. For example:

`js
// block-no-empty.test.js
import { testRule } from "stylelint-test-rule-node";

testRule({
ruleName: "block-no-empty",
config: true,

accept: [
{
code: "a { color: red }"
}
],

reject: [
{
code: "a {}",
message: "Unexpected empty block (block-no-empty)"
}
]
});
`

Then, run the test via node --test:

`sh-session
$ node --test block-no-empty.test.js
...
▶ block-no-empty (28.773291ms)

ℹ tests 2
ℹ suites 7
ℹ pass 2
ℹ fail 0
ℹ cancelled 0
ℹ skipped 0
ℹ todo 0
ℹ duration_ms 158.194084
`

See also the type definitions for more details.

$3

The testRule function enables you to efficiently test your plugin using a schema.

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

`js
// my-plugin.test.js
import { testRule } from "stylelint-test-rule-node";

import myPlugin from "./my-plugin.js";

const plugins = [myPlugin];
const {
ruleName,
rule: { messages }
} = myPlugin;

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,
endLine: 1,
endColumn: 8
},
{
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,
endLine: 1,
endColumn: 8
},
{
message: messages.expected(),
line: 2,
column: 1,
endLine: 2,
endColumn: 13
}
]
}
]
});
`

$3

The testRuleConfigs function enables you to test invalid configs for a rule.

For example:

`js
import { testRuleConfigs } from "stylelint-test-rule-node";

testRuleConfigs({
plugins,
ruleName,

accept: [
{
config: "valid"
}
],

reject: [
{
config: "invalid"
},
{
config: [/invalid/],
description: "regex is not allowed"
}
]
});
``

Changelog

License