@hublo/sentinel 1.5.1-alpha.2 → 1.6.0-alpha.1

package/dist/{chunk-WBDBRGLV.js → chunk-7E6YTTAK.js}

@@ -13,15 +13,19 @@ var TARGETS = [
   "dev",
   "test",
   "static-analysis",
+  "env",
   "runtime-analysis",
   "arch"
 ];
+var REPOSITORY_TARGETS = ["env"];
 var LONG_RUNNING_TARGETS = ["dev"];
 var SWEEPABLE_TARGETS = TARGETS.filter(
   (target) => !LONG_RUNNING_TARGETS.includes(target)
 );
 var PRESET_NAMES = ["react", "nest", "svelte", "node", "tools"];
 var OUTPUT_SHAPES = ["console", "json", "html", "markdown"];
+var ENV_LEVELS = ["info", "warning", "error"];
+var DEFAULT_ENV_LEVEL = "warning";
 
 // src/roles/static-analysis/presets/shared.json
 var shared_default = {
@@ -197,10 +201,13 @@ function defineStaticAnalysis(input = {}) {
 export {
   VERBS,
   TARGETS,
+  REPOSITORY_TARGETS,
   LONG_RUNNING_TARGETS,
   SWEEPABLE_TARGETS,
   PRESET_NAMES,
   OUTPUT_SHAPES,
+  ENV_LEVELS,
+  DEFAULT_ENV_LEVEL,
   isPlainObject,
   REPORT_DIR,
   TARGET,
@@ -211,4 +218,4 @@ export {
   overridableSettings,
   defineStaticAnalysis
 };
-//# sourceMappingURL=chunk-WBDBRGLV.js.map
+//# sourceMappingURL=chunk-7E6YTTAK.js.map

package/dist/chunk-7E6YTTAK.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/shared/deep-merge.ts","../src/core/domain.ts","../src/roles/static-analysis/presets/shared.json","../src/roles/static-analysis/preset-data.ts","../src/roles/static-analysis/configs/define.ts"],"sourcesContent":["/**\n * Is this a plain JSON object?\n *\n * The file is named for a `deepMerge` that no longer exists. It was written when the engine\n * merged JSON in memory and wrote the result; that approach was replaced by editing the\n * document IN PLACE with jsonc-parser, so a project's comments, key order and formatting\n * survive a `merge-json` op. Nothing has called `deepMerge` since, except its own recursion,\n * so it went.\n *\n * What remains is the predicate the in-place merge still needs, to decide whether a value is\n * a branch to walk into or a leaf to set.\n */\n\n/** True for a mergeable plain object (not null, not an array). */\nexport function isPlainObject(value: unknown): value is Record<string, unknown> {\n  return typeof value === 'object' && value !== null && !Array.isArray(value)\n}\n","/**\n * The domain vocabulary: the fixed sets of verbs, targets, and presets, and the\n * types derived from them. This is the model, and the extension point: adding a\n * verb / target / preset is a one-line edit to a list here, and because the types\n * are DERIVED (`(typeof LIST)[number]`), the compiler forces every switch/handler\n * to cover the new member.\n *\n * Tunable behaviour (defaults, detection signals, marker filenames) lives in\n * `settings.ts`, not here.\n */\n\n/**\n * Verbs: what to do.\n *\n * The axis is not \"who runs it\" but **what survives the run**, which is the distinction that\n * outlives any sharing of the work:\n *\n * | verb | writes | what remains |\n * | --- | --- | --- |\n * | `init` | a module's config + the workspace prep it needs | the module's new state, that IS the deliverable |\n * | `migrate` | changes an already-initialized setup | same; reserved, not wired yet |\n * | `validate` | instrumentation, if it needs any | **nothing**, the project returns to what it was |\n * | `run` / `inspect` / `report` / `status` | nothing | they execute or introspect |\n *\n * `validate` is the one that judges. Héla, 2026-09-25: it does not carry the migration's\n * strictness, so it MAY write into the project under validation, a `data-testid` to make something\n * addressable for instance, provided it takes it back out. That freedom is what makes its\n * dependability the thing to design: idempotent, reversible on error, recoverable after a kill,\n * and never silent about instrumentation it failed to remove.\n */\nexport const VERBS = ['run', 'inspect', 'init', 'migrate', 'validate', 'report', 'status'] as const\nexport type Verb = (typeof VERBS)[number]\n\n/** Targets: the kind of check. The CLI `--<target>` flags map 1:1 to these. */\nexport const TARGETS = [\n  'lint',\n  'format',\n  'typescript',\n  'build',\n  'dev',\n  'test',\n  'static-analysis',\n  'env',\n  'runtime-analysis',\n  'arch',\n] as const\nexport type Target = (typeof TARGETS)[number]\n\n/**\n * Targets that check the REPOSITORY, not a module, and therefore run once, at its root.\n *\n * Every other target is a question about one module, so the engine asks it per module. `env` is a\n * question about the repository as a whole: which env files git tracks, which contract declares a\n * variable the code reads in another app, whether a Dockerfile copies a path that exists. Asked per\n * module, it would scan the same tree 441 times on the monorepo and report every finding 441 times,\n * and in a repository that is not an nx workspace there are no modules to ask at all.\n *\n * So the location rule is different, and it is the only difference:\n *\n * - it runs from the repository ROOT, the git top-level, found by git and never by nx;\n * - a sweep (`sentinel --run`) includes it once, and only when run from that root, so a sweep inside\n *   a module stays about the module and its output does not change;\n * - named from anywhere else, it is REFUSED with the root's path, rather than scoped to a\n *   subdirectory: a contract in one app and a reader in another is exactly the finding a scoped\n *   scan cannot see, so a scoped report would be a smaller report that looks like a clean one.\n *\n * It answers `--run` only. It writes no config, so it has nothing to `--init`, `--inspect` or\n * `--validate`, and those verbs never sweep it.\n */\nexport const REPOSITORY_TARGETS: readonly Target[] = ['env']\n\n/**\n * Targets that do not TERMINATE, and are therefore never swept.\n *\n * Every other target is a check: it runs, it answers, it exits. `dev` starts a server and\n * stays up until someone stops it. That difference matters exactly once, and it matters a lot:\n * `sentinel --run` with no named target means \"every wired target\", so without this a sweep\n * would launch a dev server per module and never come back — on a 441-module workspace, from a\n * command whose whole purpose is to answer a question.\n *\n * So a long-running target is reachable only when NAMED. `sentinel --run --dev` starts the\n * server; `sentinel --run` never does.\n *\n * It is a target rather than a flag on `--build` because it is the app's second invocation of\n * the same toolchain: `build` stopped calling `vite build` directly, and `serve` still called\n * `vite` directly. Same migration, same tool, one script left behind.\n */\nexport const LONG_RUNNING_TARGETS: readonly Target[] = ['dev']\n\n/** The targets an unqualified `--run` / `--all` covers: everything that terminates. */\nexport const SWEEPABLE_TARGETS: readonly Target[] = TARGETS.filter(\n  (target) => !LONG_RUNNING_TARGETS.includes(target),\n)\n\n/** Presets: the stack preset a project resolves to (strict by default). */\nexport const PRESET_NAMES = ['react', 'nest', 'svelte', 'node', 'tools'] as const\nexport type PresetName = (typeof PRESET_NAMES)[number]\n\n/**\n * The shapes `--output` can ask a report-writing role for. `console` writes nothing to disk.\n *\n * ⛔ Here rather than in the role that happens to implement them today, for the same reason\n * `PRESET_NAMES` is here: `--output` is a GLOBAL flag, so the CLI has to validate it before any\n * role is chosen. It used to be validated inside the static-analysis adapter, which runs on\n * `--run` only, and the measured consequence was that `--inspect`, `--status` and `--init`\n * accepted `--output xml` silently and exited 0. A flag that is refused by one verb out of four\n * is worse than one that is never refused: it teaches you it was checked.\n */\nexport const OUTPUT_SHAPES = ['console', 'json', 'html', 'markdown'] as const\nexport type OutputShape = (typeof OUTPUT_SHAPES)[number]\n\n/**\n * What the env role does with what it finds, from `SENTINEL_ENV_LEVEL`.\n *\n * | level | reports | in GitHub Actions | exit |\n * | --- | --- | --- | --- |\n * | `info` | yes | nothing more | 0 |\n * | `warning`, the default | yes | a `::warning` annotation per finding | 0 |\n * | `error` | yes | `::error` on a blocking finding, `::warning` on the rest | 1 on a blocking finding |\n *\n * An environment variable and not a flag, because the same command runs in a developer's shell and\n * in every repository's CI, and what changes between them is the policy, not the command: a team\n * moves from `warning` to `error` by setting one variable in its workflow, without editing the step.\n *\n * ⛔ Here and not in the role for the reason `OUTPUT_SHAPES` is: it is read and VALIDATED at the CLI\n * edge, once, before any role runs, and handed to the role as data. A role that read the\n * environment itself would be the one place in this package whose behaviour a test cannot pin by\n * its inputs.\n */\nexport const ENV_LEVELS = ['info', 'warning', 'error'] as const\nexport type EnvLevel = (typeof ENV_LEVELS)[number]\nexport const DEFAULT_ENV_LEVEL: EnvLevel = 'warning'\n\n/**\n * The outcome of one module × target check. `unsupported` is a distinct third state\n * (a requested target has no adapter yet): it must never read as a pass, and an\n * explicitly-requested unsupported target is a usage error (non-zero exit), while an\n * unsupported target swept in by `--all` is just skipped and shown.\n */\nexport type ResultStatus = 'ok' | 'failed' | 'unsupported'\n\n/**\n * @deprecated Renamed to `PresetName`. Kept so an existing `import type { Flavour }` keeps\n * compiling: the CLI kept `--flavour` working for the same reason, and breaking the type\n * while sparing the flag would be an odd place to draw the line.\n */\nexport type Flavour = PresetName\n","{\n  \"entry\": [\n    \"**/*.integration-spec.ts\",\n    \"**/*.steps.ts\",\n    \"src/client.tsx\",\n    \"src/start.ts\",\n    \"src/router.tsx\",\n    \"src/RouterContext.tsx\"\n  ],\n  \"ignore\": [\n    \"**/node_modules/**\",\n    \"**/dist/**\",\n    \"**/build/**\",\n    \"**/coverage/**\",\n    \"**/.next/**\",\n    \"**/__mocks__/**\",\n    \"**/mocks/**\",\n    \"**/_mock_/**\",\n    \"**/**Mock**/**\",\n    \"**/__fixtures__/**\",\n    \"**/fixtures/**\",\n    \"**/public/**\",\n    \"**/.husky/**\",\n    \"**/.vscode/**\",\n    \"**/.idea/**\",\n    \"**/.github/**\",\n    \"**/*.d.ts\",\n    \"**/*.gen.ts\",\n    \"**/*.generated.ts\"\n  ],\n  \"languages\": [\"javascript\", \"typescript\", \"jsx\", \"tsx\", \"css\", \"scss\"],\n  \"journeys\": {},\n  \"duplication\": {\n    \"minTokens\": 50,\n    \"minLines\": 5,\n    \"kinds\": [\"exact\"],\n    \"tests\": [\n      \"*.{test,spec,steps,e2e-spec,integration-spec,stories}.{ts,tsx,js,jsx}\",\n      \"*.{msw,mock,test-data}.{ts,tsx,js,jsx}\",\n      \"{tests,__tests__,test,testing,stubs}/**/*.{ts,tsx,js,jsx}\"\n    ]\n  },\n  \"deadCode\": {\n    \"minConfidence\": 60,\n    \"categories\": [\"unused-file\", \"unused-export\", \"unused-symbol\", \"unused-import\"]\n  },\n  \"graph\": {\n    \"resolution\": 1\n  },\n  \"tools\": {\n    \"jscpd\": {}\n  }\n}\n","/**\n * The static analysis preset: the role's settings, as data.\n *\n * One shared layer and no per-stack preset yet, because nothing measured so far varies by stack:\n * duplication, dead code and complexity are the same questions in Nest and in React. The split\n * that is already foreseen is `LCOM4`, which is meaningless on a functional front end and real on\n * nest's 16 568 classes; when it arrives it becomes `nest.json` beside this layer, which is why\n * the values live here as JSON rather than inline in the code.\n *\n * ## Why these values are the role's and not the module's\n *\n * A team declares FACTS about its own domain (which journeys exist, which files are entry points);\n * it does not declare the values a number is judged by. Two files with the same measurement\n * getting different verdicts in two modules would make every figure incomparable, and the first\n * thing this role has to be able to say is that a number means the same thing everywhere.\n *\n * That is a default, not a wall: a module CAN move any of them (see `configs/define.ts`), and when\n * it does the report prints `(module)` next to the value. The seam exists from the first commit\n * because retrofitting one later means rewriting every module's file.\n *\n * ⛔ There are no thresholds here, and their absence is a decision rather than an omission.\n *\n * A threshold was written first, at 5% of duplicated lines, and then removed. Measured over all 228\n * nx projects: 5% flags 65 of the 201 measurable modules, a third of the repository, and moving the\n * figure until the count felt manageable is not calibration, it is fitting the instrument to the\n * answer. Calibration is legitimate when a bench is polluted and the noise is removed, or when the\n * reference frame changes; neither applies to a share of duplicated lines.\n *\n * And there is nothing to calibrate AGAINST: of the sources in `docs/static-analysis-study.md`\n * section 5, NDepend, Lattix, ArchUnit, CodeScene and Arcan, none publishes a threshold for\n * duplicated lines. One invented here would travel as if it were published.\n *\n * So the role reports the measurement. What makes a single figure readable is the distribution it\n * sits in, which only a workspace-wide run can know, so that belongs to the sweep and to the\n * migration page, not to a module's own report. The first defensible warning will not be an absolute\n * number either: a module that got WORSE than its own previous measurement is a signal that needs no\n * invented bar, which is what a baseline gives, and that was already deferred for its own reasons.\n *\n * ## Where each value comes from, so nobody has to guess later\n *\n *  - `entry` is the single most consequential line in the file. Measured on\n *    `apps/nest/microservices/network` with jscpd 5.4.0: with nothing declared the dead-code pass\n *    reports **33.4%** of lines dead (79 657 lines, 232 files, 13 entry points); with these two\n *    patterns declared it reports **1.0%** (2 462 lines, 207 entry points). The cause is a naming\n *    convention and not a bug: our integration tests are `foo.integration-spec.ts` with a HYPHEN,\n *    so they do not end in `.spec.ts` and the tool's own test-file detection never sees them, and\n *    the 115 `.steps.ts` BDD definitions are tests by no convention it knows. A module ADDS to\n *    this list rather than replacing it, precisely so no team can lose these two by declaring a\n *    third.\n *\n *    ⭐ The four `src/` files are the FRONT bootstrap, and they are the most consequential thing\n *    measured on this pass. The tool recognises around fifty frameworks and TanStack Start is not\n *    one of them, so nothing in the repository imports these files: the framework finds them by\n *    convention at build time. Measured without them declared, `apps/front/console` reports\n *    `src/client.tsx`, `src/router.tsx` and `src/start.ts` among its 5 dead files, which are its\n *    hydration entry, its router factory and its Start config. `host-admin` reports `client.tsx`\n *    too and `career` reports `router.tsx` and `RouterContext.tsx`. Three of console's five\n *    findings were its own bootstrap, and the first team to see that stops trusting the tool on\n *    the spot. They exist in 2 to 3 front apps each.\n *\n *    ⛔ `scripts/**` is deliberately NOT here, although 8 modules have one and\n *    `apps/nest/microservices/contract` reports two `scripts/e2e-*.ts` as dead. No `package.json`\n *    script invokes them, so whether they run at all is a fact only the team holds. Declaring them\n *    would hide a finding that may well be true, and that is the opposite of this role's job.\n *\n *  - `languages` is this role's name for what the tool calls `format`, a word that already names\n *    another sentinel role and means something else there. Stating it has a measured cost either\n *    way: on `apps/front/console`, naming `typescript` alone scans 300 of 523 files because `.tsx`\n *    is a SEPARATE language to the tool, naming all four scans 522 (the one left out being\n *    `styles.css`), and naming nothing scans every one of its 224 languages, json and markdown\n *    included. Stylesheets are in deliberately: measured on `libs/front` they duplicate at 9.64%\n *    against 3.50% for the code, a signal that only survives because the report is broken down per\n *    language.\n *\n *  - `duplication.minTokens` and `minLines` are the detection window, and the window decides what\n *    is INVISIBLE: a fragment shorter than it is not reported at all, so a reader comparing two\n *    runs has to know both values. They are the tool's own defaults, written out rather than\n *    inherited for that reason.\n *\n *  - `duplication.kinds` is `exact` alone, and that is a correctness constraint rather than\n *    caution. Measured: with a second kind enabled, `duplicatedLines` adds up overlapping clones.\n *    Two 9-line files reported 13 duplicated lines out of 18, 72%, because an `exact` clone of\n *    lines 1-4 and a `similar` clone of lines 1-9 containing it were both counted; the real extent\n *    is 9 of 18, 50%. The tool's own answer is to cap the display at 100%, which does not make a\n *    threshold meaningful. Opening another kind therefore requires computing the share ourselves\n *    from the UNION of the line ranges.\n *\n *  - `duplication.tests` is the glob that splits the pass in two, and the split is the finding that\n *    forced it. Measured across 8 modules of the three families, **71% of all duplicated lines are\n *    between two test files**: `libs/nest/auth` reports 35.77% and its product code is at 5.96%,\n *    `apps/front/host-admin` 7.91% against 3.59%. A single blended figure is therefore mostly a\n *    measure of spec duplication wearing the name of the module's duplication, and the number\n *    travels while that nuance does not. So the role reports the two side by side, the way it\n *    already refuses to blend languages, and neither is hidden: a module whose specs carry 93% of\n *    its clones is saying something about its specs that excluding them would erase.\n *\n *    ⚠️ The two passes PARTITION the files and therefore lose a clone that spans them: a fragment\n *    shared between a test and a product file has no partner in either scan. Measured on the same\n *    8 modules, that is 42 entries of 5117, 0.8%, 650 lines. Stated in the caveat rather than\n *    silently accepted, and it is the price of the split.\n *\n *    Two patterns and not one, because a suffix convention does not cover a DIRECTORY convention,\n *    and the directory one is not a quirk: 635 files across 26 modules live under `tests/` or\n *    `__tests__/` without a name this role's suffixes recognise, `apps/nest/microservices/recruitment`\n *    alone holding 160. They are step definitions, in-memory doubles and stubs, which is test-side\n *    code by any reading. A role default rather than 26 identical overrides.\n *\n *    ⚠️ The patterns are RELATIVE here, and the adapter prefixes and composes them, because the\n *    tool's `--pattern` takes exactly one glob. Verified on four modules that the two passes\n *    partition exactly: console 479 + 87 = 566, contract 399 + 151 = 550, backends-for-frontends/admin\n *    2062 + 773 = 2835, recruitment 936 + 621 = 1557.\n *\n *    ⚠️ And a trap that cost a wrong table before it was caught: these globs contain commas, so they\n *    survive the config FILE and are destroyed by the `-i` command-line flag, which splits on\n *    commas and cuts `{test,spec}` in half. The adapter writes a file, which is one more reason it\n *    does.\n *\n *  - `deadCode.minConfidence` is the tool's own default of 60. It scores every finding and names\n *    what lowered it (a file calling `eval`, an unrecognised decorator, a name appearing in a\n *    string literal, a file in the scan that did not parse). Measured on sentinel: 60 yields 20\n *    files, 10 exports and 22 symbols; 90 yields 18 files; 100 yields nothing.\n *\n *  - `deadCode.categories` leaves out `unused-member` deliberately: without type information\n *    `x.render()` could reach any `render` in the project, which the tool itself calls its least\n *    certain rule.\n *\n *  - `ignore` excludes generated, vendored and fixture code, which duplicates by nature and buries\n *    the clones a developer can act on. It is load-bearing rather than tidy: measured on this\n *    package, scanning the module root with no ignore list reports 18 186 files and 32 153 clones,\n *    **31 969** of them touching `node_modules`; with the list, 408 files and zero.\n *\n *  - `graph.resolution` is Louvain's, and it is 1 because that is the value the papers use and\n *    graphology's own default. It decides how large a community must be to survive, so it changes\n *    both the community count and `Q`, and graphology's documentation warns in its own words that\n *    it is finicky to tweak. `code-health-meter` ships 0.74, arrived at by trying values until the\n *    partition looked right; this role declines to do that, for the same reason it ships no\n *    duplication threshold. A module that has a reason can move it, and the report prints the\n *    value every figure was produced with.\n *\n *    ⚠️ What is NOT tunable is the random seed, and that is deliberate. Louvain is greedy, so its\n *    answer depends on the order it visits nodes, which graphology draws from `Math.random`.\n *    Measured over 20 runs per module: `console` produced 16 distinct values of `Q` and between 12\n *    and 14 communities, `recruitment` 19 distinct values spanning 0.0357. With the role's own\n *    generator all five modules produce one value. A figure that moves on its own between two runs\n *    is not a figure a team can act on, so this one is the role's and nobody's to change.\n *\n *  - `tools.jscpd` is passed to the tool verbatim, and it is **sentinel's own** escape hatch, not a\n *    module's: `defineStaticAnalysis` excludes it from what a module can override. Everything above\n *    uses OUR key names, translated on the way out, so that replacing the tool one day does not\n *    oblige a single module to edit its config file, and a module only ever knows the ROLE. This\n *    block is where that guarantee stops, which is why it stays on this side and why it is empty:\n *    the first thing to put in it would be an option a single preset needs, not a workaround.\n */\nimport { OUTPUT_SHAPES } from '../../core/domain.js'\n\nimport sharedData from './presets/shared.json'\n\n/**\n * Where the json and html reports are written, relative to the module.\n *\n * Named for the role rather than left on the tool's default `report/`, and added to `.gitignore`\n * by `--init`. Both halves matter: the format role once shipped a `lint/` directory that nothing\n * ignored, and every adopting module grew an untracked directory nobody could explain.\n */\nexport const REPORT_DIR = 'static-analysis-report'\n\n/** The target this role serves, which is also the npm script a module runs and the nx target. */\nexport const TARGET = 'static-analysis'\n\n/**\n * The output shapes `--run` can produce. `console` writes nothing to disk.\n *\n * Re-exported from `core/domain` rather than declared here: `--output` is a global CLI flag and\n * the CLI validates it before a role is chosen, so one list has to serve both. This spelling\n * stays because the role and its report read it everywhere.\n */\nexport const SHAPES = OUTPUT_SHAPES\n\n/**\n * The npm scripts a module gets: one per shape a developer runs, which is three of the four.\n *\n * Here rather than in the adapter because the REPORT needs them too, to tell a reader of the\n * console summary where the detail is, and two spellings of one script name is drift nobody\n * notices until a developer types the one that does not exist.\n */\nexport const SCRIPTS = {\n  console: TARGET,\n  json: `${TARGET}:json`,\n  html: `${TARGET}:html`,\n  // ⛔ No entry for the `markdown` shape, deliberately, and this is NOT a gap: these are the npm\n  // scripts a module gets, and markdown is the recap a workflow posts on a pull request, built\n  // from one file per affected module. A developer who wants it by hand gets the console shape,\n  // which says the same thing in less space and writes nothing. A fourth script here would be a\n  // command nobody runs, carried in 198 package.json files.\n} as const\n\n/**\n * What each language the role scans is called on disk.\n *\n * ⚠️ Two lists that MUST agree, and they were maintained separately: the role declares the\n * languages it asks the tool to scan, and the adapter declared the extensions it looks for when\n * deciding whether a module has anything to measure at all. A module that narrowed `languages`\n * would still be probed for the extensions it had removed, and a language added to the preset\n * would never reach the probe. Derived from one source now, with a test that every language maps.\n */\nconst EXTENSIONS_BY_LANGUAGE: Record<string, string[]> = {\n  javascript: ['.js', '.mjs', '.cjs'],\n  typescript: ['.ts'],\n  jsx: ['.jsx'],\n  tsx: ['.tsx'],\n  css: ['.css'],\n  scss: ['.scss'],\n}\n\n/** The file extensions of the languages given, for deciding whether a module has anything to read. */\nexport function extensionsOf(languages: readonly string[]): string[] {\n  return [...new Set(languages.flatMap((language) => EXTENSIONS_BY_LANGUAGE[language] ?? []))]\n}\n\n/** Every language the mapping knows, so a test can hold it against the preset. */\nexport const MAPPED_LANGUAGES = Object.keys(EXTENSIONS_BY_LANGUAGE)\n\nexport type StaticDefaults = {\n  entry: string[]\n  ignore: string[]\n  languages: string[]\n  journeys: Record<string, string[]>\n  duplication: { minTokens: number; minLines: number; kinds: string[]; tests: string[] }\n  deadCode: { minConfidence: number; categories: string[] }\n  graph: { resolution: number }\n  tools: { jscpd: Record<string, unknown> }\n}\n\n/** The role's settings. Read-only here; `defineStaticAnalysis` resolves a module against them. */\nexport const defaults: StaticDefaults = sharedData as StaticDefaults\n\n/**\n * Keys a module declares DIRECTLY rather than through `overrides`, and how each one combines.\n *\n * They are apart because the verb differs: these two are added to and merged, so a team cannot\n * lose what the role ships by declaring its own. Everything else replaces.\n */\nconst DECLARED: Record<string, string> = {\n  entry: 'added to the patterns the role ships, never replacing them',\n  journeys: \"merged by name with the role's\",\n}\n\n/**\n * ⛔ Not a module's to set, and the catalogue says so rather than leaving it absent: a key that is\n * simply missing from a list reads as an oversight, and someone will try it. Passing it is dropped\n * with a message, see `configs/define.ts`.\n */\nconst NOT_YOURS: Record<string, string> = {\n  tools: \"sentinel's own passthrough to the tool underneath; a module never names the vendor\",\n  // ⛔ Listed as movable until it was tried: the catalogue said \"what this module can move\" and\n  // moving it exits 1, because any kind beyond `exact` overlaps the first and the duplicated-line\n  // share then counts the same lines twice. A setting that is refused at run time belongs here,\n  // where the reason is readable, rather than in the list of things to turn.\n  'duplication.kinds': 'only `exact` is supported: any other kind overlaps it and double-counts',\n}\n\n/** A value as a reader compares it: short lists in full, long ones as a count. */\nfunction render(value: unknown): string {\n  if (Array.isArray(value)) {\n    const joined = value.join(', ')\n    return value.length <= 6 && joined.length <= 72 ? joined : `${value.length} patterns`\n  }\n  if (value && typeof value === 'object') return `${Object.keys(value).length} entries`\n  return String(value)\n}\n\n/** One documented key: its path, the role's value, and the note a reader needs. */\nexport interface OverridableSetting {\n  /** The dotted path a module writes, e.g. `duplication.minTokens`. */\n  key: string\n  /** The role's current value, rendered. */\n  value: string\n  /** How it combines, or why it is not available. */\n  note: string\n  /** Where it goes: directly in the config, inside `overrides`, or nowhere. */\n  where: 'declared' | 'overrides' | 'refused'\n}\n\n/**\n * Every setting a module can touch, DERIVED from the values rather than written beside them.\n *\n * Héla's ask, and the reason it is generated: a hand-written list is a second copy of the preset,\n * and the first setting somebody adds makes it a lie that nobody notices, because a stale comment\n * fails no test. Here a new key appears in the next module's config file on its own, with its real\n * value, and `tests/role-layout.test.ts` refuses a key that reaches none of the three groups.\n *\n * It is a snapshot: `--init` leaves an EXISTING config alone, by design, so a module that adopted\n * earlier keeps the catalogue of that day. The report is the live answer, since it prints the value\n * every figure was produced with.\n */\nexport function overridableSettings(from: StaticDefaults = defaults): OverridableSetting[] {\n  const rows: OverridableSetting[] = []\n\n  for (const [key, value] of Object.entries(from)) {\n    if (key in NOT_YOURS) {\n      rows.push({ key, value: render(value), note: NOT_YOURS[key] ?? '', where: 'refused' })\n      continue\n    }\n    if (key in DECLARED) {\n      rows.push({ key, value: render(value), note: DECLARED[key] ?? '', where: 'declared' })\n      continue\n    }\n    // A group is documented by its leaves, because `duplication` whole is not what anyone writes.\n    const leaves =\n      value && typeof value === 'object' && !Array.isArray(value)\n        ? Object.entries(value).map(([leaf, own]) => ({ key: `${key}.${leaf}`, own }))\n        : [{ key, own: value }]\n    for (const leaf of leaves) {\n      /*\n       * ⛔ A LEAF can be refused too, and this check was missing. `NOT_YOURS` holds the dotted key\n       * `duplication.kinds`, but the test above only ran on top-level keys: `duplication` is not\n       * in `NOT_YOURS`, so every one of its leaves fell through to here and the catalogue printed\n       * `duplication.kinds` under \"What this module can move\".\n       *\n       * ⚠️ A developer who followed it got exit 1 on the next run, with a message refusing the\n       * very setting the generated config had invited them to write. The test that was supposed\n       * to cover this passed because the key DID reach a group, just the wrong one.\n       */\n      if (leaf.key in NOT_YOURS) {\n        rows.push({\n          key: leaf.key,\n          value: render(leaf.own),\n          note: NOT_YOURS[leaf.key] ?? '',\n          where: 'refused',\n        })\n        continue\n      }\n      rows.push({ key: leaf.key, value: render(leaf.own), note: 'replaced', where: 'overrides' })\n    }\n  }\n\n  return rows\n}\n","/**\n * `defineStaticAnalysis`: what a module imports to declare its own static analysis settings.\n *\n * ```js\n * // static-analysis.config.mjs\n * import { defineStaticAnalysis } from '@hublo/sentinel/static-analysis'\n *\n * export default defineStaticAnalysis({\n *   root: import.meta.dirname,\n *   entry: ['**\\/*.steps.ts'],\n *   journeys: { planning: ['src/planning/**'] },\n * })\n * ```\n *\n * ## Why a function and not `{ ...baseConfig, ... }`\n *\n * A spread is SHALLOW, so a module writing `deadCode: { minConfidence: 80 }` would replace the\n * whole block and silently lose `categories`. And the flattening happens in the module's file,\n * before this package ever sees the object, so nothing here could tell \"set one key, keep the\n * rest\" from \"set one key, drop the rest\". A function receives the module's INTENT, the keys it\n * actually passed, and merges them here. Second reason: the defaults are never copied into a\n * module, so changing one reaches every module at the next release instead of leaving 108 stale\n * copies behind.\n *\n * Same shape as `reactTestConfig` in the test role, for the same reasons.\n *\n * ## Two semantics, one obvious and one deliberate\n *\n * `entry` and `journeys` are FACTS a team declares, and they ADD to what this role ships: no\n * module can lose `**\\/*.integration-spec.ts` by declaring a third pattern, which matters\n * because that one pattern is the difference between 33.4% and 1.0% of dead code on a real\n * service (see `defaults.ts`).\n *\n * `overrides` REPLACES, including those lists. It is the seam for the day a team has a real\n * reason, it is not documented anywhere a developer would meet it, and every path it sets is\n * recorded in `moved` so the report can print `(module)` next to the value. Without that trace\n * two modules stop being comparable and nobody knows. It reaches every setting EXCEPT the vendor\n * passthrough, for the reason stated on the field itself.\n */\nimport { isPlainObject } from '../../../shared/deep-merge.js'\nimport { defaults, type StaticDefaults } from '../preset-data.js'\n\ntype DeepPartial<T> = { [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K] }\n\n/** What a module's config file passes. Everything is optional, including the file itself. */\nexport interface StaticAnalysisInput {\n  /** The module's own directory, normally `import.meta.dirname`. */\n  root?: string\n  /** Files that run although nothing imports them. ADDED to the shipped patterns. */\n  entry?: string[]\n  /**\n   * Named journeys, as `{ name: [globs] }`. MERGED by name with any shipped ones.\n   *\n   * ⛔ **No pass reads this yet, and the generated config stub no longer asks for it.** It is the\n   * seam for the product axis, where a figure is reported per journey rather than per module, and\n   * that is V2 work tracked in issue #98. It stays accepted so a module that already declared one\n   * is not broken, and `--inspect` echoes it back, but nothing measures against it.\n   *\n   * It was in the stub for a while, under a comment telling every adopting team to fill it in. A\n   * team that did would have waited for a breakdown that never came and concluded their globs were\n   * wrong. Asking for something nothing consumes is worse than not offering it.\n   */\n  journeys?: Record<string, string[]>\n  /**\n   * The seam. Replaces whatever it names, and every path it sets lands in `moved`.\n   *\n   * ⛔ `tools` is excluded, and the reason is the whole point of translating the vocabulary: a\n   * module knows the ROLE, not the tool underneath it. A key named after the vendor would mean\n   * nothing to the person reading their own config file, and showing it would invite them to learn\n   * a name we are working to keep out of their world. The passthrough still exists, on sentinel's\n   * side, for a preset that needs a vendor option; a module that genuinely needs one gets a key in\n   * OUR vocabulary, which is the right friction because it goes through a review instead of\n   * spreading silently.\n   */\n  overrides?: DeepPartial<Omit<StaticDefaults, 'tools'>>\n}\n\nexport interface ResolvedStaticConfig extends StaticDefaults {\n  /** The module's directory, or null when its config file did not say. */\n  root: string | null\n  /**\n   * Dotted paths the module set through `overrides`, so the report can mark them. Sorted, so\n   * two runs on the same config produce the same report.\n   */\n  moved: string[]\n}\n\n/**\n * Merge `patch` into `base`, recursively, patch winning.\n *\n * Not the `deepMerge` this repo once had: that one existed for WRITING a module's json and was\n * replaced by an in-place jsonc edit, which is why only `isPlainObject` survived. This is the\n * read side, which has no file to preserve and only has to resolve two objects into one.\n *\n * Arrays are replaced, never concatenated. Additive behaviour is a decision about a specific\n * key, which `defineStaticAnalysis` makes explicitly for `entry`, rather than a property of the\n * merge: a merge that silently concatenates cannot express \"replace this list\", and a team\n * reaching for `overrides` is asking for exactly that.\n */\nfunction mergeInto<T>(base: T, patch: unknown): T {\n  if (!isPlainObject(patch)) return base\n  if (!isPlainObject(base)) return patch as T\n  const out: Record<string, unknown> = { ...base }\n  for (const [key, value] of Object.entries(patch)) {\n    out[key] = isPlainObject(value) ? mergeInto(out[key], value) : value\n  }\n  return out as T\n}\n\n/** Every leaf path in `patch`, dotted, so a reader can be told what the module decided. */\nfunction leafPaths(patch: unknown, prefix = ''): string[] {\n  if (!isPlainObject(patch)) return prefix ? [prefix] : []\n  return Object.entries(patch).flatMap(([key, value]) =>\n    leafPaths(value, prefix ? `${prefix}.${key}` : key),\n  )\n}\n\n/** The same list with duplicates dropped, keeping the first occurrence's order. */\nfunction unique(values: string[]): string[] {\n  return [...new Set(values)]\n}\n\n/**\n * Drop the vendor passthrough from what a module sent.\n *\n * ⚠️ Enforced here and not by the type, because the type cannot: a module's config file is `.mjs`,\n * so nothing type-checks it, and `Omit` on the input would be documentation that compiles away. A\n * `tools` key written there is dropped and NAMED on stderr rather than ignored, so a developer who\n * found the key somewhere learns why it did nothing instead of concluding the role is broken.\n */\nfunction withoutVendorKeys(overrides: unknown): unknown {\n  if (!isPlainObject(overrides) || !('tools' in overrides)) return overrides\n  const { tools: _vendor, ...rest } = overrides\n  process.stderr.write(\n    'sentinel static-analysis: ignoring `overrides.tools` from this module. The tool underneath ' +\n      \"the role is not part of a module's surface; if a setting is missing, it needs a key of \" +\n      'its own.\\n',\n  )\n  return rest\n}\n\n/** Resolve a module's declaration against this role's defaults. */\nexport function defineStaticAnalysis(input: StaticAnalysisInput = {}): ResolvedStaticConfig {\n  const declared: StaticDefaults = {\n    ...defaults,\n    entry: unique([...defaults.entry, ...(input.entry ?? [])]),\n    journeys: { ...defaults.journeys, ...(input.journeys ?? {}) },\n  }\n  const overrides = withoutVendorKeys(input.overrides)\n\n  return {\n    ...mergeInto(declared, overrides),\n    root: input.root ?? null,\n    moved: leafPaths(overrides).sort(),\n  }\n}\n"],"mappings":";AAcO,SAAS,cAAc,OAAkD;AAC9E,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;;;ACcO,IAAM,QAAQ,CAAC,OAAO,WAAW,QAAQ,WAAW,YAAY,UAAU,QAAQ;AAIlF,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAwBO,IAAM,qBAAwC,CAAC,KAAK;AAkBpD,IAAM,uBAA0C,CAAC,KAAK;AAGtD,IAAM,oBAAuC,QAAQ;AAAA,EAC1D,CAAC,WAAW,CAAC,qBAAqB,SAAS,MAAM;AACnD;AAGO,IAAM,eAAe,CAAC,SAAS,QAAQ,UAAU,QAAQ,OAAO;AAahE,IAAM,gBAAgB,CAAC,WAAW,QAAQ,QAAQ,UAAU;AAqB5D,IAAM,aAAa,CAAC,QAAQ,WAAW,OAAO;AAE9C,IAAM,oBAA8B;;;ACnI3C;AAAA,EACE,OAAS;AAAA,IACP;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EACA,QAAU;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EACA,WAAa,CAAC,cAAc,cAAc,OAAO,OAAO,OAAO,MAAM;AAAA,EACrE,UAAY,CAAC;AAAA,EACb,aAAe;AAAA,IACb,WAAa;AAAA,IACb,UAAY;AAAA,IACZ,OAAS,CAAC,OAAO;AAAA,IACjB,OAAS;AAAA,MACP;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EACA,UAAY;AAAA,IACV,eAAiB;AAAA,IACjB,YAAc,CAAC,eAAe,iBAAiB,iBAAiB,eAAe;AAAA,EACjF;AAAA,EACA,OAAS;AAAA,IACP,YAAc;AAAA,EAChB;AAAA,EACA,OAAS;AAAA,IACP,OAAS,CAAC;AAAA,EACZ;AACF;;;ACgHO,IAAM,aAAa;AAGnB,IAAM,SAAS;AASf,IAAM,SAAS;AASf,IAAM,UAAU;AAAA,EACrB,SAAS;AAAA,EACT,MAAM,GAAG,MAAM;AAAA,EACf,MAAM,GAAG,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAMjB;AAWA,IAAM,yBAAmD;AAAA,EACvD,YAAY,CAAC,OAAO,QAAQ,MAAM;AAAA,EAClC,YAAY,CAAC,KAAK;AAAA,EAClB,KAAK,CAAC,MAAM;AAAA,EACZ,KAAK,CAAC,MAAM;AAAA,EACZ,KAAK,CAAC,MAAM;AAAA,EACZ,MAAM,CAAC,OAAO;AAChB;AAGO,SAAS,aAAa,WAAwC;AACnE,SAAO,CAAC,GAAG,IAAI,IAAI,UAAU,QAAQ,CAAC,aAAa,uBAAuB,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC;AAC7F;AAGO,IAAM,mBAAmB,OAAO,KAAK,sBAAsB;AAc3D,IAAM,WAA2B;AAQxC,IAAM,WAAmC;AAAA,EACvC,OAAO;AAAA,EACP,UAAU;AACZ;AAOA,IAAM,YAAoC;AAAA,EACxC,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKP,qBAAqB;AACvB;AAGA,SAAS,OAAO,OAAwB;AACtC,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,UAAM,SAAS,MAAM,KAAK,IAAI;AAC9B,WAAO,MAAM,UAAU,KAAK,OAAO,UAAU,KAAK,SAAS,GAAG,MAAM,MAAM;AAAA,EAC5E;AACA,MAAI,SAAS,OAAO,UAAU,SAAU,QAAO,GAAG,OAAO,KAAK,KAAK,EAAE,MAAM;AAC3E,SAAO,OAAO,KAAK;AACrB;AA0BO,SAAS,oBAAoB,OAAuB,UAAgC;AACzF,QAAM,OAA6B,CAAC;AAEpC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,GAAG;AAC/C,QAAI,OAAO,WAAW;AACpB,WAAK,KAAK,EAAE,KAAK,OAAO,OAAO,KAAK,GAAG,MAAM,UAAU,GAAG,KAAK,IAAI,OAAO,UAAU,CAAC;AACrF;AAAA,IACF;AACA,QAAI,OAAO,UAAU;AACnB,WAAK,KAAK,EAAE,KAAK,OAAO,OAAO,KAAK,GAAG,MAAM,SAAS,GAAG,KAAK,IAAI,OAAO,WAAW,CAAC;AACrF;AAAA,IACF;AAEA,UAAM,SACJ,SAAS,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK,IACtD,OAAO,QAAQ,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,GAAG,OAAO,EAAE,KAAK,GAAG,GAAG,IAAI,IAAI,IAAI,IAAI,EAAE,IAC3E,CAAC,EAAE,KAAK,KAAK,MAAM,CAAC;AAC1B,eAAW,QAAQ,QAAQ;AAWzB,UAAI,KAAK,OAAO,WAAW;AACzB,aAAK,KAAK;AAAA,UACR,KAAK,KAAK;AAAA,UACV,OAAO,OAAO,KAAK,GAAG;AAAA,UACtB,MAAM,UAAU,KAAK,GAAG,KAAK;AAAA,UAC7B,OAAO;AAAA,QACT,CAAC;AACD;AAAA,MACF;AACA,WAAK,KAAK,EAAE,KAAK,KAAK,KAAK,OAAO,OAAO,KAAK,GAAG,GAAG,MAAM,YAAY,OAAO,YAAY,CAAC;AAAA,IAC5F;AAAA,EACF;AAEA,SAAO;AACT;;;AC9OA,SAAS,UAAa,MAAS,OAAmB;AAChD,MAAI,CAAC,cAAc,KAAK,EAAG,QAAO;AAClC,MAAI,CAAC,cAAc,IAAI,EAAG,QAAO;AACjC,QAAM,MAA+B,EAAE,GAAG,KAAK;AAC/C,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,QAAI,GAAG,IAAI,cAAc,KAAK,IAAI,UAAU,IAAI,GAAG,GAAG,KAAK,IAAI;AAAA,EACjE;AACA,SAAO;AACT;AAGA,SAAS,UAAU,OAAgB,SAAS,IAAc;AACxD,MAAI,CAAC,cAAc,KAAK,EAAG,QAAO,SAAS,CAAC,MAAM,IAAI,CAAC;AACvD,SAAO,OAAO,QAAQ,KAAK,EAAE;AAAA,IAAQ,CAAC,CAAC,KAAK,KAAK,MAC/C,UAAU,OAAO,SAAS,GAAG,MAAM,IAAI,GAAG,KAAK,GAAG;AAAA,EACpD;AACF;AAGA,SAAS,OAAO,QAA4B;AAC1C,SAAO,CAAC,GAAG,IAAI,IAAI,MAAM,CAAC;AAC5B;AAUA,SAAS,kBAAkB,WAA6B;AACtD,MAAI,CAAC,cAAc,SAAS,KAAK,EAAE,WAAW,WAAY,QAAO;AACjE,QAAM,EAAE,OAAO,SAAS,GAAG,KAAK,IAAI;AACpC,UAAQ,OAAO;AAAA,IACb;AAAA,EAGF;AACA,SAAO;AACT;AAGO,SAAS,qBAAqB,QAA6B,CAAC,GAAyB;AAC1F,QAAM,WAA2B;AAAA,IAC/B,GAAG;AAAA,IACH,OAAO,OAAO,CAAC,GAAG,SAAS,OAAO,GAAI,MAAM,SAAS,CAAC,CAAE,CAAC;AAAA,IACzD,UAAU,EAAE,GAAG,SAAS,UAAU,GAAI,MAAM,YAAY,CAAC,EAAG;AAAA,EAC9D;AACA,QAAM,YAAY,kBAAkB,MAAM,SAAS;AAEnD,SAAO;AAAA,IACL,GAAG,UAAU,UAAU,SAAS;AAAA,IAChC,MAAM,MAAM,QAAQ;AAAA,IACpB,OAAO,UAAU,SAAS,EAAE,KAAK;AAAA,EACnC;AACF;","names":[]}

package/dist/index.d.ts

@@ -32,11 +32,31 @@ declare function registerAdapters(): void;
 declare const VERBS: readonly ["run", "inspect", "init", "migrate", "validate", "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", "dev", "test", "static-analysis", "runtime-analysis", "arch"];
+declare const TARGETS: readonly ["lint", "format", "typescript", "build", "dev", "test", "static-analysis", "env", "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"];
 type PresetName = (typeof PRESET_NAMES)[number];
+/**
+ * What the env role does with what it finds, from `SENTINEL_ENV_LEVEL`.
+ *
+ * | level | reports | in GitHub Actions | exit |
+ * | --- | --- | --- | --- |
+ * | `info` | yes | nothing more | 0 |
+ * | `warning`, the default | yes | a `::warning` annotation per finding | 0 |
+ * | `error` | yes | `::error` on a blocking finding, `::warning` on the rest | 1 on a blocking finding |
+ *
+ * An environment variable and not a flag, because the same command runs in a developer's shell and
+ * in every repository's CI, and what changes between them is the policy, not the command: a team
+ * moves from `warning` to `error` by setting one variable in its workflow, without editing the step.
+ *
+ * ⛔ Here and not in the role for the reason `OUTPUT_SHAPES` is: it is read and VALIDATED at the CLI
+ * edge, once, before any role runs, and handed to the role as data. A role that read the
+ * environment itself would be the one place in this package whose behaviour a test cannot pin by
+ * its inputs.
+ */
+declare const ENV_LEVELS: readonly ["info", "warning", "error"];
+type EnvLevel = (typeof ENV_LEVELS)[number];
 /**
  * @deprecated Renamed to `PresetName`. Kept so an existing `import type { Flavour }` keeps
  * compiling: the CLI kept `--flavour` working for the same reason, and breaking the type
@@ -120,6 +140,16 @@ interface RunContext {
      * The role rejects a shape it does not know, by name.
      */
     output?: string;
+    /**
+     * `SENTINEL_ENV_LEVEL`, validated by the CLI. Read by the env role only, and only through here:
+     * the role never reads the environment, so a test pins its behaviour by passing a value.
+     */
+    envLevel?: EnvLevel;
+    /**
+     * Whether the run is inside GitHub Actions (`GITHUB_ACTIONS=true`), read once by the CLI for the
+     * same reason as `envLevel`. A role that can annotate a pull request does so only when this is set.
+     */
+    githubActions?: boolean;
 }
 /**
  * A single, DECLARATIVE file operation an `--init` wants to happen. Adapters

package/dist/index.js

@@ -6,12 +6,13 @@ import {
   registerAdapters,
   resolve,
   setDefaultRunner
-} from "./chunk-JHLNNIZC.js";
+} from "./chunk-5267A6X3.js";
 import {
   BaseAdapter
 } from "./chunk-P7NYSMLS.js";
 import "./chunk-JRZI5IIN.js";
-import "./chunk-WBDBRGLV.js";
+import "./chunk-7E6YTTAK.js";
+import "./chunk-4EIY7TTR.js";
 import "./chunk-O7REVMOC.js";
 import "./chunk-QXFCZON7.js";
 export {

package/dist/roles/env/config.d.ts

@@ -0,0 +1,90 @@
+/**
+ * `defineEnv`: what a repository writes to declare its own env facts, all of them optional.
+ *
+ * ```js
+ * // env.config.mjs, at the repository root
+ * import { defineEnv } from '@hublo/sentinel/env'
+ *
+ * export default defineEnv({
+ *   externallyProvided: ['NODE_ENV'],
+ *   allowNonBlankedSecrets: ['apps/front/x/.env.example:LEGACY_API_KEY'],
+ * })
+ * ```
+ *
+ * A repository that does not install sentinel, and runs it with `npx`, cannot import this module:
+ * its own `node_modules` has no `@hublo/sentinel`. So the file may export the same object PLAIN,
+ * and the role passes it through this function itself. Both spellings mean the same thing, and the
+ * function exists for the one that can import it: it validates at the moment the file is written,
+ * in an editor that knows the types.
+ *
+ * ## What a repository declares, and what stays sentinel's
+ *
+ * A repository declares FACTS about itself: which variables its CI injects, which committed value
+ * was reviewed and is not a secret, which Dockerfile must run as root, where its code lives. It
+ * does not redefine what a secret NAME looks like or how code reads env, which are the same in
+ * every repository and ship in `presets/shared.json`.
+ *
+ * Two semantics, stated once:
+ *
+ *  - `readers`, `envFiles` and `contracts` ADD to what sentinel ships, so no repository loses
+ *    `getOrFail` or `**\/.env` by declaring a reader or a glob of its own;
+ *  - `scan` and `references` REPLACE, key by key: a repository naming its `roots` says where its
+ *    code is, and keeping `.` beside them would scan everything anyway.
+ *
+ * ⛔ An unknown key is refused, by name. The file is `.mjs`, so nothing type-checks it, and a key
+ * spelled `allowNonBlankedSecret` would otherwise be ignored in silence while the finding it was
+ * meant to downgrade kept failing the build.
+ */
+/** A source scope a repository may narrow, every key optional. */
+interface EnvScopeInput {
+    roots?: string[];
+    ext?: string[];
+    excludeSuffixes?: string[];
+    excludeDirs?: string[];
+}
+/** What `env.config.mjs` exports. */
+interface EnvInput {
+    /** Required variables in no contract because CI injects them or a secret store provides them. */
+    externallyProvided?: string[];
+    /** Declared variables consumed outside scannable source, so never reported dead (rule 4). */
+    knownExternalVars?: string[];
+    /** The same, by pattern, for a whole category such as `/_DATABASE_URL$/`. */
+    knownExternalPatterns?: (RegExp | string)[];
+    /** `<file>:<VAR>` locations whose committed value was reviewed and is not a secret (rule 6). */
+    allowNonBlankedSecrets?: string[];
+    /** Committed real env files permitted anyway, such as a test fixture (rule 2). */
+    allowedCommittedEnvFiles?: string[];
+    /** Globs of env files to read, ADDED to `**\/.env`, `**\/.env.*` and `**\/*.env`. */
+    envFiles?: string[];
+    /** Globs of contracts, ADDED to `**\/*.env*.example`. */
+    contracts?: string[];
+    /** Where the named readers are looked for (rules 1 and 3). Replaces, key by key. */
+    scan?: EnvScopeInput;
+    /** Where direct `process.env` reads are looked for (rules 3 and 4). Replaces, key by key. */
+    references?: EnvScopeInput;
+    /** Reader names ADDED to sentinel's: `required` throw when absent, `optional` default. */
+    readers?: {
+        required?: string[];
+        optional?: string[];
+    };
+    /** Docker rules: Dockerfiles allowed to run as root, and path prefixes not checked at all. */
+    docker?: {
+        allowRoot?: string[];
+        excludePaths?: string[];
+    };
+}
+/**
+ * Validate a repository's env declaration and return it unchanged.
+ *
+ * The defaults are NOT merged in here. They ship with sentinel and are applied when the role runs,
+ * so changing one reaches every repository at its next sentinel version instead of leaving a copy
+ * frozen in each config. That also makes this function idempotent, which is what lets the role
+ * pass a plain exported object through it a second time.
+ *
+ * @param input the declaration; omitted, the repository declares nothing
+ * @returns the same declaration
+ * @throws naming every unknown key and every malformed value at once
+ */
+declare function defineEnv(input?: EnvInput): EnvInput;
+
+export { type EnvInput, type EnvScopeInput, defineEnv };

package/dist/roles/env/config.js

@@ -0,0 +1,7 @@
+import {
+  defineEnv
+} from "../../chunk-4EIY7TTR.js";
+export {
+  defineEnv
+};
+//# sourceMappingURL=config.js.map

package/dist/roles/env/config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/roles/static-analysis/config.js

@@ -1,6 +1,6 @@
 import {
   defineStaticAnalysis
-} from "../../chunk-WBDBRGLV.js";
+} from "../../chunk-7E6YTTAK.js";
 export {
   defineStaticAnalysis
 };

package/dist/roles/test/setup/jest-parity.js

@@ -1,3 +1,7 @@
+import {
+  clearDeepMocks,
+  resetDeepMocks
+} from "../../../chunk-2XLX6PFR.js";
 import {
   alreadyInstalled
 } from "../../../chunk-NUOQXAYR.js";
@@ -5,10 +9,6 @@ import {
   installWorkspaceSetup
 } from "../../../chunk-LFNOBQZU.js";
 import "../../../chunk-ELZHIN6E.js";
-import {
-  clearDeepMocks,
-  resetDeepMocks
-} from "../../../chunk-2XLX6PFR.js";
 import "../../../chunk-JRZI5IIN.js";
 
 // src/roles/test/setup/jest-parity.ts

package/docs/env-adoption.md

@@ -0,0 +1,268 @@
+# Env conformance cheat sheet
+
+The `env` role checks a **repository**, not a module: which env files git tracks, whether the code
+reads a variable no contract declares, whether a secret-named variable carries a committed value,
+and whether the Dockerfiles copy paths that exist and drop root at runtime. It is the monorepo's
+`tools/repo-env` (`validate`, `docker-check`, `inventory` and `ci-gate`) made to run on any
+repository, including one that is not an nx workspace.
+
+```bash
+# from the repository ROOT (the git top-level), nothing to install
+npx --yes @hublo/sentinel@<version> --run --env
+```
+
+It writes no config, so there is no `--init`. With no `env.config.mjs` it runs on sentinel's
+defaults, and says so in its header.
+
+## The level: `SENTINEL_ENV_LEVEL`
+
+The same findings are reported at every level. The level decides what they DO.
+
+| `SENTINEL_ENV_LEVEL` | reports | in GitHub Actions (`GITHUB_ACTIONS=true`)                   | exit                        |
+| -------------------- | ------- | ----------------------------------------------------------- | --------------------------- |
+| `info`               | yes     | nothing more                                                | 0                           |
+| `warning` (default)  | yes     | one `::warning file=…,line=…::` annotation per finding      | 0                           |
+| `error`              | yes     | `::error` on a blocking finding, `::warning` on an advisory | **1** on a blocking finding |
+
+An unknown value is refused with exit 1 rather than read as the default: a typo of `error` that ran
+as `warning` would turn a gate into a report, and nobody would see it stop gating.
+
+⚠️ It is refused like an unknown option: before ANY role runs. A bare `sentinel --run` at the
+repository root includes `env`, so an invalid `SENTINEL_ENV_LEVEL` there refuses the whole sweep,
+lint, format, typescript, build and test included, not only `env`. The variable is read only when
+`env` is part of the run: `sentinel --run --lint`, a bare `--run` from a module below the root, and
+every other verb never read it, so it cannot refuse them.
+
+Under `--json` the annotations go to **stderr**, so stdout stays one JSON document; the runner
+reads workflow commands from both streams.
+
+## The rules
+
+| #   | finding id                                   | what it reports                                                                         | severity                                  |
+| --- | -------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------- |
+| 1   | `required-var-undeclared`                    | a variable a required reader (`getOrFail`, …) reads, declared in no contract            | blocking                                  |
+| 2   | `committed-env-file`                         | a real env file tracked by git (anything that is not an `.example` contract)            | blocking                                  |
+| 3   | `var-not-in-app-contract`                    | a variable an app reads, declared only in ANOTHER app's contract                        | advisory                                  |
+| 4   | `dead-var`                                   | a declared variable read nowhere in source                                              | advisory                                  |
+| 5   | `public-secret-to-review`                    | a public-prefixed (`VITE_`, `PUBLIC_`, `NEXT_PUBLIC_`, `REACT_APP_`) secret-named value | advisory                                  |
+| 6   | `secret-not-blanked`                         | a secret-named variable with a committed value, in a contract OR a real env file        | blocking (`secret-allowlisted`: advisory) |
+| 7   | `dead-copy-path`                             | a `COPY` source that does not exist                                                     | blocking                                  |
+| 8   | `nx-project-missing` / `nx-target-missing`   | an `nx run <project>:<target>` that does not exist                                      | blocking                                  |
+| 9   | `node-version-mismatch`                      | a `FROM node:<v>` that differs from `.node-version`                                     | blocking                                  |
+| 10  | `dockerfile-runs-as-root` / `copy-not-owned` | a runtime stage running as root, or a runtime `COPY` without `--chown`                  | blocking                                  |
+
+The blocking set is `repo-env ci-gate`'s, unchanged. Rules 3, 4 and 5 never block, at any level: a
+variable "read nowhere" can be read by a branch not merged yet, which is how the monorepo once
+deleted `VITE_CAREER_URL` from main while an open pull request read it.
+
+A finding carries a **file, a line, a variable name and a rule**. Never a value: there is no field
+a value could travel in, so no shape can print one.
+
+What the role cannot check, it says, in a `note:` line: no contract committed (rules 1, 3 and 4
+have nothing to compare with), no required reader call found (rule 1, naming the readers looked
+for, which `readers.required` extends), no `.node-version` (rule 9), no `nx.json` or an nx that cannot run
+(rule 8, with the count of references left unchecked).
+
+## Where it runs
+
+| from                                | `sentinel --run --env`                   | `sentinel --run` (sweep)                |
+| ----------------------------------- | ---------------------------------------- | --------------------------------------- |
+| the repository root (git top-level) | runs, once                               | includes `env` once, beside the modules |
+| a directory inside it (a module)    | **refused**, naming the root to run from | the module's roles only, as before      |
+| a directory in no git repository    | **refused**                              | the module's roles only, as before      |
+
+⛔ Inside a module it is refused, not scoped. Rule 3 compares one app's reads with another app's
+contract and rule 2's file may sit two directories up, so a scoped report is a smaller report that
+looks like a clean one. `--inspect`, `--init`, `--validate` and `--status` refuse `--env` and never
+sweep it: it has no config to read or write. `--module`, `--fix` and options after `--` are refused
+beside it.
+
+Discovery is `git ls-files`, never nx: a repository with no `nx.json` has no project graph to ask,
+and a filesystem walk would report a developer's untracked `.env` as committed. Rule 8 is the one
+place nx is used, the repository's OWN nx from its `node_modules`, and only when `nx.json` exists.
+
+## Output shapes
+
+| shape               | what                                                                                                                                                                         |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| console (default)   | the report, grouped by rule with each rule's fix, then notes and the verdict                                                                                                 |
+| `--json`            | the engine envelope; the env row carries `level`, `verdict`, `blocking`, `findings`, `notes`, `counts` and the full `inventory` (required and optional variables, contracts) |
+| `--output json`     | the same document, written to `env-report/env.json`                                                                                                                          |
+| `--output markdown` | the pull-request recap, written to `env-report/env.md`, opening with `<!-- sentinel-env-report -->`                                                                          |
+
+`html` is not a shape this role writes, and asking it of `--env` alone is refused.
+
+## The repository's config: `env.config.mjs`
+
+Optional, at the repository root. A repository declares FACTS about itself; what a secret name
+looks like and how code reads env ship with sentinel.
+
+```js
+// env.config.mjs
+export default {
+  externallyProvided: ['NODE_ENV'], // required, but CI or a secret store provides it
+  knownExternalVars: ['CACHE_PATH'], // declared, consumed outside source (rule 4)
+  knownExternalPatterns: [/_DATABASE_URL$/], // the same, by category
+  allowNonBlankedSecrets: ['apps/x/.env.example:LEGACY_API_KEY'], // reviewed, not a secret (rule 6)
+  allowedCommittedEnvFiles: ['tests/fixtures/.env'], // rule 2
+  envFiles: ['**/*.envrc'], // ADDED to **/.env, **/.env.*, **/*.env
+  contracts: ['templates/*.env.dist'], // ADDED to **/*.env*.example
+  scan: { roots: ['apps', 'libs'] }, // where the named readers are looked for; replaces key by key
+  references: { roots: ['apps', 'libs'] }, // where direct process.env reads are looked for
+  readers: { required: ['mustGetEnv'] }, // ADDED to getOrFail, requireEnv, requireEnvVariable
+  docker: { allowRoot: ['images/legacy/Dockerfile'], excludePaths: ['local/'] },
+}
+```
+
+A repository that installs sentinel can write the same object through `defineEnv`, which an editor
+type-checks:
+
+```js
+import { defineEnv } from '@hublo/sentinel/env'
+export default defineEnv({ externallyProvided: ['NODE_ENV'] })
+```
+
+A repository that runs sentinel with `npx` cannot import it, since its own `node_modules` has no
+`@hublo/sentinel`; the plain object is the spelling for it, and the error says so if the import is
+tried. An unknown key is refused by name, in both spellings: the file is `.mjs`, and an ignored
+`allowNonBlankedSecret` would silently stop downgrading the finding it was written for.
+
+A refused config fails the run (exit 1, at every level) and says why twice: in full on stderr, one
+line per problem, and on the summary row, `level=warning error=env.config.mjs: invalid env config:
+unknown key "materialize"`, which is also the row's `error` in `--json`. A value of the wrong type is
+named with what was found, its kind and never its content: `scan.roots[1] is an empty string`.
+
+### Not the monorepo's `repo-env.config.mjs`
+
+`env.config.mjs` is sentinel's own schema, smaller than the monorepo's `tools/repo-env` config, and
+not a copy of it. Reusing the monorepo's file as-is in another repository is not correct either way:
+its allowlists, scan roots and readers describe the monorepo. A repository declares its own facts,
+with these keys and no others: `externallyProvided`, `knownExternalVars`, `knownExternalPatterns`,
+`allowNonBlankedSecrets`, `allowedCommittedEnvFiles`, `envFiles`, `contracts`, `scan` and
+`references` (each `roots`, `ext`, `excludeSuffixes`, `excludeDirs`), `readers` (`required`,
+`optional`) and `docker` (`allowRoot`, `excludePaths`).
+
+Four keys of `repo-env.config.mjs` are refused, on purpose:
+
+| `repo-env.config.mjs` key | in sentinel 1.6                                                                                                                                          |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `materialize`             | monorepo-only: it seeds that repository's test env files from its contracts, which is functional, not conformance. It stays in the monorepo              |
+| `references.patterns`     | fixed in V1, built in: `process.env.X`, `process.env['X']`, `import.meta.env.X`, `import.meta.env['X']`, `$env/static/*` imports, `env.X`, `{ X } = env` |
+| `secretNamePatterns`      | fixed in V1, built in: `SECRET`, `TOKEN`, `PASSWORD`, `PRIVATE_?KEY`, `ACCESS_?KEY`, `API_?KEY`, case-insensitive                                        |
+| `publicEnvPrefixes`       | fixed in V1, built in: `VITE_`, `PUBLIC_`, `NEXT_PUBLIC_`, `REACT_APP_`                                                                                  |
+
+The three fixed ones describe how code reads env and what a name means, which do not vary by
+repository. The migration of the monorepo onto the role is where they are revisited.
+
+### Sentinel's defaults
+
+`presets/shared.json` in the role. Secret names match **case-insensitively** (`SECRET`, `TOKEN`,
+`PASSWORD`, `PRIVATE_?KEY`, `ACCESS_?KEY`, `API_?KEY`), so serviceapp's `facturationPassword` and a
+camel-case `apiKey` are seen. The scans read `.ts .tsx .mts .cts .js .jsx .mjs .cjs` (and `.svelte`,
+`.vue` for direct reads) across the whole repository, with test files left out of the reader scan:
+`.test.<ext>` and `.spec.<ext>` for each of those eight extensions. A value is read as dotenv reads
+it: an unquoted value ends at its first `#` (dotenv's README, "Comments begin where a `#` exists"),
+a quoted one at its closing quote, so `API_TOKEN= # filled by the vault` is blank.
+
+## In CI
+
+The role reads the plain checkout, so the step goes BEFORE anything that writes into the tree, a
+secret materialization or an env-file generation included:
+
+```yaml
+permissions:
+  contents: read
+  pull-requests: write
+steps:
+  - uses: actions/checkout@v4
+  - uses: actions/setup-node@v4
+    with:
+      node-version: 24.15.0
+  - run: npx --yes @hublo/sentinel@<version> --run --env --output markdown
+    env:
+      SENTINEL_ENV_LEVEL: warning
+  # then post env-report/env.md as a sticky comment, found by its first line
+```
+
+sentinel needs Node 24.15 to run, whatever Node the repository itself uses: `setup-node` here
+installs it for this step only.
+
+GitHub documents a cap of 10 warning and 10 error annotations per step
+(<https://docs.github.com/en/rest/checks/runs>): on a repository with more findings, the
+pull request shows only part of the annotations, and the markdown recap is the complete list.
+Past the cap, sentinel still emits one annotation per finding, and emits FIRST, so it is always
+shown, one summary annotation of the same type: at `error` on serviceapp, `55 blocking findings
+(GitHub shows at most 10 error annotations per step): the full list is in the env report, ...`.
+One per type at most, and none at or under 10.
+
+## What changed from `tools/repo-env`
+
+Measured by running both on the same monorepo commit, the monorepo's `repo-env.config.mjs`
+translated into an `env.config.mjs`: **51 of 52 findings identical**, plus every optional variable,
+and the one difference is intended (the first line below). Measured twice: on `origin/main` 3364bb9
+(97 optional variables) and again on 50c5157 on 30 October (102), after the COPY fix below, with
+the same single difference.
+
+| command of `tools/repo-env` | with sentinel                                                   |
+| --------------------------- | --------------------------------------------------------------- |
+| `validate`                  | `sentinel --run --env` (level `warning` or `info`: exit 0)      |
+| `docker-check`              | the same run: rules 7 to 10 are in every report                 |
+| `ci-gate`                   | `SENTINEL_ENV_LEVEL=error sentinel --run --env`                 |
+| `inventory`                 | `sentinel --run --env --json`, the row's `inventory`            |
+| `validate --app <name>`     | not ported: the role refuses a scoped run (see "Where it runs") |
+| `materialize`               | not ported, stays in the monorepo                               |
+
+- `Dockerfile.dockerignore` is no longer audited as an image running as root. A Dockerfile is read
+  from its NAME (`Dockerfile`, `Dockerfile.<x>`, `Dockerfile-<x>`, `<x>.Dockerfile`), never from a
+  `.dockerignore` or a `.md` that mentions one.
+- A lowercase or camel-case key is a key (`facturationPassword=` used to be skipped), and a
+  reference to one is seen, so it is not reported dead forever.
+- A bare `$VAR` in a `COPY` is a build argument, not a path that does not exist.
+- A `COPY` source is read the way Docker reads it: `COPY "entrypoint.sh" /app` checks
+  `entrypoint.sh`, the JSON form `COPY ["a", "b", "/app/"]` checks `a` and `b`, a heredoc checks
+  nothing. The original kept the quotes and reported servicecontract's `entrypoint.sh`, which sits
+  next to its Dockerfile, as a dead path, blocking.
+- A `v`-prefixed `.node-version` (`v10.15.3`) compares as a version; a missing one is a note, not
+  a crash.
+- Rule 6 reads every committed env file, not only contracts, and no contract at all is a note
+  rather than a refusal to run.
+- Every finding has a line, so an annotation lands on it.
+- A comment after a value is a comment, as in dotenv: `KEY= # note` is blank, not a committed
+  secret. And a quoted value followed by one, `KEY="" # note`, no longer opens a multi-line value
+  that hid every key after it in the file. The original read `KEY= # note` as filled.
+- Test files are left out of the reader scan for every extension it reads; the original read
+  `.ts` and `.tsx` only, and left out `.spec.ts` and `.test.ts`.
+
+## Outside the monorepo: what `tools/repo-env` assumed, and what the port does
+
+`repo-env`'s README calls `repo-io.mjs` "mostly" repo-agnostic. These are the places where it, or
+its config, assumed the monorepo, and what the role does in a repository without nx and without
+that layout. Each line was RUN, from the packed tarball through `npx`, on six hublo repositories
+that are not the monorepo (serviceapp, serviceapi, servicecontract, servicemission, contract-front,
+servicebackoffice), on 30 October.
+
+| monorepo assumption                                                           | in the port                                         | outside the monorepo                                                                                                                                                    |
+| ----------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| the root is the script's own `../..`                                          | the git top-level                                   | works, 6 of 6                                                                                                                                                           |
+| sources found by walking `apps/nest`, `libs/nest`, `apps/front`, `libs/front` | `git ls-files` under `.`                            | works, 6 of 6                                                                                                                                                           |
+| required reads are `getOrFail`, `requireEnv`, `requireEnvVariable`            | the same names, extendable with `readers`           | **degrades, said**: a repository reading `process.env.X` directly has no required read, so rule 1 has nothing to check, and a note says so, naming the readers (3 of 6) |
+| contracts are `*.env*.example`                                                | the same, extendable with `contracts`               | **degrades, said**: with none, rules 1, 3 and 4 are skipped with a note (serviceapp, servicebackoffice)                                                                 |
+| a real env file is `.env` or `.env.<x>`                                       | also `**/*.env`                                     | works: serviceapp's 9 `variables/*.variables.env`                                                                                                                       |
+| secret names are upper-case                                                   | case-insensitive                                    | works: serviceapp's `facturationPassword`                                                                                                                               |
+| public prefixes are `VITE_`, `PUBLIC_`                                        | also `REACT_APP_`, `NEXT_PUBLIC_`                   | works: `REACT_APP_SEGMENT_API_KEY_ADMINS` is reviewed, not blocked                                                                                                      |
+| apps are directories with a `project.json` or a named `package.json`          | the same, from tracked manifests                    | **degrades, silent**: a single-package repository has no app below its root, so rule 3 never fires (0 in 6 of 6)                                                        |
+| rule 8 asks `pnpm exec nx`                                                    | the repository's own nx, only when `nx.json` exists | **degrades, said**: rule 8 skipped with a note (6 of 6)                                                                                                                 |
+| the Node version is in `.node-version`                                        | the same file, not configurable                     | **degrades, said**: a repository with `.nvmrc` only gets the rule 9 note (servicebackoffice)                                                                            |
+| a Dockerfile is any path containing `Dockerfile`                              | read from its name                                  | works: `Dockerfile.prod` is an image                                                                                                                                    |
+| a `COPY` source is a space-separated word                                     | read as Docker reads it                             | **broke, fixed**: servicecontract's quoted `"entrypoint.sh"` was a blocking dead path                                                                                   |
+| local dev-compose Dockerfiles live in `local/`                                | no default, `docker.excludePaths`                   | works                                                                                                                                                                   |
+| the allowlists name monorepo files                                            | empty defaults, `env.config.mjs`                    | works, as a plain object through `npx` and through `defineEnv` from an installed tarball                                                                                |
+
+Two original behaviours stay as they were, because they are judgements, not layout: a final stage
+on an image that is not node (contract-front's `nginx`) is reported as running as root, and a
+variable read by building its name at runtime (serviceapi's `DATABASE_URL_READ2`, found by a
+`process.env` key filter) is reported dead, which `knownExternalPatterns` answers.
+
+`materialize` (seeding test env files from contracts) stays in the monorepo: it writes runtime
+files for one repository's test setup, which is functional, not conformance. Secret scanning by
+VALUE is gitleaks' job and is not part of this role.