@mslmio/eslint-config 1.1.1 → 1.2.0

package/README.md

@@ -28,7 +28,7 @@ UI half behind `/ui` means the root entry resolves neither `@shadcn/lint` nor
 |---|---|---|
 | `house` | anything TS/JS | `no-property-shorthand`, `curly: all`, `us-spelling`, `no-express-json-spaces` |
 | `lib` | a published library | house + `no-lib-process-env`, `no-module-scope-init` |
-| `ui` | anything rendering Tailwind | house + `require-leading-with-text-size`, `prefer-copy-icon` |
+| `ui` | anything rendering Tailwind | house + `require-leading-with-text-size`, `prefer-copy-icon`, `prefer-table-facets` |
 | `uiLib` | a published UI library | `lib` + `ui` |
 
 ## Rules
@@ -43,6 +43,7 @@ UI half behind `/ui` means the root entry resolves neither `@shadcn/lint` nor
 | `prefer-copy-icon` | lucide `Copy`, not `Clipboard` |
 | `us-spelling` | US spelling in prose and identifiers |
 | `require-leading-with-text-size` | An arbitrary Tailwind text size must state its own line height |
+| `prefer-table-facets` | A `kind: "select"` filter lists the values its rows hold (facets), never a literal `options` list |
 
 `us-spelling` skips regex literals — a pattern matching scraped text has to accept both
 spellings — and takes `allow` for proper names that keep their own:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mslmio/eslint-config",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Shareable ESLint flat config and house rules: US spelling, library hygiene, workspace layering, and Tailwind/React conventions.",
   "keywords": [
     "eslint",

package/plugin.js

@@ -6,9 +6,10 @@ import usSpelling from "./rules/us-spelling.js";
 import requireLeadingWithTextSize from "./rules/require-leading-with-text-size.js";
 import noPropertyShorthand from "./rules/no-property-shorthand.js";
 import noUpwardImport from "./rules/no-upward-import.js";
+import preferTableFacets from "./rules/prefer-table-facets.js";
 
 export default {
-    meta: { name: "@mslmio/eslint-plugin", version: "2.4.0" },
+    meta: { name: "@mslmio/eslint-plugin", version: "2.5.0" },
     rules: {
         "no-lib-process-env": noLibProcessEnv,
         "no-module-scope-init": noModuleScopeInit,
@@ -18,5 +19,6 @@ export default {
         "require-leading-with-text-size": requireLeadingWithTextSize,
         "no-property-shorthand": noPropertyShorthand,
         "no-upward-import": noUpwardImport,
+        "prefer-table-facets": preferTableFacets,
     },
 };

package/rules/prefer-table-facets.js

@@ -0,0 +1,69 @@
+// A table's picklist filter offers the values its rows actually hold - served by
+// the backend as FACETS - rather than a literal list. A literal list is a second
+// copy of a vocabulary the backend owns, and the next value it starts writing is
+// missing from the picklist until someone remembers to add it.
+//
+// Reported: `options` on an object with `kind: "select"` that is an array
+// literal, a `.map` over one, or a map over Object.entries/keys/values - the
+// shapes a hardcoded list takes. Options mapped from runtime data pass. A fixed
+// product vocabulary, one no row can grow, stays literal behind a disable
+// comment saying so.
+export default {
+    meta: {
+        type: "suggestion",
+        docs: {
+            description: "A picklist filter lists the values its rows hold (facets), not a literal list",
+        },
+        schema: [{ type: "object", properties: { docsUrl: { type: "string" } }, additionalProperties: false }],
+        messages: {
+            literal:
+                "A picklist filter should list the values its rows hold: leave `options` off and serve " +
+                "them as facets. A fixed product vocabulary stays literal behind a disable comment " +
+                "saying why.{{docs}}",
+        },
+    },
+    create(context) {
+        const docs = docsSuffix(context);
+        return {
+            ObjectExpression(node) {
+                const kind = property(node, "kind");
+                const options = property(node, "options");
+                if (!kind || !options || kind.value.type !== "Literal" || kind.value.value !== "select") {
+                    return;
+                }
+                if (isLiteralList(options.value)) {
+                    context.report({ node: options, messageId: "literal", data: { docs: docs } });
+                }
+            },
+        };
+    },
+};
+
+function property(node, name) {
+    return node.properties.find((p) => p.type === "Property" && !p.computed
+        && ((p.key.type === "Identifier" && p.key.name === name)
+            || (p.key.type === "Literal" && p.key.value === name)));
+}
+
+function isLiteralList(v) {
+    if (v.type === "ArrayExpression") {
+        return true;
+    }
+    if (v.type !== "CallExpression" || v.callee.type !== "MemberExpression" || v.callee.computed
+        || v.callee.property.name !== "map") {
+        return false;
+    }
+    const source = v.callee.object;
+    if (source.type === "ArrayExpression") {
+        return true;
+    }
+    return source.type === "CallExpression" && source.callee.type === "MemberExpression"
+        && source.callee.object.type === "Identifier" && source.callee.object.name === "Object"
+        && ["entries", "keys", "values"].includes(source.callee.property.name);
+}
+
+// A link only an internal caller can resolve, so the public default is none.
+function docsSuffix(context) {
+    const url = context.options[0]?.docsUrl;
+    return url ? ` See ${url}.` : "";
+}

package/ui.js

@@ -53,6 +53,7 @@ export const ui = [
         rules: {
             "mslmio/require-leading-with-text-size": "error",
             "mslmio/prefer-copy-icon": "error",
+            "mslmio/prefer-table-facets": "error",
         },
     },
 ];