How to use the lint function from stylelint

Find comprehensive JavaScript stylelint.lint code examples handpicked from public code repositorys.

stylelint.lint is a function that takes CSS code as input and returns a promise that resolves to an object representing the linting results.

run.js

GitHub: commercetools/merchant-center-application-kit

5
6
7
8
9
10
11
12
13
14
15
16


const createLinter = (testPath) => {
  return (options) => {
    const start = new Date();


    return stylelint.lint(options).then((data) => {
      if (data.errored) {
        return fail({
          start,
          end: new Date(),

ruleTester.js

GitHub: swissquote/crafty

41
42
43
44
45
46
47
48
49
50
      config: stylelintConfig,
      customSyntax: schema.customSyntax,
      codeFilename: schema.codeFilename
    };

    const output = await lint(stylelintOptions);
    t.deepEqual(output.results[0].warnings, []);
    t.deepEqual(output.results[0].parseErrors, []);
  }
});

+ 31 other calls in file

How does stylelint.lint work?

stylelint.lint is a function provided by the Stylelint library that analyzes a given CSS or SCSS code, applies a set of specified rules to it, and returns a report of any errors or warnings that violate those rules. When the stylelint.lint function is called, it takes in an object of options that specify the configuration, plugins, and rules to apply to the given code. Then, it runs the code through the Stylelint engine and returns an object that contains an array of the errors and warnings detected during the analysis. The returned object also includes other metadata, such as the number of files analyzed, the number of warnings and errors detected, and any fixable violations that can be automatically corrected by Stylelint.

cli.js

GitHub: unhaggle/frontend-lint

170
171
172
173
174
175
176
177
178
179
      };
    } else {
      throw e;
    }
  }
  const fileResults = await stylelint.lint(options);
  results.push(...fileResults.results);
}

// Output results.

Ai Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const stylelint = require("stylelint");

// Example CSS code to lint
const cssCode = `
.example {
color: red;
}
.example {
background-color: blue;
}
`;

// Options for the linter
const options = {
  config: {
    // Configuration for the linter, such as rules to follow
    // This can be a path to a configuration file or an object
  },
  files: ["path/to/file.css"], // Optional, an array of file paths to lint
  code: cssCode, // Optional, the CSS code to lint as a string
};

// Lint the CSS code
stylelint
  .lint(options)
  .then((result) => {
    console.log(result);
  })
  .catch((error) => {
    console.error(error);
  });

This example uses stylelint.lint to lint some CSS code using a given configuration. The options object is passed to stylelint.lint, which can include a path to a configuration file, an array of file paths to lint, or the CSS code to lint as a string. The then method is used to log the linting result to the console, and the catch method is used to log any errors that occur.

Other functions in stylelint

Sorted by popularity

stylelint.utils is the most popular function in stylelint (206 examples)

Other popular packages:

Home

About