@brighterly/lib-fe-codestyle 0.5.2 → 1.0.1

package/dist/invariants/rules/fixtures.js

@@ -1,89 +0,0 @@
-/**
- * Fixtures for the common rule pack — shipped, not test-only.
- *
- * Fixtures travel with their rules. A consuming app runs `--self-test` over the rules it
- * actually loads, so if the pack shipped rules without fixtures every consumer would report
- * "no self-test fixture" for rules it did not write and cannot fix.
- *
- * `bad` must produce at least one finding, `good` none.
- */
-export const commonFixtures = {
-    'core/R1': {
-        file: 'app/a.ts',
-        bad: 'const t = localStorage.getItem("k")',
-        good: 'const t = safeLocalStorage.getItem("k")',
-    },
-    'core/R2': {
-        file: 'app/components/A.vue',
-        bad: '<template><div /></template>\n<style scoped lang="scss">.a { color: red; }</style>',
-        good: '<template><div /></template>\n<style scoped lang="scss" src="@scss/components/A.scss" />',
-    },
-    'core/R3': {
-        file: 'app/a.ts',
-        bad: 'const v = JSON.parse(raw)',
-        good: 'let v = null\ntry { v = JSON.parse(raw) } catch { v = null }',
-    },
-    'core/R4': {
-        file: 'app/assets/scss/fonts.scss',
-        bad: '@font-face { font-family: Rubik, sans-serif; src: url(a.woff2); }',
-        good: '@font-face { font-family: Rubik; src: url(a.woff2); }',
-    },
-    'core/C1': {
-        file: 'app/a.ts',
-        bad: 'window.addEventListener("resize", onResize)',
-        good: 'useEventListener(window, "resize", onResize)',
-    },
-    'core/C3': [
-        {
-            file: 'app/assets/scss/components/Card.scss',
-            bad: '.card { color: #1f2937; }',
-            good: '.card { color: $slate-800; }',
-        },
-        // In a .vue file only the <style> block is a stylesheet: an SVG fill in the
-        // template has no place to put a $token, so it must stay quiet.
-        {
-            file: 'app/components/UI/Icons/IconLeaf.vue',
-            bad: '<template><svg><path fill="currentColor" /></svg></template>\n<style scoped lang="scss">\n.icon { color: #e2e8f0; }\n</style>',
-            good: '<template><svg><path fill="#E2E8F0" /></svg></template>\n<style scoped lang="scss">\n.icon { color: $slate-200; }\n</style>',
-        },
-    ],
-    'core/C4': [
-        {
-            file: 'app/a.ts',
-            bad: "const d = dayjs().format('YYYY-MM-DD')",
-            good: 'const d = dayjs().format(DateFormat.DefaultDate)',
-        },
-        // The day-extraction misuse fires; a bare toISOString() (an API timestamp) and the
-        // epoch duration trick do not.
-        {
-            file: 'app/b.ts',
-            bad: "const day = new Date().toISOString().split('T')[0]",
-            good: 'const generatedAt = dayjs().toISOString()\nconst duration = new Date(s * 1000).toISOString().slice(14, 19)',
-        },
-        // Every letter run must be a real dayjs token — an answer label that happens to fit
-        // the char class ('ADHD / ADD' carries a DD) is not a format string.
-        {
-            file: 'app/c.ts',
-            good: "const option = { code: 'ADHD_ADD', label: 'ADHD / ADD' }",
-        },
-    ],
-    'core/C6': {
-        file: 'app/assets/scss/components/Card.scss',
-        bad: '.card { font-size: 14px; }',
-        good: '.card { @include font(14px, 20px); color: $slate-800; }',
-    },
-    'core/C7': {
-        // Two script tags in OPPOSITE orders, so the bad fixture violates whichever
-        // direction the consuming app declares in settings.scriptAttrOrder. The good
-        // fixture carries no lang attribute, so it is clean under either canonical.
-        file: 'app/components/A.vue',
-        bad: '<script lang="ts" setup>\n</script>\n<script setup lang="ts">\n</script>',
-        good: '<template><div /></template>\n<script setup>\nconst a = 1\n</script>',
-    },
-};
-/**
- * `core/C2` and `core/C5` are `once` rules over the whole file list — a single-file fixture
- * cannot express them, so they are exempt from the fixture requirement and covered by
- * their own tests instead.
- */
-export const commonSelfTestSkip = ['core/C2', 'core/C5'];

package/dist/invariants/rules/index.d.ts

@@ -1,55 +0,0 @@
-/**
- * One rule list, assembled from the family files — the same shape each consuming app uses
- * for its own rules.
- *
- * The family letter says where a rule came from and who owns changing it:
- *   R — regression: it broke production at least once   → a code decision
- *   B — business: a data contract                       → NOT shipped here; every app's
- *                                                         contract is its own domain
- *   C — convention: a preference we chose               → team consensus
- *   L — linter: a built-in ESLint rule                  → eslint.config.mjs
- *
- * Shared rule ids carry the `core/` prefix (`core/R1`); app-local ids stay bare (`R1`).
- * The prefix marks provenance and keeps the two number lines independent — and `run()`
- * still fails fast on a duplicate rather than letting an allowlist silently suppress
- * the wrong rule.
- */
-import type { Rule } from '../types.js';
-export { linterOwnedRules } from './linter.js';
-export { commonFixtures, commonSelfTestSkip } from './fixtures.js';
-export { eachLine, setting } from './shared.js';
-export type { LineFn } from './shared.js';
-/** Every shared rule, in report order. Hover `sharedRuleIds` members for what each checks. */
-export declare const commonRules: Rule[];
-/**
- * The hoverable catalog: every rule this pack ships, id → id. Use these constants for
- * `allowlists` / `levels` keys and `--rule=` values when you want the contract in the
- * IDE — hover any member for what the rule checks, at which level, and what to do
- * instead. A test pins this map to `commonRules`, so it cannot drift.
- */
-export declare const sharedRuleIds: {
-    /** `warn` (target `error`, interim 2026-09-25) — bare `localStorage`/`sessionStorage` access. The accessor itself throws SecurityError on Safari ITP, Firefox strict mode and in-app webviews; `if (localStorage)` guards throw too. Fix: the app's safe storage wrapper (`settings.safeStorageModule`). */
-    readonly 'core/R1': "core/R1";
-    /** `error` — SCSS rules written inline in a Vue `<style>` block. Inline styles drift from the design tokens invisibly. Fix: a dedicated `.scss` file referenced via `<style scoped lang="scss" src="…" />`. */
-    readonly 'core/R2': "core/R2";
-    /** `warn` (target `error`, interim 2026-09-25) — `JSON.parse` with no enclosing `try`/`catch`. A corrupt stored value crashes that code path permanently for the visitor. Fix: the app's guarded parse helper (`settings.safeJsonParse`) or try/catch. */
-    readonly 'core/R3': "core/R3";
-    /** `error` — `@font-face` declaring a font *stack*. Inside `@font-face`, `font-family` names the face being defined; a comma-separated stack is invalid and the browser drops the face silently. Fix: single family name inside, the stack on the selectors that use it. */
-    readonly 'core/R4': "core/R4";
-    /** `warn` — hand-rolled browser API with a VueUse equivalent (`new IntersectionObserver`, `addEventListener`, `setInterval`, …). VueUse owns the lifecycle/SSR/error paths. Fix: the composable named in the message, imported from `@vueuse/core`. */
-    readonly 'core/C1': "core/C1";
-    /** `warn` — a component whose filename duplicates a UI-kit component (`settings.uiKitRoot`). A same-name second component splits the design system in two. Fix: import or extend the UI-kit one. */
-    readonly 'core/C2': "core/C2";
-    /** `warn` — a literal colour (`#hex`, numeric `rgba()`) in SCSS/Vue instead of a palette token. Hardcoded colours survive theme and palette changes silently. Fix: a token from `settings.scssTokensFile`. */
-    readonly 'core/C3': "core/C3";
-    /** `warn` — a hand-rolled date format string (`'YYYY-MM-DD'`) or a `toISOString()` whose date part is extracted (`.split('T')[0]`, `.slice(0, 10)`). The date's shape becomes an accident instead of a contract. Fix: the shared enum (`settings.dateFormatModule`). */
-    readonly 'core/C4': "core/C4";
-    /** `warn` — a type file outside `types/<entity>/{enums,interfaces,types}.ts` (root under `settings.typesRoot`). Root-level or mixed-kind type files accrete unrelated entities. `.d.ts` ambient files are exempt. */
-    readonly 'core/C5': "core/C5";
-    /** `warn` — a raw `font-family`/`font-size`/`font-weight` declaration. Hand-written fonts drift off the UI-kit type scale silently. Fix: the app's typography source (`settings.typographySource`). */
-    readonly 'core/C6': "core/C6";
-    /** `warn` — `<script>` attribute order differing from the app canonical (`settings.scriptAttrOrder`, default `setup-first`). The two spellings are compiler-equivalent, so the split only ever grows. */
-    readonly 'core/C7': "core/C7";
-};
-/** Union of every id the shared pack ships — for typing app config keys. */
-export type SharedRuleId = keyof typeof sharedRuleIds;

package/dist/invariants/rules/linter.d.ts

@@ -1,10 +0,0 @@
-/**
- * Linter rules — invariants a built-in ESLint rule already covers better than we could.
- *
- * Declared here, configured in each app\'s `eslint.config.mjs`, so the generated inventory
- * is complete and nobody re-implements one by accident. Empty today: a declaration here
- * asserts the rule IS configured, and claiming coverage the linter does not provide is the
- * exact failure this directory exists to prevent.
- */
-import type { LinterOwnedRule } from '../types.js';
-export declare const linterOwnedRules: LinterOwnedRule[];

package/dist/invariants/rules/linter.js

@@ -1,9 +0,0 @@
-/**
- * Linter rules — invariants a built-in ESLint rule already covers better than we could.
- *
- * Declared here, configured in each app\'s `eslint.config.mjs`, so the generated inventory
- * is complete and nobody re-implements one by accident. Empty today: a declaration here
- * asserts the rule IS configured, and claiming coverage the linter does not provide is the
- * exact failure this directory exists to prevent.
- */
-export const linterOwnedRules = [];

package/dist/invariants/run.d.ts

@@ -1,53 +0,0 @@
-/**
- * The invariants runner — `run(options)`.
- *
- * This is land-app's `invariants/cli.mts` with four hardcoded constants lifted into
- * arguments (scan roots, rule sources, the spec dir/project, the README path) and the rule
- * list, config and fixtures injected. Nothing else was redesigned: the argv surface, the
- * self-test gate, the caches, the suppression grammar, severity resolution, the reporter
- * and the exit codes are the originals.
- *
- * Exit codes:
- *   0 — no error-level violations
- *   1 — at least one error-level violation
- *   2 — the validator itself failed
- */
-import type { Allowlists, Levels, LinterOwnedRule, RetiredRules, Rule, Unmaintained } from './types.js';
-import type { Fixture } from './self-test.js';
-export interface RunOptions {
-    /** Repo root. Passed, never derived — import.meta.url here resolves into node_modules. */
-    root: string;
-    rules: Rule[];
-    linterOwnedRules: LinterOwnedRule[];
-    config: {
-        allowlists: Allowlists;
-        levels: Levels;
-        retired: RetiredRules;
-        unmaintained: Unmaintained;
-        /** App-specific paths shared rules read from RuleContext.settings. */
-        settings?: Readonly<Record<string, string>>;
-    };
-    /** Directories walked for the candidate file set. */
-    scanRoots: string[];
-    /** Path prefixes whose change triggers the self-test in --staged mode. */
-    ruleSources: string[];
-    /** Vitest project name for the module-resolving half. */
-    vitestProject: string;
-    /** Directory holding the vector-2 specs. */
-    specDir: string;
-    /** README whose generated inventory must not drift. */
-    readmePath: string;
-    /** Config file a dangling allowlist/levels key is reported against. */
-    configFile?: string;
-    /** Fixtures for --self-test, keyed by rule id. Omit to skip the self-test entirely. */
-    fixtures?: Record<string, Fixture>;
-    /** Repo-specific self-test assertions; each returns failure messages. */
-    extraChecks?: (() => string[] | Promise<string[]>)[];
-    /** Rule ids exempt from the fixture requirement — registry rules a fixture cannot express. */
-    selfTestSkip?: string[];
-    /** Defaults to process.argv.slice(2). Injectable so tests need no argv games. */
-    argv?: string[];
-    /** Defaults to process.exit. Injectable so tests can assert the code. */
-    exit?: (code: number) => never;
-}
-export declare const run: (options: RunOptions) => Promise<void>;