@openally/config.stylelint 1.0.1 → 2.0.0

package/README.md

@@ -2,30 +2,59 @@
   <h1 align="center">Stylelint Config</h1>
 </p>
 
-<div align="center">OpenAlly front-end Stylelint configuration</div>
+<div align="center">OpenAlly front-end Stylelint configuration (CSS and Lit.js)</div>
 
 ## Requirements
-- [Node.js](https://nodejs.org/en/) v24 or higher
+- [Node.js](https://nodejs.org/en/) `^22.22.2`, `^24.15.0` or `>=26.0.0`
+- [Stylelint](https://stylelint.io/) v18 (peer dependency)
 
 ## Getting Started
 
 This package is available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com).
 
 ```bash
-$ npm i -D @openally/config.stylelint
+$ npm i -D stylelint @openally/config.stylelint
 # or
-$ yarn add @openally/config.stylelint -D
+$ yarn add stylelint @openally/config.stylelint -D
 ```
 
 ## Usage
 
-Create a `.stylelintrc.json` file in the root of your project and extend the `@openally/config.stylelint` configuration.
+Create a `stylelint.config.mjs` file in the root of your project and extend the `@openally/config.stylelint` configuration.
 
-```json
-{
-  "extends": "@openally/config.stylelint"
-}
+```js
+/**
+ * @type {import("stylelint").Config}
+ */
+export default {
+  extends: ["@openally/config.stylelint"]
+};
 ```
 
+Then lint both your stylesheets and your Lit components:
+
+```bash
+$ npx stylelint "src/**/*.ts" "public/**/*.css" --cache
+```
+
+## What's included
+
+- [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard) as the base.
+- The [@stylistic/stylelint-plugin](https://github.com/stylelint-stylistic/stylelint-stylistic) recommended preset for formatting, with these changes:
+  - `@stylistic/indentation`: 2 spaces instead of tabs. Lines that continue a multi-line value (`calc()`, gradients, transitions) are not checked, so they can be aligned by hand.
+  - `@stylistic/linebreaks`: off. Git normalizes line endings (`.gitattributes`).
+  - `@stylistic/declaration-colon-newline-after`: off, so a multi-line value can start on the property line (`max-height: min(`).
+  - `@stylistic/value-list-comma-newline-after`: off, so a long list such as `font-family` can wrap with several items per line.
+  - `@stylistic/selector-descendant-combinator-no-non-space`: off, because it treats a line break in a long selector as an error and joins the lines when fixing.
+- `no-duplicate-selectors` enabled, `no-descending-specificity` disabled (too noisy with Shadow DOM scoped styles).
+- `**/*.ts` and `**/*.js` files are parsed with [postcss-lit](https://github.com/43081j/postcss-lit), so styles inside `` css`...` `` tagged templates are linted. `no-empty-source` is disabled for these files, since most of them contain no styles.
+- `**/dist/**` and `**/coverage/**` are ignored.
+
+> [!NOTE]
+> postcss-lit skips templates it cannot interpret, such as one made only of interpolations (`` css`${a}${b}` ``), and prints a warning. Add a `// postcss-lit-disable-next-line` comment above such a template to silence it.
+
+> [!WARNING]
+> With postcss-lit 1.4.1, `stylelint --fix` rewrites every Lit file it reads, even ones with no errors. It can leave a placeholder such as `POSTCSS_LIT_1` in place of an interpolation (when a custom property value holds two or more `${}`), add spaces to the blank line before the closing backtick, or leave a stray `\r` in CRLF files. Run `--fix` on an LF working tree and review the diff before committing.
+
 ## License
 MIT

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+declare const _default: {
+    plugins: string[];
+    extends: string[];
+    rules: {
+        "@stylistic/indentation": (number | {
+            ignore: string[];
+        })[];
+        "@stylistic/linebreaks": null;
+        "@stylistic/declaration-colon-newline-after": null;
+        "@stylistic/value-list-comma-newline-after": null;
+        "@stylistic/selector-descendant-combinator-no-non-space": null;
+        "no-descending-specificity": null;
+        "no-duplicate-selectors": boolean;
+    };
+    ignoreFiles: string[];
+    overrides: {
+        files: string[];
+        customSyntax: string;
+        rules: {
+            "no-empty-source": null;
+        };
+    }[];
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAGA,wBA6CmB"}

package/dist/index.js

@@ -0,0 +1,46 @@
+export default {
+    plugins: [
+        "@stylistic/stylelint-plugin"
+    ],
+    extends: [
+        "stylelint-config-standard",
+        // See: https://stylelint-stylistic.github.io/user-guide/recommended
+        "@stylistic/stylelint-plugin/recommended"
+    ],
+    rules: {
+        // The recommended preset indents with tabs
+        "@stylistic/indentation": [2, {
+                // Multi-line values (calc(), gradients, transitions) are aligned by hand
+                ignore: ["value"]
+            }],
+        // Line endings are normalized by Git (.gitattributes), not by the linter
+        "@stylistic/linebreaks": null,
+        // Allow multi-line values to start on the declaration line, e.g. `max-height: min(\n ... \n);`
+        "@stylistic/declaration-colon-newline-after": null,
+        // Allow long value lists (e.g. font-family) to wrap with several items per line
+        "@stylistic/value-list-comma-newline-after": null,
+        // Treats a line break inside a long compound selector as an invalid combinator and joins the lines on fix
+        "@stylistic/selector-descendant-combinator-no-non-space": null,
+        // See: https://stylelint.io/user-guide/rules/no-descending-specificity
+        "no-descending-specificity": null,
+        // See: https://stylelint.io/user-guide/rules/no-duplicate-selectors
+        "no-duplicate-selectors": true
+    },
+    ignoreFiles: [
+        "**/dist/**",
+        "**/coverage/**"
+    ],
+    overrides: [
+        {
+            files: [
+                "**/*.ts",
+                "**/*.js"
+            ],
+            customSyntax: "postcss-lit",
+            rules: {
+                // See: https://stylelint.io/user-guide/rules/no-empty-source
+                "no-empty-source": null
+            }
+        }
+    ]
+};

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@openally/config.stylelint",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "OpenAlly Stylelint configuration for front-end with Lit.js",
   "type": "module",
   "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build",
@@ -32,9 +40,17 @@
   "author": "GENTILHOMME Thomas <gentilhomme.thomas@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@stylistic/stylelint-plugin": "5.3.0",
+    "@stylistic/stylelint-plugin": "6.0.1",
     "postcss-lit": "1.4.1",
-    "stylelint": "17.15.0",
-    "stylelint-config-standard": "40.0.0"
+    "stylelint-config-standard": "41.0.0"
+  },
+  "engines": {
+    "node": "^22.22.2 || ^24.15.0 || >=26.0.0"
+  },
+  "peerDependencies": {
+    "stylelint": "^18.0.0"
+  },
+  "devDependencies": {
+    "stylelint": "18.0.0"
   }
 }