How to use the createPlugin function from stylelint

stylelint.createPlugin is a function that creates a stylelint plugin with custom linting rules.

How does stylelint.createPlugin work?

stylelint.createPlugin is a method in the stylelint library that allows developers to create custom plugins to extend the functionality of the linter by defining rules and their associated logic. It takes an object as an argument that specifies the name, rule definition, and configuration options for the plugin, and returns an object with methods to load the plugin and handle its execution. When executed, the plugin performs the specified rule validation on CSS files and reports any errors or warnings.

Ai Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
const { createPlugin } = require("stylelint");

const ruleName = "my-rule";
const ruleMessage = "This is my custom rule.";

const myRulePlugin = createPlugin(ruleName, (input, _, context) => {
  return (root, result) => {
    root.walkRules((rule) => {
      if (rule.selector === ".my-class") {
        context.report({
          message: ruleMessage,
          node: rule,
          result,
          ruleName,
        });
      }
    });
  };
});

module.exports = myRulePlugin;

This example creates a custom stylelint rule called "my-rule" that reports an error message if any rules in the stylesheet contain the selector .my-class. The plugin is created using the stylelint.createPlugin function, which takes the name of the rule and a function that returns a stylelint rule function. The rule function is passed a root object representing the root node of the CSS abstract syntax tree, a result object representing the stylelint result, and a context object containing utility functions for reporting errors and warnings. In this example, the context.report() function is used to report an error message with the specified rule name and message when the rule selector matches .my-class.