@starci/eslint-canon-fe 9.2.0 → 9.4.0

package/dist/lib/types.js

@@ -0,0 +1,64 @@
+/**
+ * Type-aware helpers of the front-end canon: a rule asks what a node IS (its TypeScript type, the symbol an identifier
+ * resolves to, the module a declaration comes from), never what it is called. `starciFeConfig` turns typed linting on for
+ * the source tree (`parserOptions.projectService`), so these helpers refuse to run without the program instead of falling
+ * back to a name match.
+ */
+import ts from "typescript";
+/**
+ * The TypeScript services of the file being linted.
+ *
+ * @param context - The ESLint rule context.
+ * @returns The program, its checker and the ESTree to TS node map.
+ */
+export const typed = (context) => {
+    const services = context.sourceCode?.parserServices ?? context.parserServices;
+    if (!services?.program || !services.esTreeNodeToTSNodeMap) {
+        throw new Error(`${context.id ?? "a starci-fe rule"} needs typed linting (parserOptions.projectService); lint through starciFeConfig, which turns it on`);
+    }
+    const program = services.program;
+    const map = services.esTreeNodeToTSNodeMap;
+    return { program, checker: program.getTypeChecker(), toTs: (node) => map.get(node) };
+};
+/**
+ * True when the type of an expression is a promise (a thenable carrying a `then` method), after union members are read.
+ *
+ * @param context - The ESLint rule context.
+ * @param node - An ESTree expression.
+ * @returns Whether evaluating the node yields a promise.
+ */
+export const isPromiseValued = (context, node) => {
+    const { checker, toTs } = typed(context);
+    const tsNode = toTs(node);
+    if (!tsNode)
+        return false;
+    const type = checker.getTypeAtLocation(tsNode);
+    const parts = type.isUnion() ? type.types : [type];
+    return parts.some((part) => Boolean(part.getProperty("then")));
+};
+/**
+ * The declarations the symbol of an identifier resolves to, after import aliases are followed.
+ *
+ * @param context - The ESLint rule context.
+ * @param identifier - An ESTree identifier (or any node with a symbol).
+ * @returns The TypeScript declarations (empty when the checker has no symbol).
+ */
+export const declarationsOf = (context, identifier) => {
+    const { checker, toTs } = typed(context);
+    const tsNode = toTs(identifier);
+    if (!tsNode)
+        return [];
+    let symbol = checker.getSymbolAtLocation(tsNode);
+    if (!symbol)
+        return [];
+    if ((symbol.flags & ts.SymbolFlags.Alias) !== 0)
+        symbol = checker.getAliasedSymbol(symbol);
+    return symbol.getDeclarations() ?? [];
+};
+/**
+ * The forward-slash file name a declaration lives in.
+ *
+ * @param declaration - A TypeScript declaration.
+ * @returns Its source file name.
+ */
+export const fileOf = (declaration) => String(declaration.getSourceFile().fileName).split("\\").join("/");

package/dist/lib/why.d.ts

@@ -0,0 +1,350 @@
+/**
+ * The "why" of each rule the HFS catalogue assigns to this canon.
+ *
+ * WHERE IT IS SURFACED. An ESLint message is written for the developer at the terminal, in English,
+ * and says what is wrong in the vocabulary of the rule. The agent that reads a failed land gate needs
+ * the catalogue's sentence instead: the finding code (the key in `modules/kernel/failure-codes.yaml`)
+ * and a headline and next step it can quote to the owner. This map is the canon's half of that
+ * contract: `code` is the finding code, `en` the English source of the headline with `<file>` /
+ * `<what>` placeholders the reader fills from the ESLint location, `fix` the one sentence "what do I
+ * do now". The owner reads both in Vietnamese through the declared message catalog: the `en` and
+ * `fix` strings are the keys of `modules/i18n/messages/canon.yaml`, so `translator('vi')(entry.en)` and
+ * `translator('vi')(entry.fix)` hand back the Vietnamese of the same sentence.
+ *
+ * Every rule that carries a catalogue id (R18, R22, R49-R59, R60-R62, R65, the fe-stack catalog) has an entry;
+ * the twin test refuses a rule of those laws with no entry and an entry for a rule that does not exist.
+ */
+/** @typedef {{ code: string, en: string, fix: string }} Why */
+/** @type {Record<string, Why>} */
+export declare const why: {
+    "selection-fill-no-check": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-grammar-internal-selector": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "divider-full-bleed": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "button-intent-required": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "control-height": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-grammar-shim": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "button-no-variant": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "destructive-confirm-in-dialog": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "single-commit-per-render": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-commit-in-collection-item": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "nested-control-variant": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-app-surface-paint": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-list-panel-padding": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-env-outside-config": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-hardcoded-endpoint-fallback": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "fetch-only-in-api-client": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "client-fetch-has-signal": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-shared-transport-state": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "client-maps-auth-to-refused": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-failure-collapse": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-hand-typed-wire": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "use-client-only-at-boundary": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "hooks-folder-holds-hooks-only": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-middleware-file": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "locale-segment-is-locale": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-second-i18n-stack": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "html-lang-from-locale": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-hardcoded-copy": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-raw-brand-value": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-native-form-control": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "component-line-budget": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "unit-hook-budget": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-hand-rolled-polling": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-inline-lint-config": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-double-cast": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-type-assertion": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-non-null-assertion": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-explicit-any": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "list-item-has-key": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-index-key": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-inline-literal-prop-in-list": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "effect-subscription-needs-cleanup": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-data-fetch-in-effect": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-empty-catch": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-console": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "page-exports-metadata": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-null-suspense-fallback": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "navigation-from-intl": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-native-anchor": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "use-intl-formatter": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-hardcoded-route": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "client-no-server-import": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "server-module-marks-server-only": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-server-action": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "web-storage-only-in-modules": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-dangerous-html": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "response-cookie-attributes": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "props-fields-readonly": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-native-img": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "image-has-size": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "outcome-kinds-exhaustive": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "one-outcome-union": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "i18n-stack-in-one-module": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "no-app-relative-clock": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "fe-stack-import": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+    "file-size-growth": {
+        code: string;
+        en: string;
+        fix: string;
+    };
+};