eslint-plugin-stylelint-2 1.0.9

package/docs/rules/sort-stylelint-plugins.md

@@ -0,0 +1,61 @@
+# sort-stylelint-plugins
+
+Enforce sorted entries in top-level Stylelint `plugins` declarations.
+
+## Targeted pattern scope
+
+This rule targets Stylelint config modules such as `stylelint.config.ts`, `stylelint.config.mjs`, and `.stylelintrc.js`.
+
+It focuses on top-level exported config objects, including configs wrapped in `defineConfig(...)`.
+
+## What this rule reports
+
+Reports `plugins` arrays whose string entries are not in ascending lexical order.
+
+## Why this rule exists
+
+Sorted plugin arrays create deterministic diffs and improve scanability of shared config.
+
+## ❌ Incorrect
+
+```ts
+export default {
+    plugins: ["stylelint-order", "stylelint-a11y"],
+    rules: {},
+};
+```
+
+## ✅ Correct
+
+```ts
+export default {
+    plugins: ["stylelint-a11y", "stylelint-order"],
+    rules: {},
+};
+```
+
+## Behavior and migration notes
+
+This rule auto-fixes by sorting `plugins` entries lexically.
+
+## ESLint flat config example
+
+```ts
+import stylelint2 from "eslint-plugin-stylelint-2";
+
+export default [stylelint2.configs.configuration];
+```
+
+## When not to use it
+
+Do not use this rule if your repository intentionally uses non-lexical plugin ordering conventions.
+
+## Package documentation
+
+Stylelint package documentation:
+
+> **Rule catalog ID:** R026
+
+## Further reading
+
+- [Stylelint plugins](https://stylelint.io/user-guide/configure/#plugins)

package/docs/rules/sort-stylelint-rule-keys.md

@@ -0,0 +1,65 @@
+# sort-stylelint-rule-keys
+
+Enforce sorted top-level Stylelint `rules` keys in shared config files.
+
+## Targeted pattern scope
+
+This rule targets Stylelint config modules such as `stylelint.config.ts`, `stylelint.config.mjs`, and `.stylelintrc.js`.
+
+It focuses on top-level exported config objects, including configs wrapped in `defineConfig(...)`.
+
+## What this rule reports
+
+Reports `rules` objects whose keys are not in ascending lexical order.
+
+## Why this rule exists
+
+Stable key ordering reduces diff noise and makes large shared rulesets easier to scan and review.
+
+## ❌ Incorrect
+
+```ts
+export default {
+    rules: {
+        "color-named": "never",
+        "at-rule-no-unknown": true,
+    },
+};
+```
+
+## ✅ Correct
+
+```ts
+export default {
+    rules: {
+        "at-rule-no-unknown": true,
+        "color-named": "never",
+    },
+};
+```
+
+## Behavior and migration notes
+
+This rule auto-fixes when sorting can be done safely (for example, no nearby comments attached to rule entries).
+
+## ESLint flat config example
+
+```ts
+import stylelint2 from "eslint-plugin-stylelint-2";
+
+export default [stylelint2.configs.configuration];
+```
+
+## When not to use it
+
+Do not use this rule if your team intentionally uses non-lexical grouping for rule keys.
+
+## Package documentation
+
+Stylelint package documentation:
+
+> **Rule catalog ID:** R031
+
+## Further reading
+
+- [Stylelint rules](https://stylelint.io/user-guide/rules/list)

package/docs/rules/stylelint.md

@@ -0,0 +1,100 @@
+# stylelint
+
+Run Stylelint against CSS files from ESLint and surface Stylelint autofixes through ESLint's fixer pipeline.
+
+## Targeted pattern scope
+
+This rule targets complete CSS files linted through ESLint's `css/css` language support.
+
+It does not look for one AST pattern inside a stylesheet. Instead, it forwards the whole file to Stylelint and converts Stylelint's findings into ESLint reports.
+
+## What this rule reports
+
+This rule reports:
+
+- Stylelint rule violations for the current stylesheet
+- Stylelint parse errors for the current stylesheet
+- Stylelint invalid option warnings and deprecation warnings
+
+When Stylelint provides computed edit info for a warning, this rule exposes that edit as an ESLint autofix.
+
+## Why this rule exists
+
+Projects often want ESLint to be the single command that editors, pre-commit hooks, and CI jobs run.
+
+Without a bridge rule, stylesheet linting usually lives in a separate Stylelint command with a separate reporting flow. That split increases setup overhead and makes autofix workflows less consistent.
+
+## ❌ Incorrect
+
+```css
+.button {
+    color: #ffffff;
+}
+```
+
+If the active Stylelint config prefers short hex colors, this stylesheet is reported through ESLint.
+
+## ✅ Correct
+
+```css
+.button {
+    color: #fff;
+}
+```
+
+## Behavior and migration notes
+
+- This rule uses Stylelint's Node API under the hood.
+- The rule is only as strict as the Stylelint config it resolves for the current file.
+- If your Stylelint config provides computed edit info, `eslint --fix` can apply the corresponding change.
+- Non-fixable Stylelint warnings are still reported.
+- You can set `ignoreDisables: true` when you want Stylelint disable comments to be ignored for a specific ESLint run.
+
+## Additional examples
+
+### ✅ Correct — explicit Stylelint config file
+
+```ts
+import stylelint2 from "eslint-plugin-stylelint-2";
+
+export default [
+    {
+        ...stylelint2.configs.stylelintOnly,
+        rules: {
+            "stylelint-2/stylelint": [
+                "error",
+                {
+                    configFile: "./stylelint.config.mjs",
+                    ignoreDisables: true,
+                },
+            ],
+        },
+    },
+];
+```
+
+## ESLint flat config example
+
+```ts
+import stylelint2 from "eslint-plugin-stylelint-2";
+
+export default [
+    ...stylelint2.configs.recommended,
+];
+```
+
+## When not to use it
+
+Do not use this rule if your team intentionally wants Stylelint to remain a separate command with separate editor integration.
+
+## Package documentation
+
+Stylelint package documentation:
+
+> **Rule catalog ID:** R001
+
+## Further reading
+
+- [Stylelint Node.js API](https://stylelint.io/user-guide/node-api/)
+- [Stylelint configuration guide](https://stylelint.io/user-guide/configure)
+- [ESLint custom rules](https://eslint.org/docs/latest/extend/custom-rules)