@geonosis/oxlint-plugin-biological-architecture 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @geonosis/oxlint-plugin-biological-architecture
 
+## 3.1.0
+
+### Minor Changes
+
+- 27d169d: `icon-control-has-name`, in the `frontend` preset: a `<button>` or `<a>` — or a control atom the repo names in `controls` — whose only content is an icon (a component whose name matches `icons`, `Icon$` by default, or an inline `<svg>`) and that carries no `aria-label`, `aria-labelledby` or `title` has no name a screen reader can read. A spread is left alone. It needs no option to run.
+
 ## 3.0.0
 
 ### Major Changes

package/README.md

@@ -1,6 +1,6 @@
 # @geonosis/oxlint-plugin-biological-architecture
 
-80 architecture rules as an oxlint JS plugin: which tier a file belongs to, what it may import,
+81 architecture rules as an oxlint JS plugin: which tier a file belongs to, what it may import,
 where state is allowed to live, and the backend invariants that go with them. Nothing is hardcoded
 to a repo — every list of brands, features, tables or paths is an option. A rule enabled without the
 options it needs says so once a run and judges nothing, rather than passing silently.
@@ -57,7 +57,7 @@ everything below the organelle is inert. A cell never composes another cell.
 
 | preset | rules | what it is |
 | --- | --- | --- |
-| `frontend` (= `recommended`) | 37 | tier direction, state placement, element choice, file shape |
+| `frontend` (= `recommended`) | 38 | tier direction, state placement, element choice, file shape |
 | `backend-workflows` | 15 | workflows, time, the data layer, single source of truth |
 | `backend-medusa` | 13 | Medusa steps, emits, subscribers, loaders and the store route surface |
 | `tenant-scoping` | 4 | every row placed, scoped and narrowed to one tenant |

package/RULES.md

@@ -11,12 +11,12 @@ One plugin name, two rule sets, no shared code. **33 rules had the same filename
 
 The union here is **52 rules** — 54 when it was cut, less `document-sagas-are-generic` and
 `documents-share-one-table`, retired in 2.7.0 because both enforced one consumer's document kinds —
-plus twenty-eight the kit wrote for itself: `layer-walls`, `emit-declares-attempts`,
+plus twenty-nine the kit wrote for itself: `layer-walls`, `emit-declares-attempts`,
 `cell-no-cross-feature-organelles`, the `backend-medusa` ten, `no-unregistered-plugin-dir` +
 `router-schema-parity`, the `themekit` two, `no-mock-db-in-integration`, `todo-names-its-plan`,
 `boundary-time-is-primitive`, `durable-body-reads-through-steps`, `subpath-over-barrel` and the six
-of the W67 batch — **80**. The two retired ids went in 3.0.0.
-Every one of the twenty-eight is marked **written here** in the inventory, and the table below is
+of the W67 batch, and `icon-control-has-name` — **81**. The two retired ids went in 3.0.0.
+Every one of the twenty-nine is marked **written here** in the inventory, and the table below is
 held against that column rather than kept by hand.
 
 | | count |
@@ -26,8 +26,8 @@ held against that column rather than kept by hand.
 | A Medusa storefront only | 3 |
 | A Workers + D1 app only | 16 |
 | **union** | **52** |
-| written here | 28 |
-| **total** | **80** |
+| written here | 29 |
+| **total** | **81** |
 
 ## How divergence was resolved
 
@@ -721,6 +721,7 @@ every repo's.
 | `dialect-through-the-seam` | backend-workflows | `seam` | `onImportSource` + `mergeVisitors` + `paths` + `options` | — | yes | a Workers + D1 app only, de-hardcoded |
 | `durable-body-reads-through-steps` | backend-workflows | `ports` | `nodes` + `objects` + `steps` + `options` | — | — | **written here** (#167, design-026 §8) |
 | `effect-hook-naming` | frontend | — | `paths` | yes | yes | diverged |
+| `icon-control-has-name` | frontend | — | `nodes` + `options` | — | — | **written here** |
 | `emit-declares-attempts` | backend-medusa | — | `options` | — | — | **written here** |
 | `font-roles-only` | themekit | `roles` | `paths` + `options` + `styling` | — | — | **written here** (U2) |
 | `layer-walls` | tooling | `layers` | `onImportSource` + `imports` + `paths` + `options` | — | — | **written here** |
@@ -878,6 +879,7 @@ option not named here is one no rule reads.
 | `effect-hook-naming` | — |
 | `emit-declares-attempts` | `budgetHelpers`, `emitters` |
 | `font-roles-only` | `allow`, `exemptModules`, `prefix`, `roles` |
+| `icon-control-has-name` | `controls`, `icons` |
 | `layer-walls` | `externals`, `layers`, `typeOnly` |
 | `list-take-without-order` | `callees`, `orderKeys` |
 | `max-comment-density` | — |

package/corpus/.oxlintrc.json

@@ -171,6 +171,7 @@
       ]
     ],
     "biological-architecture/no-raw-sql-outside-allowed": "error",
+    "biological-architecture/icon-control-has-name": "error",
     "biological-architecture/no-react-namespace": "error",
     "biological-architecture/no-runtime-dead-affordance": [
       "error",

package/corpus/icon-controls/bad-unnamed-icon-button.tsx

@@ -0,0 +1,8 @@
+// BREACH: a screen reader announces "button" and nothing else.
+import { BinIcon } from '@kit/ui/atoms/icons/bin-icon'
+
+export const RemoveLine = ({ onRemove }: { onRemove: () => void }): JSX.Element => (
+  <button type="button" onClick={onRemove}>
+    <BinIcon />
+  </button>
+)

package/corpus/icon-controls/good-named-icon-button.tsx

@@ -0,0 +1,19 @@
+import { BinIcon } from '@kit/ui/atoms/icons/bin-icon'
+
+export const RemoveLine = ({
+  label,
+  onRemove
+}: {
+  label: string
+  onRemove: () => void
+}): JSX.Element => (
+  <div>
+    <button type="button" onClick={onRemove} aria-label={label}>
+      <BinIcon />
+    </button>
+    <button type="button" onClick={onRemove}>
+      <BinIcon />
+      <span className="sr-only">{label}</span>
+    </button>
+  </div>
+)

package/corpus/manifest.json

@@ -16,6 +16,7 @@
     "biological-architecture/effect-hook-naming",
     "biological-architecture/emit-declares-attempts",
     "biological-architecture/font-roles-only",
+    "biological-architecture/icon-control-has-name",
     "biological-architecture/layer-walls",
     "biological-architecture/list-take-without-order",
     "biological-architecture/max-comment-density",

package/dist/index.js

@@ -16,6 +16,7 @@ import durableBodyReadsThroughSteps from "./rules/durable-body-reads-through-ste
 import effectHookNaming from "./rules/effect-hook-naming.js";
 import emitDeclaresAttempts from "./rules/emit-declares-attempts.js";
 import fontRolesOnly from "./rules/font-roles-only.js";
+import iconControlHasName from "./rules/icon-control-has-name.js";
 import layerWalls from "./rules/layer-walls.js";
 import { reportingOncePerRun } from "./rules/lib/options.js";
 import listTakeWithoutOrder from "./rules/list-take-without-order.js";
@@ -110,6 +111,7 @@ var rules = reportingOnce(withEngines({
   "effect-hook-naming": effectHookNaming,
   "emit-declares-attempts": emitDeclaresAttempts,
   "font-roles-only": fontRolesOnly,
+  "icon-control-has-name": iconControlHasName,
   "layer-walls": layerWalls,
   "list-take-without-order": listTakeWithoutOrder,
   "max-comment-density": maxCommentDensity,

package/dist/presets.js

@@ -9,6 +9,7 @@ var FRONTEND = [
   "compound-must-be-stateless",
   "compound-no-stores",
   "effect-hook-naming",
+  "icon-control-has-name",
   "molecule-atoms-only",
   "molecule-must-compose",
   "next-route-segment-is-thin-delegate",

package/dist/rules/icon-control-has-name.d.ts

@@ -0,0 +1,53 @@
+import type { RuleContextWithRawOptions } from './lib/context.js';
+import { type Probe } from './lib/probe.js';
+type Name = {
+    name?: string;
+    object?: Name;
+    property?: Name;
+    type: string;
+};
+type Attribute = {
+    name?: Name;
+    type: string;
+};
+type Child = {
+    children?: Child[];
+    openingElement?: {
+        attributes?: Attribute[];
+        name: Name;
+    };
+    type: string;
+    value?: string;
+};
+declare const iconControlHasName: {
+    create(context: RuleContextWithRawOptions): {
+        JSXElement(node: Child): void;
+    };
+    fixShape: string;
+    meta: {
+        docs: {
+            description: string;
+        };
+        messages: {
+            unnamed: string;
+        };
+        schema: {
+            additionalProperties: boolean;
+            properties: {
+                controls: {
+                    items: {
+                        type: 'string';
+                    };
+                    type: 'array';
+                };
+                icons: {
+                    type: 'string';
+                };
+            };
+            type: 'object';
+        }[];
+        type: 'problem';
+    };
+    probe(options: readonly unknown[]): Probe;
+};
+export default iconControlHasName;

package/dist/rules/icon-control-has-name.js

@@ -0,0 +1,65 @@
+// src/rules/icon-control-has-name.ts
+import { bagOf, firstOf } from "./lib/probe.js";
+import { optionsBag, STRING, STRINGS } from "./lib/schema.js";
+var NATIVE_CONTROLS = ["button", "a"];
+var ICONS = "Icon$";
+var NAMED_BY = new Set(["aria-label", "aria-labelledby", "title"]);
+var nameOf = (node) => node === undefined ? "" : node.type === "JSXMemberExpression" ? `${nameOf(node.object)}.${nameOf(node.property)}` : node.name ?? "";
+var said = (child) => child.type !== "JSXText" || (child.value ?? "").trim() !== "";
+var iconControlHasName = {
+  create(context) {
+    const options = bagOf(context.options);
+    const controls = new Set([...NATIVE_CONTROLS, ...options.controls ?? []]);
+    const icon = new RegExp(options.icons ?? ICONS);
+    return {
+      JSXElement(node) {
+        const control = nameOf(node.openingElement?.name);
+        if (!controls.has(control))
+          return;
+        const attributes = node.openingElement?.attributes ?? [];
+        if (attributes.some((one) => one.type !== "JSXAttribute" || NAMED_BY.has(nameOf(one.name)))) {
+          return;
+        }
+        const shown = (node.children ?? []).filter(said);
+        const icons = shown.map((one) => one.type === "JSXElement" ? nameOf(one.openingElement?.name) : "");
+        if (icons.length === 0 || !icons.every((name) => name === "svg" || icon.test(name)))
+          return;
+        context.report({
+          data: { control, icons: icons.join(", ") },
+          messageId: "unnamed",
+          node
+        });
+      }
+    };
+  },
+  fixShape: `A control whose only content is an icon has no name: the icon is decorative, so a screen reader
+announces "button" and nothing else. Give it \`aria-label\` (or \`aria-labelledby\`, or \`title\`) in the
+app's own words — a label prop the caller passes, never a string the component invents — or put text
+beside the icon, visible or \`sr-only\`. \`<button>\` and \`<a>\` are read by default; \`controls\` names the
+repo's control atoms, and \`icons\` is the pattern an icon component's name matches (\`Icon$\` by default);
+an inline \`<svg>\` is always one.
+A spread may carry the name and is left alone.`,
+  meta: {
+    docs: {
+      description: "A button or link whose only content is an icon component, with no `aria-label`, `aria-labelledby` or `title`, has no accessible name — a screen reader announces a control that says nothing."
+    },
+    messages: {
+      unnamed: "<{{control}}> shows only {{icons}} and has no name a screen reader can read. Give it aria-label in the words the app passes in, or text beside the icon."
+    },
+    schema: optionsBag({ controls: STRINGS, icons: STRING }),
+    type: "problem"
+  },
+  probe(options) {
+    const bag = bagOf(options);
+    const control = firstOf(bag.controls, NATIVE_CONTROLS);
+    return {
+      path: "molecules/geonosis-probe.tsx",
+      source: `export const Probe = () => <${control}><svg /></${control}>
+`
+    };
+  }
+};
+var icon_control_has_name_default = iconControlHasName;
+export {
+  icon_control_has_name_default as default
+};

package/dist/rules/molecule-must-compose.d.ts

@@ -2,9 +2,9 @@ import { type RuleContext } from './lib/context.js';
 import { type CompositionImportNode, type JsxOpeningElementNode } from './lib/render-tracking.js';
 declare const moleculeMustCompose: {
     create(context: RuleContext): {
-        'Program:exit'?: undefined;
         ImportDeclaration?: undefined;
         JSXOpeningElement?: undefined;
+        'Program:exit'?: undefined;
     } | {
         ImportDeclaration(node: CompositionImportNode): void;
         JSXOpeningElement(node: JsxOpeningElementNode): void;

package/dist/rules/no-duplicate-jsx-patterns.d.ts

@@ -33,8 +33,8 @@ interface AnyNode {
 }
 declare const noDuplicateJsxPatterns: {
     create(context: RuleContext): {
-        JSXOpeningElement?: undefined;
         'Program:exit'?: undefined;
+        JSXOpeningElement?: undefined;
     } | {
         JSXOpeningElement(node: JSXNode): void;
         'Program:exit'(): void;

package/dist/rules/no-hook-in-component-disguise.d.ts

@@ -55,15 +55,15 @@ interface ProgramNode {
 }
 declare const noHookInComponentDisguise: {
     create(context: RuleContext): {
-        Program?: undefined;
-        CallExpression?: undefined;
         ImportDeclaration?: undefined;
+        CallExpression?: undefined;
         ArrowFunctionExpression?: undefined;
         'ArrowFunctionExpression:exit'?: undefined;
         FunctionDeclaration?: undefined;
         'FunctionDeclaration:exit'?: undefined;
         FunctionExpression?: undefined;
         'FunctionExpression:exit'?: undefined;
+        Program?: undefined;
         ReturnStatement?: undefined;
         VariableDeclarator?: undefined;
     } | {

package/dist/rules/no-loader-side-effect-in-index-file.d.ts

@@ -9,9 +9,9 @@ interface Options {
 }
 declare const noLoaderSideEffectInIndexFile: {
     create(context: RuleContextWithOptions<Options>): {
-        CallExpression?: undefined;
-        ExportDefaultDeclaration?: undefined;
         ExportNamedDeclaration?: undefined;
+        ExportDefaultDeclaration?: undefined;
+        CallExpression?: undefined;
     } | {
         CallExpression(node: AnyNode): void;
         ExportDefaultDeclaration(node: AnyNode): void;

package/dist/rules/step-opens-its-own-cell.d.ts

@@ -28,8 +28,8 @@ interface ImportNode {
 }
 declare const stepOpensItsOwnCell: {
     create(context: RuleContextWithOptions<Options>): {
-        Program?: undefined;
         ImportDeclaration?: undefined;
+        Program?: undefined;
     } | {
         ImportDeclaration(node: ImportNode): void;
         Program(node: unknown): void;

package/dist/rules/tissue-must-compose.d.ts

@@ -3,8 +3,8 @@ import { type CompositionImportNode, type JsxOpeningElementNode } from './lib/re
 declare const tissueMustCompose: {
     create(context: RuleContext): {
         ExportNamedDeclaration?: undefined;
-        JSXOpeningElement?: undefined;
         'Program:exit'?: undefined;
+        JSXOpeningElement?: undefined;
         ImportDeclaration?: undefined;
     } | {
         ExportNamedDeclaration(node: {

package/dist/rules/tissue-no-data-props.d.ts

@@ -1,8 +1,8 @@
 import { type RuleContext } from './lib/context.js';
 declare const tissueNoDataProps: {
     create(context: RuleContext): {
-        ExportNamedDeclaration?: undefined;
         ExportDefaultDeclaration?: undefined;
+        ExportNamedDeclaration?: undefined;
     } | {
         ExportDefaultDeclaration(node: {
             declaration?: unknown;

package/dist/rules/tissue-no-hooks.d.ts

@@ -21,8 +21,8 @@ interface ImportSpecifier {
 }
 declare const tissueNoHooks: {
     create(context: RuleContext): {
-        CallExpression?: undefined;
         ImportDeclaration?: undefined;
+        CallExpression?: undefined;
     } | {
         CallExpression(node: AnyNode): void;
         ImportDeclaration(node: ImportNode): void;

package/dist/rules/worker-handles-are-scoped.d.ts

@@ -8,8 +8,8 @@ interface Options {
 }
 declare const cellHandlesAreScoped: {
     create(context: RuleContextWithOptions<Options>): {
-        CallExpression?: undefined;
         'Program:exit'?: undefined;
+        CallExpression?: undefined;
         ExportDefaultDeclaration?: undefined;
         ClassDeclaration?: undefined;
     } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geonosis/oxlint-plugin-biological-architecture",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "types": "./dist/index.d.ts",
   "description": "Biological tier architecture as lint — the union of a Medusa storefront's and a Workers + D1 app's rule sets, shipped as presets.",
   "keywords": [
@@ -45,7 +45,7 @@
     "oxlint": ">=1.77"
   },
   "devDependencies": {
-    "@geonosis/lint-parity": "3.0.0"
+    "@geonosis/lint-parity": "3.1.0"
   },
   "engines": {
     "node": ">=22"