@roomi-fields/grillhouse 0.24.0 → 0.24.1

package/.claude-plugin/plugin.json

@@ -5,5 +5,5 @@
   "author": {
     "name": "Romain Peyrichou"
   },
-  "version": "0.24.0"
+  "version": "0.24.1"
 }

package/docs/ARCHITECTURE.md

@@ -212,5 +212,8 @@ la fonction, sans réexport, avec sa déclaration de types à côté (`scripts/<
 partagée), `@roomi-fields/grillhouse/paquets` (`horsCadre`, les paquets hors cadre), et la
 configuration de base de Vitest, `@roomi-fields/grillhouse/vitest-config` et
 `@roomi-fields/grillhouse/vitest-config/mesure`. Une entrée s'ajoute ou se retire avec ce
-paragraphe, que `tests/unit/paquet-publie.spec.ts` confronte au champ `exports`. Ainsi une
-version du paquet dit ce qu'un projet peut importer, et ce qu'elle lui retire.
+paragraphe, que `tests/unit/paquet-publie.spec.ts` confronte au champ `exports`. Un paquet du
+projet dont le code de `src/` hors des tests importe une entrée déclare le paquet du cadre dans
+ses `dependencies`, comme npm y met ce que le code publié importe : `npx grillhouse maj` l'y
+place, ses imports lus par TypeScript. Ainsi une version du paquet dit ce qu'un projet peut
+importer, et ce qu'elle lui retire.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roomi-fields/grillhouse",
-  "version": "0.24.0",
+  "version": "0.24.1",
   "description": "Roomi's Grillhouse: the frame's scripts, called by one command, grillhouse <sous-commande>",
   "license": "MIT",
   "type": "module",

package/scripts/frontieres.mjs

@@ -47,8 +47,10 @@ import { trancher } from './dette.mjs';
 
 export const CONFIGURATION = '.dependency-cruiser.cjs';
 export const RACINES = ['src', 'packages'];
-const TESTS = '(^|/)(test|tests|__tests__)/|[.](test|spec)[.][a-z]+$';
-const CODE = '^src/|^packages/[^/]+/src/';
+/** The test files, as a pattern of a path from the repository's root. */
+export const TESTS = '(^|/)(test|tests|__tests__)/|[.](test|spec)[.][a-z]+$';
+/** The code of `src/` (the root's, or a package's under `packages/`), as a pattern of such a path. */
+export const CODE = '^src/|^packages/[^/]+/src/';
 const REGLE_OUTILS = 'pas-d-outil-de-developpement-dans-le-code';
 // The environment variable naming the file that holds the pattern of the published files.
 const JUGES = 'GRILLHOUSE_JUGES';

package/scripts/grillhouse-maj.mjs

@@ -97,6 +97,13 @@
 //   `^<version>` of the package), a declaration it holds kept; a package out of the frame is not
 //   touched. The report names the packages that received it, `npm install`, which links it, and the
 //   import; the update writes no Vitest configuration.
+// - A package of the frame whose code imports the frame's package (a file of its `src/` out of the
+//   tests, the files whose development dependencies the guard of the boundaries refuses,
+//   scripts/frontieres.mjs; its imports read by TypeScript's `preProcessFile`) declares it in its
+//   `dependencies`, as npm puts there what the published code imports: a declaration in its
+//   `devDependencies` moves there with its range, else the range the root declares (else
+//   `^<version>`); this comes first, so that the declaration of the Vitest base above keeps it.
+//   The report names the packages and `npm install`.
 // - The git hooks: both of the frame (commit-msg « a closed ticket refuses a second commit, a reopened ticket takes its corrections », pre-push night branch
 //   guard) are placed by scripts/crochets.mjs, the mechanism `grillhouse hooks` (the project's
 //   `prepare`) also runs, in the hooks folder git reads for the project (`core.hooksPath`, else the
@@ -122,6 +129,7 @@
 // - The report names the version of the frame, « Cadre 0.23.0. », the package's.
 import { spawnSync } from 'node:child_process';
 import { copyFileSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 import semver from 'semver';
@@ -129,7 +137,9 @@ import { CADRE, VERSION } from './cadre.mjs';
 import { poserCrochets } from './crochets.mjs';
 import { installerGreffons } from './greffons.mjs';
 import { migrer, restesAuProjet } from './migrations.mjs';
+import { CODE, TESTS } from './frontieres.mjs';
 import { paquets } from './paquets.mjs';
+import { sources } from './sources.mjs';
 
 const SCRIPTS = {
   tableau: 'grillhouse tableau --texte',
@@ -219,6 +229,64 @@ function poserTurbo(projet, source) {
   return gabarit;
 }
 
+// <deps> written sorted by name, as npm writes them.
+const trie = deps =>
+  Object.fromEntries(Object.entries(deps).sort(([a], [b]) => a.localeCompare(b, 'en')));
+// The range at which the root package.json <p> declares the frame's package, or undefined.
+const plageDeLaRacine = p =>
+  CHAMPS_INSTALLES.map(c => p[c]?.[PAQUET_DU_CADRE]).find(v => v !== undefined);
+
+// Whether the code of the package at <dossier> of <projet> imports the frame's package (an entry of
+// it): a file of its `src/` out of the tests (CODE and TESTS of scripts/frontieres.mjs, the files
+// whose development dependencies its guard refuses), its imports read by TypeScript
+// (`preProcessFile`), a comment or a string importing nothing.
+function codeImporteLeCadre(projet, dossier) {
+  const ts = createRequire(import.meta.url)('typescript');
+  return sources(path.join(projet, dossier))
+    .map(f => `${dossier}/${f}`)
+    .filter(f => new RegExp(CODE).test(f) && !new RegExp(TESTS).test(f))
+    .some(f =>
+      ts
+        .preProcessFile(readFileSync(path.join(projet, f), 'utf8'), true, true)
+        .importedFiles.some(
+          ({ fileName: m }) => m === PAQUET_DU_CADRE || m.startsWith(`${PAQUET_DU_CADRE}/`)
+        )
+    );
+}
+
+// Declares the frame's package in the dependencies of each package of the frame of the project of
+// packages at <projet> (root package.json <p>) whose code imports it (codeImporteLeCadre), as npm
+// puts what the published code imports: a declaration in its devDependencies moves there with its
+// range, else the range the root declares (else `^<version>` of the package); one already in its
+// dependencies or optionalDependencies stays. Returns { nom, paquets } (paquets: the packages
+// whose dependencies received it), or null when nothing changes.
+function declarerDependanceDuCadre(projet, p) {
+  if (p.workspaces === undefined) {
+    return null;
+  }
+  const racine = plageDeLaRacine(p);
+  const declarants = [];
+  for (const { dossier, pkg, hors } of paquets(projet)) {
+    const declare = ['dependencies', 'optionalDependencies'].some(
+      c => pkg[c]?.[PAQUET_DU_CADRE] !== undefined
+    );
+    if (hors || declare || !codeImporteLeCadre(projet, dossier)) {
+      continue;
+    }
+    const { [PAQUET_DU_CADRE]: dev, ...autres } = pkg.devDependencies ?? {};
+    pkg.dependencies = trie({
+      ...(pkg.dependencies ?? {}),
+      [PAQUET_DU_CADRE]: dev ?? racine ?? `^${VERSION}`,
+    });
+    if (dev !== undefined) {
+      pkg.devDependencies = autres;
+    }
+    writeFileSync(path.join(projet, dossier, 'package.json'), `${JSON.stringify(pkg, null, 2)}\n`);
+    declarants.push(dossier);
+  }
+  return declarants.length > 0 ? { nom: PAQUET_DU_CADRE, paquets: declarants } : null;
+}
+
 // Declares the frame's package, whose base configuration of Vitest each Vitest configuration
 // imports, in the devDependencies of each package of the frame of the project of packages at
 // <projet> (root package.json <p>) whose scripts hold `test:vitest`, at the range the root declares
@@ -230,16 +298,14 @@ function poserConfigVitest(projet, p) {
   const testes = paquets(projet).filter(
     ({ pkg, hors }) => !hors && typeof pkg.scripts?.['test:vitest'] === 'string'
   );
-  const racine = CHAMPS_INSTALLES.map(c => p[c]?.[PAQUET_DU_CADRE]).find(v => v !== undefined);
+  const racine = plageDeLaRacine(p);
   const declarants = [];
   for (const { dossier, pkg } of testes) {
     if (CHAMPS_INSTALLES.some(c => pkg[c]?.[PAQUET_DU_CADRE] !== undefined)) continue;
-    pkg.devDependencies = Object.fromEntries(
-      Object.entries({
-        ...(pkg.devDependencies ?? {}),
-        [PAQUET_DU_CADRE]: racine ?? `^${VERSION}`,
-      }).sort(([a], [b]) => a.localeCompare(b, 'en'))
-    );
+    pkg.devDependencies = trie({
+      ...(pkg.devDependencies ?? {}),
+      [PAQUET_DU_CADRE]: racine ?? `^${VERSION}`,
+    });
     writeFileSync(path.join(projet, dossier, 'package.json'), `${JSON.stringify(pkg, null, 2)}\n`);
     declarants.push(dossier);
   }
@@ -303,6 +369,7 @@ export function mettreAJour(projet, source, { inscrite = VERSION } = {}) {
     vitest: null,
     turbo: null,
     configVitest: null,
+    dependanceDuCadre: null,
     gardes: null,
     ligneEtat: false,
     greffon: false,
@@ -362,9 +429,7 @@ export function mettreAJour(projet, source, { inscrite = VERSION } = {}) {
       }
     }
     if (p.devDependencies) {
-      p.devDependencies = Object.fromEntries(
-        Object.entries(p.devDependencies).sort(([a], [b]) => a.localeCompare(b, 'en'))
-      );
+      p.devDependencies = trie(p.devDependencies);
     }
     if (typeof pkgSource.packageManager === 'string' && typeof p.packageManager !== 'string') {
       p.packageManager = pkgSource.packageManager;
@@ -403,6 +468,7 @@ export function mettreAJour(projet, source, { inscrite = VERSION } = {}) {
         bilan.gardes = { deplace: false };
       }
     }
+    bilan.dependanceDuCadre = declarerDependanceDuCadre(projet, p);
     bilan.configVitest = poserConfigVitest(projet, p);
     writeFileSync(pkg, `${JSON.stringify(p, null, 2)}\n`);
   }
@@ -462,6 +528,12 @@ export function rapport(b) {
       `Configuration de base de Vitest : ${nom} déclaré dans les devDependencies de ${declarants.join(', ')}. \`npm install\` relie le paquet. La configuration Vitest de chaque paquet l'importe par son nom : \`import base from '${CONFIG_VITEST}'\`.`
     );
   }
+  if (b.dependanceDuCadre) {
+    const { nom, paquets: declarants } = b.dependanceDuCadre;
+    lignes.push(
+      `Dépendance d'exécution : ${nom} déclaré dans les dependencies de ${declarants.join(', ')}, dont le code hors des tests importe une entrée du paquet. \`npm install\` relie le paquet.`
+    );
+  }
   if (b.turbo) {
     lignes.push(
       `turbo.json écrit depuis le gabarit du cadre ${b.turbo} ; il est au projet, la mise à jour n'y touche plus.`

package/scripts/migrations/0.24.0-circuit-simplifie.mjs

@@ -21,12 +21,15 @@
 // - What stays to the project (`restes`, which the update plays after its own update and its
 //   regeneration, so that it sees the final state): a tracked file of the project (`git ls-files`,
 //   node_modules and the changelogs aside) that still calls or names a script of the frame at its former address under `scripts/`
-//   (`node scripts/<script>`, `$RACINE/scripts/<script>`, `path.join(…, 'scripts', '<script>')`;
-//   a tracked path that is no regular file, a submodule or a link, is skipped),
-//   where the project holds no such file any more, is named with its file:line and what replaces
-//   it: the subcommand (`SOUS_COMMANDES` of scripts/sous-commandes.mjs), the hook
+//   (`node scripts/<script>`, `$RACINE/scripts/<script>`, `file://$1/scripts/<script>`,
+//   `path.join(…, '..', 'scripts', '<dossier>', '<script>')`, found by its words, sousScripts; a
+//   `scripts/` under a literal directory, a package of the project or the installed package, is
+//   another's, `.` and `..` naming none; a tracked path that is no regular file, a submodule or a
+//   link, is skipped), where the project holds no such file any more, is named with its file:line
+//   and what replaces it: the subcommand (`SOUS_COMMANDES` of scripts/sous-commandes.mjs), the hook
 //   (`grillhouse hook <nom>`, `CROCHETS` of scripts/crochets.mjs) or the named entry (the
-//   `exports` of the package). The project's scripts are its own: none is rewritten, and the
+//   `exports` of the package). A script of the package that has none of them is named with « aucune
+//   entrée publiée ne la remplace ». The project's scripts are its own: none is rewritten, and the
 //   lines are a report, which never holds back the version the project records, as a codemod
 //   reports what it leaves without failing.
 // - No version of the update wrote a setting of a role in `.claude/settings.json` or under
@@ -37,7 +40,7 @@
 //   to the project.
 import { execFileSync } from 'node:child_process';
 import { createHash } from 'node:crypto';
-import { existsSync, lstatSync, readFileSync, writeFileSync } from 'node:fs';
+import { existsSync, lstatSync, readdirSync, readFileSync, writeFileSync } from 'node:fs';
 import path from 'node:path';
 import { CADRE, PAQUET } from '../cadre.mjs';
 import { CROCHETS } from '../crochets.mjs';
@@ -154,7 +157,7 @@ function copies(projet) {
 }
 
 // What replaces each script of the frame, by its path under `scripts/`: its subcommand, its hook,
-// its named entry.
+// its named entry; none for a script of the package that has none of them.
 function remplacants() {
   const r = new Map();
   const ajouter = (script, quoi) => r.set(script, [...(r.get(script) ?? []), quoi]);
@@ -164,20 +167,64 @@ function remplacants() {
   for (const [n, c] of Object.entries(CROCHETS)) {
     ajouter(c.garde, `\`grillhouse hook ${n}\``);
   }
-  const { exports = {} } = JSON.parse(readFileSync(path.join(PAQUET, 'package.json'), 'utf8'));
+  const { name, exports = {} } = JSON.parse(
+    readFileSync(path.join(PAQUET, 'package.json'), 'utf8')
+  );
   for (const [entree, cible] of Object.entries(exports)) {
     const d = typeof cible === 'string' ? cible : cible?.default;
     if (typeof d === 'string' && d.startsWith('./scripts/')) {
-      ajouter(d.slice('./scripts/'.length), `\`@roomi-fields/grillhouse${entree.slice(1)}\``);
+      ajouter(d.slice('./scripts/'.length), `\`${name}${entree.slice(1)}\``);
+    }
+  }
+  const scripts = path.join(PAQUET, 'scripts');
+  for (const e of readdirSync(scripts, { recursive: true, withFileTypes: true })) {
+    const s = path.relative(scripts, path.join(e.parentPath, e.name)).split(path.sep).join('/');
+    if (e.isFile() && SCRIPT.test(s) && !r.has(s)) {
+      r.set(s, []);
     }
   }
   return r;
 }
-// A script named at its former address: `scripts/<chemin>`, alone or after `./` or `$VAR/`.
-const ADRESSE = /(?<![\w./-])(?:\.\/|\$\{?\w+\}?\/)?scripts\/([\w./-]+?\.(?:mjs|sh))(?![\w.-])/g;
-// The same, as the segments of a path.join: `'scripts', 'dette.mjs'`.
-const SEGMENTS = /(['"])scripts\1((?:\s*,\s*(['"])[\w.-]+\3)+)/g;
+const SCRIPT = /\.(?:mjs|sh)$/;
 const SANS = /(^|\/)(?:node_modules\/|CHANGELOG\.md$)/;
+// What separates the words of a line, and the arguments of a call.
+const BLANCS = /[\s'"`();|&<>=,]+/;
+const APPELS = /[();]/;
+const cite = a => a.length >= 2 && /^['"`]$/.test(a[0]) && a.at(-1) === a[0];
+// Whether a piece of a path names a directory: `.` and `..` name none, only a step.
+const dossier = m => m !== '.' && m !== '..';
+
+// The paths under `scripts/` that the line <ligne> names at a project's root, each as its pieces
+// after `scripts`: a word cut at its `/` (`scripts/x.mjs`, `./scripts/x.mjs`, `../scripts/x.mjs`,
+// `$RACINE/scripts/x.mjs`, `file://$1/scripts/x.mjs`), whose piece before `scripts` is none, a
+// step (`.`, `..`) or a variable; the arguments of a call (`path.join(RACINE, 'scripts', 'd',
+// 'x.mjs')`, `path.join(dir, '..', 'scripts', 'x.mjs')`), whose argument before `'scripts'` is
+// none, no literal or a step, the literals after it its pieces. A `scripts/` under a literal
+// directory (`packages/a/scripts/`, the installed package) is another's.
+function sousScripts(ligne) {
+  const chemins = [];
+  for (const mot of ligne.split(BLANCS)) {
+    const p = mot.split('/');
+    p.forEach((m, i) => {
+      if (m === 'scripts' && (i === 0 || !dossier(p[i - 1]) || p[i - 1].startsWith('$'))) {
+        chemins.push(p.slice(i + 1));
+      }
+    });
+  }
+  for (const appel of ligne.split(APPELS)) {
+    const a = appel.split(',').map(x => x.trim());
+    a.forEach((x, i) => {
+      const avant = a[i - 1];
+      const libre = i === 0 || !cite(avant) || !dossier(avant.slice(1, -1));
+      if (cite(x) && x.slice(1, -1) === 'scripts' && libre) {
+        const suite = a.slice(i + 1);
+        const fin = suite.findIndex(y => !cite(y));
+        chemins.push(suite.slice(0, fin === -1 ? suite.length : fin).map(y => y.slice(1, -1)));
+      }
+    });
+  }
+  return chemins;
+}
 
 /** The lines of the tracked files of <projet> that still reach a script of the frame at its former address. */
 export function restes(projet) {
@@ -202,23 +249,19 @@ export function restes(projet) {
       continue;
     }
     texte.split('\n').forEach((ligne, i) => {
-      const scripts = [
-        ...[...ligne.matchAll(ADRESSE)].map(m => m[1]),
-        ...[...ligne.matchAll(SEGMENTS)].map(m =>
-          m[2]
-            .split(',')
-            .map(s => s.trim().slice(1, -1))
-            .filter(Boolean)
-            .join('/')
-        ),
-      ];
+      const scripts = sousScripts(ligne).flatMap(pieces =>
+        pieces.map((_, n) => pieces.slice(0, n + 1).join('/')).filter(s => par.has(s))
+      );
       for (const s of new Set(scripts)) {
-        if (!par.has(s) || existsSync(path.join(projet, 'scripts', s))) {
+        const quoi = par.get(s);
+        if (existsSync(path.join(projet, 'scripts', s))) {
           continue;
         }
-        sortie.push(
-          `${f}:${i + 1} : appelle scripts/${s}, copie du cadre retirée ; ${par.get(s).join(' ou ')} la remplace`
-        );
+        const suite =
+          quoi.length > 0
+            ? `${quoi.join(' ou ')} la remplace`
+            : 'aucune entrée publiée ne la remplace';
+        sortie.push(`${f}:${i + 1} : appelle scripts/${s}, copie du cadre retirée ; ${suite}`);
       }
     });
   }