Sha256: 555df5426ddfcd5d73fec183876bfb1636c23c73a7193245a7fce5a198690068
Contents?: true
Size: 1.09 KB
Versions: 23
Compression:
Stored size: 1.09 KB
Contents
# Writing processors
Processors are functions that hook into stylelint's pipeline, modifying code on its way into stylelint and modifying results on their way out.
**Their use is discouraged favor of [PostCSS syntaxes](../about/syntaxes.md).**
Processor modules are functions that accept an options object and return an object with the following the functions, which hook into the processing of each file:
- **code**: A function that accepts two arguments, the file's code and the file's path, and returns a string for stylelint to lint.
- **result**: A function that accepts two arguments, the file's stylelint result object and the file's path, and either mutates the result object (returning nothing) or returns a new one.
```js
// my-processor.js
module.exports = function (options) {
return {
code: function (input, filepath) {
// ...
return transformedCode;
},
result: function (stylelintResult, filepath) {
// ...
return transformedResult;
}
};
};
```
_Processor options must be JSON-friendly_ because users will need to include them in `.stylelintrc` files.
Version data entries
23 entries across 23 versions & 1 rubygems