|
45 | 45 | * [Step 6: Make it public](https://github.com/postcss/postcss/blob/main/docs/writing-a-plugin.md#step-6-make-it-public) |
46 | 46 |
|
47 | 47 | **Guidlines** |
48 | | -* [PostCSS Plugin Guidelines](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#postcss-plugin-guidelines) |
49 | | - * [API](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#1-api) |
50 | | - * [1.1 Clear name with `postcss-` prefix](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#11-clear-name-with-postcss--prefix) |
51 | | - * [1.2. Do one thing, and do it well](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#12-do-one-thing-and-do-it-well) |
52 | | - * [1.3. Do not use mixins](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#13-do-not-use-mixins) |
53 | | - * [1.4. Keep `postcss` to `peerDependencies`](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#14-keep-postcss-to-peerdependencies) |
54 | | - * [1.5. Set `plugin.postcssPlugin` with plugin name](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#15-set-pluginpostcssplugin-with-plugin-name) |
55 | | - * [Processing](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#2-processing) |
56 | | - * [2.1. Plugin must be tested](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#21-plugin-must-be-tested) |
57 | | - * [2.2. Use asynchronous methods whenever possible](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#22-use-asynchronous-methods-whenever-possible) |
58 | | - * [2.3. Use fast node’s scanning](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#23-use-fast-nodes-scanning) |
59 | | - * [2.4. Set `node.source` for new nodes](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#24-set-nodesource-for-new-nodes) |
60 | | - * [2.5. Use only the public PostCSS API](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#25-use-only-the-public-postcss-api) |
61 | | - * [Dependencies](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#3-dependencies) |
62 | | - * [3.1. Use messages to specify dependencies](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#31-use-messages-to-specify-dependencies) |
63 | | - * [Errors](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#4-errors) |
64 | | - * [4.1. Use `node.error` on CSS relevant errors](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#41-use-nodeerror-on-css-relevant-errors) |
65 | | - * [4.2. Use `result.warn` for warnings](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#42-use-resultwarn-for-warnings) |
66 | | - * [Documentation](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#5-documentation) |
67 | | - * [5.1. Document your plugin in English](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#51-document-your-plugin-in-english) |
68 | | - * [5.2. Include input and output examples](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#52-include-input-and-output-examples) |
69 | | - * [5.3. Maintain a changelog](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#53-maintain-a-changelog) |
70 | | - * [5.4. Include `postcss-plugin` keyword in `package.json`](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/plugin.md#54-include-postcss-plugin-keyword-in-packagejson) |
| 48 | +* [PostCSS Plugin Guidelines](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#postcss-plugin-guidelines) |
| 49 | + * [API](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#1-api) |
| 50 | + * [1.1 Clear name with `postcss-` prefix](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#11-clear-name-with-postcss--prefix) |
| 51 | + * [1.2. Do one thing, and do it well](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#12-do-one-thing-and-do-it-well) |
| 52 | + * [1.3. Do not use mixins](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#13-do-not-use-mixins) |
| 53 | + * [1.4. Keep `postcss` to `peerDependencies`](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#14-keep-postcss-to-peerdependencies) |
| 54 | + * [1.5. Set `plugin.postcssPlugin` with plugin name](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#15-set-pluginpostcssplugin-with-plugin-name) |
| 55 | + * [Processing](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#2-processing) |
| 56 | + * [2.1. Plugin must be tested](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#21-plugin-must-be-tested) |
| 57 | + * [2.2. Use asynchronous methods whenever possible](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#22-use-asynchronous-methods-whenever-possible) |
| 58 | + * [2.3. Use fast node’s scanning](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#23-use-fast-nodes-scanning) |
| 59 | + * [2.4. Set `node.source` for new nodes](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#24-set-nodesource-for-new-nodes) |
| 60 | + * [2.5. Use only the public PostCSS API](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#25-use-only-the-public-postcss-api) |
| 61 | + * [Dependencies](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#3-dependencies) |
| 62 | + * [3.1. Use messages to specify dependencies](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#31-use-messages-to-specify-dependencies) |
| 63 | + * [Errors](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#4-errors) |
| 64 | + * [4.1. Use `node.error` on CSS relevant errors](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#41-use-nodeerror-on-css-relevant-errors) |
| 65 | + * [4.2. Use `result.warn` for warnings](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#42-use-resultwarn-for-warnings) |
| 66 | + * [Documentation](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#5-documentation) |
| 67 | + * [5.1. Document your plugin in English](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#51-document-your-plugin-in-english) |
| 68 | + * [5.2. Include input and output examples](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#52-include-input-and-output-examples) |
| 69 | + * [5.3. Maintain a changelog](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#53-maintain-a-changelog) |
| 70 | + * [5.4. Include `postcss-plugin` keyword in `package.json`](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md#54-include-postcss-plugin-keyword-in-packagejson) |
71 | 71 |
|
72 | | -* [PostCSS Runner Guidelines](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#postcss-runner-guidelines) |
73 | | - * [API](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#1-api) |
74 | | - * [1.1. Accept functions in plugin parameters](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#11-accept-functions-in-plugin-parameters) |
75 | | - * [Processing](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#21-set-from-and-to-processing-options) |
76 | | - * [2.1. Set `from` and `to` processing options](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#21-set-from-and-to-processing-options) |
77 | | - * [2.2. Use only the asynchronous API](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#22-use-only-the-asynchronous-api) |
78 | | - * [2.3. Use only the public PostCSS API](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#23-use-only-the-public-postcss-api) |
79 | | - * [3.1. Rebuild when dependencies change](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#31-rebuild-when-dependencies-change) |
80 | | - * [Output](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#4-output) |
81 | | - * [4.1. Don’t show JS stack for `CssSyntaxError`](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#41-dont-show-js-stack-for-csssyntaxerror) |
82 | | - * [4.2. Display `result.warnings()`](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#42-display-resultwarnings) |
83 | | - * [4.3. Allow the user to write source maps to different files](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#43-allow-the-user-to-write-source-maps-to-different-files) |
84 | | - * [Documentation](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#5-documentation) |
85 | | - * [5.1. Document your runner in English](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#51-document-your-runner-in-english) |
86 | | - * [5.2. Maintain a changelog](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#52-maintain-a-changelog) |
87 | | - * [5.3. `postcss-runner` keyword in `package.json`](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#53-postcss-runner-keyword-in-packagejson) |
88 | | - * [5.4. Keep postcss to peerDependencies](https://github.com/postcss/postcss/blob/docs-index/docs/guidelines/runner.md#54-keep-postcss-to-peerdependencies) |
| 72 | +* [PostCSS Runner Guidelines](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#postcss-runner-guidelines) |
| 73 | + * [API](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#1-api) |
| 74 | + * [1.1. Accept functions in plugin parameters](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#11-accept-functions-in-plugin-parameters) |
| 75 | + * [Processing](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#21-set-from-and-to-processing-options) |
| 76 | + * [2.1. Set `from` and `to` processing options](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#21-set-from-and-to-processing-options) |
| 77 | + * [2.2. Use only the asynchronous API](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#22-use-only-the-asynchronous-api) |
| 78 | + * [2.3. Use only the public PostCSS API](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#23-use-only-the-public-postcss-api) |
| 79 | + * [3.1. Rebuild when dependencies change](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#31-rebuild-when-dependencies-change) |
| 80 | + * [Output](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#4-output) |
| 81 | + * [4.1. Don’t show JS stack for `CssSyntaxError`](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#41-dont-show-js-stack-for-csssyntaxerror) |
| 82 | + * [4.2. Display `result.warnings()`](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#42-display-resultwarnings) |
| 83 | + * [4.3. Allow the user to write source maps to different files](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#43-allow-the-user-to-write-source-maps-to-different-files) |
| 84 | + * [Documentation](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#5-documentation) |
| 85 | + * [5.1. Document your runner in English](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#51-document-your-runner-in-english) |
| 86 | + * [5.2. Maintain a changelog](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#52-maintain-a-changelog) |
| 87 | + * [5.3. `postcss-runner` keyword in `package.json`](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#53-postcss-runner-keyword-in-packagejson) |
| 88 | + * [5.4. Keep postcss to peerDependencies](https://github.com/postcss/postcss/blob/main/docs/guidelines/runner.md#54-keep-postcss-to-peerdependencies) |
0 commit comments