To help you get started, we've collected the most common ways that stylelint is being used within popular public projects.

kristerkari / stylelint-scss / src / rules / at-function-pattern / index.js View on Github

root.walkAtRules(decl => {
      if (decl.name !== "function") {
        return;
      }

      // Stripping the function of its arguments
      const funcName = decl.params.replace(/(\s*?)\((?:\s|\S)*\)/g, "");

      if (regexpPattern.test(funcName)) {
        return;
      }

      utils.report({
        message: messages.expected,
        node: decl,
        result,
        ruleName
      });
    });
  };

View more ways to use stylelint

Stylelint

A mighty CSS linter that helps you avoid errors and enforce conventions.

Features

It's mighty as it:

• has over 100 built-in rules for modern CSS syntax and features
• supports plugins so you can create your own custom rules
• automatically fixes problems where possible
• supports shareable configs that you can create or extend
• can be customized to your exact needs
• has 15k unit tests making it robust
• is trusted by companies worldwide like Google and GitHub

And it can be extended to:

• extract embedded styles from HTML, Markdown and CSS-in-JS template literals
• parse CSS-like languages like SCSS, Sass, Less and SugarSS

How it'll help you

It'll help you avoid errors, for example:

• invalid things, e.g. malformed grid areas
• valid things that are problematic, e.g. duplicate selectors
• unknown things, e.g. misspelled property names

And enforce conventions, for example:

• disallow things, e.g. specific units
• enforce naming patterns, e.g. for custom properties
• set limits, e.g. the number of ID selectors
• specify notations, e.g. for modern color functions

We recommend using a pretty printer like Prettier alongside Stylelint. Linters and pretty printers are complementary tools that work together to help you write consistent and error-free code.

Example output

Guides

• User guide
  • Getting started
  • Customizing
  • Configuring
  • Rules
  • Ignoring code
  • CLI
  • Node.js API
  • PostCSS plugin
  • Options
  • Errors & warnings
• Developer guide
  • Writing rules
  • Writing plugins
  • Writing custom syntaxes
  • Writing custom formatters
  • Writing system tests
• Migration guide
  • Migrating to 16.0.0
  • Migrating to 15.0.0
  • Migrating to 14.0.0
• Maintainer guide
  • Managing issues
  • Managing pull requests
  • Performing releases
• About
  • Vision
  • Semantic versioning

Contributors

Stylelint is maintained by volunteers. Without the code contributions from all these fantastic people, Stylelint would not exist. Become a contributor.

Alumni

We'd like to thank all past members for their invaluable contributions, including two of Stylelint's co-creators @davidtheclark and @MoOx.

Sponsors

Thank you to all our sponsors! Become a sponsor.

Backers

Thank you to all our backers! Become a backer.

Website hosting

License

The MIT License.