@hublo/sentinel 1.1.7 → 1.2.0-alpha.1

package/dist/chunk-XVDOQ3G3.js

@@ -0,0 +1,39 @@
+// src/roles/build/presets/requirements.json
+var requirements_default = {
+  svelte: {
+    why: "sentinel ships Vite 8, and @sveltejs/vite-plugin-svelte caps at Vite 6 until its major 7",
+    requires: {
+      "@sveltejs/vite-plugin-svelte": "7.0.0",
+      svelte: "5.46.4"
+    }
+  }
+};
+
+// src/roles/build/presets/shared.json
+var shared_default = {
+  target: "chrome89",
+  allowedHosts: [".hubpreprod.com", ".playground-hublo.com"],
+  publicAssets: [
+    {
+      dir: "public/branding",
+      baseURL: "/branding",
+      maxAge: 31536e3
+    }
+  ]
+};
+
+// src/roles/build/preset-data.ts
+var REACT_APP_DEFAULTS = shared_default;
+var REQUIREMENTS = requirements_default;
+
+// src/shared/deep-merge.ts
+function isPlainObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+export {
+  REACT_APP_DEFAULTS,
+  REQUIREMENTS,
+  isPlainObject
+};
+//# sourceMappingURL=chunk-XVDOQ3G3.js.map

package/dist/index.d.ts

@@ -19,7 +19,7 @@ declare function registerAdapters(): void;
 declare const VERBS: readonly ["run", "inspect", "init", "migrate", "report", "status"];
 type Verb = (typeof VERBS)[number];
 /** Targets: the kind of check. The CLI `--<target>` flags map 1:1 to these. */
-declare const TARGETS: readonly ["lint", "format", "typescript", "build", "test", "static-analysis", "runtime-analysis", "arch"];
+declare const TARGETS: readonly ["lint", "format", "typescript", "build", "dev", "test", "static-analysis", "runtime-analysis", "arch"];
 type Target = (typeof TARGETS)[number];
 /** Presets: the stack preset a project resolves to (strict by default). */
 declare const PRESET_NAMES: readonly ["react", "nest", "svelte", "node", "tools"];

package/dist/index.js

@@ -7,7 +7,8 @@ import {
   registerAdapters,
   resolve,
   setDefaultRunner
-} from "./chunk-W73ISYMG.js";
+} from "./chunk-FLJ2QNFF.js";
+import "./chunk-XVDOQ3G3.js";
 export {
   BaseAdapter,
   all,

package/dist/roles/build/react-app.d.ts

@@ -0,0 +1,112 @@
+import { PluginOption, UserConfig } from 'vite';
+export { defineConfig, loadEnv } from 'vite';
+
+/** The convention values, in one place so `--inspect` can report what an app departs from. */
+declare const REACT_APP_DEFAULTS: {
+    target: string;
+    allowedHosts: string[];
+    publicAssets: {
+        dir: string;
+        baseURL: string;
+        maxAge: number;
+    }[];
+};
+
+/** Where the router's routes live and where it writes its generated tree. */
+interface RouterPaths {
+    routesDirectory: string;
+    generatedRouteTree: string;
+    /** Extra lines appended to the generated tree. Two of the three apps use it. */
+    routeTreeFileFooter?: string[];
+}
+/**
+ * The TanStack factories, supplied by the app.
+ *
+ * Typed loosely on purpose: sentinel decides WHEN to call them and with what, and has no
+ * business asserting their return shape. Narrowing this would only couple sentinel to a
+ * version of a package it does not own.
+ */
+interface TanstackFactories {
+    start: (options: {
+        router: RouterPaths;
+    }) => PluginOption[];
+    router: (options: RouterPaths & {
+        target: string;
+        autoCodeSplitting: boolean;
+    }) => PluginOption;
+}
+/** Everything an app declares. */
+interface ReactAppOptions {
+    /** The app's own directory. Always `__dirname`. */
+    root: string;
+    /** Vite's `mode`, from the config callback. */
+    mode: string;
+    /** Served under, e.g. `/console/`. */
+    base: string;
+    /** Dev server port. */
+    port: number;
+    /** HMR port. Explicit, NOT `port + 1`: career goes DOWN to 9998 where the others go up. */
+    hmrPort: number;
+    router: RouterPaths;
+    tanstack: TanstackFactories;
+    /**
+     * Sourcemaps: a boolean, however the app decided it.
+     *
+     * The three apps disagree on how — two use a mode allowlist, one reads an env var. That is
+     * an inconsistency in the repo rather than a requirement, and encoding both would make
+     * sentinel the owner of a decision it should not hold.
+     */
+    sourcemap?: boolean;
+    /** Passed through verbatim, never read. See the note above. */
+    alias?: unknown[];
+    /** The app's own plugins (branding, babel). Appended AFTER the base set. */
+    plugins?: PluginOption[];
+    /** Conventions the app may override. */
+    target?: string;
+    allowedHosts?: string[];
+    /**
+     * Anything else this app needs, merged over the preset LAST.
+     *
+     * The preset is a starting point, not a cage. Two things an app must be able to do and
+     * could not before: override a NESTED attribute without losing its siblings, and add an
+     * attribute the preset knows nothing about.
+     *
+     * Objects merge, everything else replaces — see `merge-config` for why arrays replace
+     * rather than concatenate. Whatever lands here is reported by `--inspect --build`, so an
+     * override is a visible, countable decision instead of something found by reading a config.
+     *
+     * Real cases today: console needs `ssr`, `optimizeDeps` and `preview`; career needs
+     * `css.preprocessorOptions` for Sass; all three need their own `nitro.publicAssets`.
+     */
+    overrides?: Record<string, unknown>;
+}
+
+/**
+ * The environment, loaded the way all three apps already load it.
+ *
+ * `production` is normalised to `prd` because that is this repository's deployment tag: it is
+ * the `.env.prd` the build reads and the SSM path segment the values come from. Not a
+ * preference, a fact about the repo — which is exactly why it belongs in the preset rather
+ * than being retyped in every config.
+ */
+declare function appEnv(root: string, mode: string): Record<string, string>;
+/** True when this run is a test rather than a real build. */
+declare function isTestMode(mode: string, env?: NodeJS.ProcessEnv): boolean;
+/**
+ * The plugin names in the order they run, which is what `--inspect` reports.
+ *
+ * `extras` is how many plugins the app appends of its own; they are named positionally
+ * because sentinel has no way to name a function someone else passed in.
+ */
+declare function pluginPlan(isTest: boolean, extras?: number): string[];
+/**
+ * The Vite config for a React app, minus the plugins.
+ *
+ * Pure and separately testable: everything here is data in, data out, so the composition
+ * rules can be asserted without a bundler anywhere near the test.
+ */
+declare function reactAppConfig(options: ReactAppOptions): Omit<UserConfig, 'plugins'>;
+/** The config an app spreads into `defineConfig`. */
+declare function reactApp(options: ReactAppOptions): UserConfig;
+
+export { REACT_APP_DEFAULTS, type ReactAppOptions, type RouterPaths, type TanstackFactories, appEnv, isTestMode, pluginPlan, reactApp, reactAppConfig };

package/dist/roles/build/react-app.js

@@ -0,0 +1,126 @@
+import {
+  REACT_APP_DEFAULTS,
+  isPlainObject
+} from "../../chunk-XVDOQ3G3.js";
+
+// src/roles/build/react-app.ts
+import tailwindcss from "@tailwindcss/vite";
+import react from "@vitejs/plugin-react";
+import { nitro } from "nitro/vite";
+import { loadEnv } from "vite";
+import svgr from "vite-plugin-svgr";
+
+// src/roles/build/merge-config.ts
+function mergeConfig(base, overrides) {
+  if (!overrides) return base;
+  const out = { ...base };
+  for (const [key, value] of Object.entries(overrides)) {
+    if (value === void 0) {
+      delete out[key];
+      continue;
+    }
+    const current = out[key];
+    out[key] = isPlainObject(current) && isPlainObject(value) ? mergeConfig(current, value) : value;
+  }
+  return out;
+}
+
+// src/roles/build/react-app.ts
+import { defineConfig, loadEnv as loadEnv2 } from "vite";
+function appEnv(root, mode) {
+  return loadEnv(mode === "production" ? "prd" : mode, root, "");
+}
+function isTestMode(mode, env = process.env) {
+  return mode === "test" || env.VITEST === "true";
+}
+function pluginEntries(options, isTest) {
+  const { tanstack, router } = options;
+  return [
+    { name: "tailwindcss", build: () => tailwindcss() },
+    ...isTest ? [
+      {
+        name: "tanstackRouter",
+        build: () => tanstack.router({ ...router, target: "react", autoCodeSplitting: true })
+      }
+    ] : [
+      { name: "tanstackStart", build: () => tanstack.start({ router }) },
+      { name: "nitro", build: () => nitro() }
+    ],
+    { name: "react", build: () => react() },
+    { name: "svgr", build: () => svgr() }
+  ];
+}
+function pluginPlan(isTest, extras = 0) {
+  const entries = pluginEntries(
+    { tanstack: { start: () => [], router: () => null }, router: STUB_ROUTER },
+    isTest
+  );
+  return [
+    ...entries.map((entry) => entry.name),
+    ...Array.from({ length: extras }, (_, at) => `app:${at}`)
+  ];
+}
+var STUB_ROUTER = { routesDirectory: "", generatedRouteTree: "" };
+function basePlugins(options, isTest) {
+  return [
+    ...pluginEntries(options, isTest).flatMap((entry) => entry.build()),
+    ...options.plugins ?? []
+  ];
+}
+function reactAppConfig(options) {
+  const preset = {
+    base: options.base,
+    root: options.root,
+    define: {
+      // Development only. In a build this would leak a browser global into SSR output.
+      ...options.mode === "development" ? { global: "window" } : {}
+    },
+    server: {
+      port: options.port,
+      allowedHosts: options.allowedHosts ?? [...REACT_APP_DEFAULTS.allowedHosts],
+      hmr: { host: "localhost", protocol: "ws", port: options.hmrPort }
+    },
+    build: {
+      target: options.target ?? REACT_APP_DEFAULTS.target,
+      sourcemap: options.sourcemap ?? false
+    },
+    /*
+     * Nitro's two settings are sentinel's, and both were measured across the three apps rather
+     * than assumed.
+     *
+     * `baseURL` is always the app's `base`, without exception: `/console/`, `/` and `/admin/`.
+     * It is derived, so an app cannot get them out of step.
+     *
+     * `publicAssets` is byte-identical in all three — the branding directory, its URL and a
+     * one-year max-age. That is a convention about where branding lives, not data about an
+     * app, and it was sitting in three `overrides` blocks saying the same thing.
+     *
+     * An app that needs MORE from nitro overrides the key: career adds `externals` to keep the
+     * SSR sanitisation chain out of the server bundle. `mergeConfig` merges objects, so adding
+     * one key does not take these two away.
+     */
+    nitro: {
+      baseURL: options.base,
+      publicAssets: [...REACT_APP_DEFAULTS.publicAssets]
+    },
+    ...options.alias ? { resolve: { alias: options.alias } } : {}
+  };
+  return mergeConfig(preset, options.overrides);
+}
+function reactApp(options) {
+  return {
+    ...reactAppConfig(options),
+    plugins: basePlugins(options, isTestMode(options.mode))
+  };
+}
+export {
+  REACT_APP_DEFAULTS,
+  appEnv,
+  defineConfig,
+  isTestMode,
+  loadEnv2 as loadEnv,
+  pluginPlan,
+  reactApp,
+  reactAppConfig
+};
+//# sourceMappingURL=react-app.js.map

package/lint/nest.json

@@ -0,0 +1,358 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": [
+    "typescript",
+    "jest",
+    "import",
+    "unicorn",
+    "oxc",
+    "node"
+  ],
+  "categories": {
+    "correctness": "off",
+    "suspicious": "off",
+    "pedantic": "off",
+    "perf": "off",
+    "style": "off",
+    "restriction": "off",
+    "nursery": "off"
+  },
+  "rules": {
+    "no-var": "error",
+    "prefer-const": [
+      "error",
+      {
+        "destructuring": "any",
+        "ignoreReadBeforeAssign": false
+      }
+    ],
+    "prefer-rest-params": "error",
+    "prefer-spread": "error",
+    "typescript/ban-ts-comment": "error",
+    "typescript/no-array-constructor": "error",
+    "typescript/no-duplicate-enum-values": "error",
+    "typescript/no-empty-object-type": "error",
+    "typescript/no-extra-non-null-assertion": "error",
+    "typescript/no-misused-new": "error",
+    "typescript/no-namespace": "error",
+    "typescript/no-non-null-asserted-optional-chain": "error",
+    "typescript/no-this-alias": "error",
+    "typescript/no-unnecessary-type-constraint": "error",
+    "typescript/no-unsafe-declaration-merging": "error",
+    "typescript/no-unsafe-function-type": "error",
+    "typescript/no-unused-expressions": [
+      "error",
+      {
+        "allowShortCircuit": false,
+        "allowTaggedTemplates": false,
+        "allowTernary": false
+      }
+    ],
+    "typescript/no-wrapper-object-types": "error",
+    "typescript/prefer-as-const": "error",
+    "typescript/prefer-namespace-keyword": "error",
+    "typescript/triple-slash-reference": "error",
+    "array-callback-return": [
+      "error",
+      {
+        "allowImplicit": false,
+        "checkForEach": false,
+        "allowVoid": false
+      }
+    ],
+    "complexity": [
+      "error",
+      30
+    ],
+    "curly": [
+      "error",
+      "all"
+    ],
+    "dot-notation": [
+      "error",
+      {
+        "allowKeywords": true,
+        "allowPattern": ""
+      }
+    ],
+    "eqeqeq": "warn",
+    "for-direction": "error",
+    "func-style": [
+      "warn",
+      "expression",
+      {
+        "allowArrowFunctions": false,
+        "allowTypeAnnotation": false,
+        "overrides": {}
+      }
+    ],
+    "import/no-duplicates": [
+      "error",
+      {
+        "considerQueryString": true,
+        "prefer-inline": true
+      }
+    ],
+    "jest/expect-expect": "warn",
+    "jest/no-alias-methods": "error",
+    "jest/no-commented-out-tests": "warn",
+    "jest/no-deprecated-functions": "error",
+    "jest/no-disabled-tests": "warn",
+    "jest/no-done-callback": "error",
+    "jest/no-export": "error",
+    "jest/no-focused-tests": "error",
+    "jest/no-identical-title": "error",
+    "jest/no-interpolation-in-snapshots": "error",
+    "jest/no-jasmine-globals": "error",
+    "jest/no-mocks-import": "error",
+    "jest/no-standalone-expect": "error",
+    "jest/no-test-prefixes": "error",
+    "jest/prefer-to-be": "error",
+    "jest/prefer-to-contain": "error",
+    "jest/prefer-to-have-length": "error",
+    "jest/valid-describe-callback": "error",
+    "jest/valid-expect": "warn",
+    "jest/valid-expect-in-promise": "error",
+    "jest/valid-title": "error",
+    "no-async-promise-executor": "error",
+    "no-case-declarations": "error",
+    "no-compare-neg-zero": "error",
+    "no-cond-assign": [
+      "error",
+      "except-parens"
+    ],
+    "no-console": [
+      "warn",
+      {
+        "allow": [
+          "warn",
+          "error"
+        ]
+      }
+    ],
+    "no-constant-binary-expression": "error",
+    "no-constant-condition": [
+      "error",
+      {
+        "checkLoops": "allExceptWhileTrue"
+      }
+    ],
+    "no-control-regex": "off",
+    "no-debugger": "error",
+    "no-delete-var": "error",
+    "no-dupe-else-if": "error",
+    "no-dupe-keys": "error",
+    "no-duplicate-case": "error",
+    "no-else-return": [
+      "error",
+      {
+        "allowElseIf": true
+      }
+    ],
+    "no-empty": [
+      "error",
+      {
+        "allowEmptyCatch": false
+      }
+    ],
+    "no-empty-character-class": "error",
+    "no-empty-pattern": [
+      "error",
+      {
+        "allowObjectPatternsAsParameters": false
+      }
+    ],
+    "no-empty-static-block": "error",
+    "no-ex-assign": "error",
+    "no-extra-boolean-cast": [
+      "error",
+      {}
+    ],
+    "no-fallthrough": [
+      "error",
+      {
+        "allowEmptyCase": false,
+        "reportUnusedFallthroughComment": false
+      }
+    ],
+    "no-global-assign": [
+      "error",
+      {
+        "exceptions": []
+      }
+    ],
+    "no-implicit-coercion": [
+      "error",
+      {
+        "allow": [],
+        "boolean": true,
+        "disallowTemplateShorthand": false,
+        "number": true,
+        "string": true
+      }
+    ],
+    "no-invalid-regexp": [
+      "error",
+      {}
+    ],
+    "no-irregular-whitespace": [
+      "error",
+      {
+        "skipComments": false,
+        "skipJSXText": false,
+        "skipRegExps": false,
+        "skipStrings": true,
+        "skipTemplates": false
+      }
+    ],
+    "no-lonely-if": "error",
+    "no-loss-of-precision": "error",
+    "no-misleading-character-class": "error",
+    "no-nonoctal-decimal-escape": "error",
+    "no-prototype-builtins": "error",
+    "no-regex-spaces": "error",
+    "no-restricted-imports": [
+      "error",
+      {
+        "paths": [
+          {
+            "name": "@front/theme",
+            "importNames": [
+              "hubloTheme",
+              "legacyHubloTheme",
+              "customCommonColors",
+              "customPalette",
+              "breakpointsOptions",
+              "breakpointsValues",
+              "spacingConstants"
+            ],
+            "message": "Use the MUI theme context or the public providers exposed by @front/theme."
+          }
+        ],
+        "patterns": [
+          {
+            "group": [
+              "@front/theme/*",
+              "!@front/theme/testing"
+            ],
+            "message": "Deep imports from @front/theme are forbidden outside the theme lib."
+          }
+        ]
+      }
+    ],
+    "no-self-assign": [
+      "error",
+      {
+        "props": true
+      }
+    ],
+    "no-shadow-restricted-names": [
+      "error",
+      {
+        "reportGlobalThis": false
+      }
+    ],
+    "no-sparse-arrays": "error",
+    "no-unneeded-ternary": [
+      "error",
+      {
+        "defaultAssignment": true
+      }
+    ],
+    "no-unsafe-finally": "error",
+    "no-unsafe-optional-chaining": [
+      "warn",
+      {
+        "disallowArithmeticOperators": false
+      }
+    ],
+    "no-unused-labels": "error",
+    "no-unused-private-class-members": "error",
+    "no-useless-backreference": "error",
+    "no-useless-catch": "error",
+    "no-useless-escape": [
+      "error",
+      {
+        "allowRegexCharacters": []
+      }
+    ],
+    "no-useless-return": "error",
+    "nx/enforce-module-boundaries": [
+      "error",
+      {
+        "enforceBuildableLibDependency": true,
+        "allow": [],
+        "depConstraints": [
+          {
+            "sourceTag": "*",
+            "onlyDependOnLibsWithTags": [
+              "*"
+            ]
+          }
+        ]
+      }
+    ],
+    "prefer-arrow-callback": [
+      "error",
+      {
+        "allowNamedFunctions": false,
+        "allowUnboundThis": true
+      }
+    ],
+    "require-yield": "error",
+    "typescript/await-thenable": "error",
+    "typescript/no-confusing-non-null-assertion": "error",
+    "typescript/no-empty-function": [
+      "warn",
+      {
+        "allow": []
+      }
+    ],
+    "typescript/no-explicit-any": "error",
+    "typescript/no-floating-promises": [
+      "error",
+      {
+        "ignoreVoid": true
+      }
+    ],
+    "typescript/no-import-type-side-effects": "error",
+    "typescript/no-inferrable-types": "error",
+    "typescript/no-non-null-assertion": "error",
+    "typescript/no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_",
+        "caughtErrors": "none"
+      }
+    ],
+    "typescript/return-await": [
+      "warn",
+      "in-try-catch"
+    ],
+    "typescript/switch-exhaustiveness-check": [
+      "error",
+      {
+        "considerDefaultExhaustiveForUnions": true
+      }
+    ],
+    "use-isnan": [
+      "error",
+      {
+        "enforceForIndexOf": false,
+        "enforceForSwitchCase": true
+      }
+    ],
+    "valid-typeof": [
+      "error",
+      {
+        "requireStringLiterals": false
+      }
+    ]
+  },
+  "jsPlugins": [
+    {
+      "name": "nx",
+      "specifier": "@nx/eslint-plugin"
+    }
+  ]
+}