@venizia/dev-configs 0.4.1 → 0.4.3

package/README.md

@@ -169,10 +169,12 @@ booleans. `BrowserOxlintConfigs.create()` and `ReactOxlintConfigs.create()` take
 | `MaxParamsOwnRule` | `venizia/max-params-own` | `build({ max: 5 })` | A function we write takes at most `max` positional parameters. Not counted: an inline callback passed to a call or a JSX prop, a signature a declared type fixes, a constructor whose parameters are all `@inject`. A hook callback counts. |
 | `NoNewErrorRule` | `venizia/no-new-error` | `error` | Throw through `getError` (or an `ApplicationError`), never `new Error(...)` / `Error(...)`. Off in tests. |
 | `NoLeakedRenderRule` | `venizia/no-leaked-render` | `error`, in `reactHouseConfigs` only | A JSX child is drawn with `cond ? <X /> : null`, never `cond && <X />`, which draws `0` when `cond` is `0`. `--fix` rewrites it. `disabled={a && b}` is a value, not a child, and passes. |
-| `ConstClassValuesRule` | `venizia/const-class-values` | off; `build({ namePattern })` | An exported type named like a logic value (`State`, `Status`, `Stage`, `Mode`, `Kind`, `Type` by default) is a const class plus `TConstValue<typeof X>`, not a union of string literals. |
+| `ConstClassValuesRule` | `venizia/const-class-values` | `warn` in both presets; `build({ severity, namePattern })` | V-C-08. A union of string literals in an exported declaration (a type alias, an interface member, a generic constraint, a parameter or return type) is a const class plus `TConstValue<typeof X>`. Not counted: `Pick`, `Omit`, `Extract`, `Exclude`, `Record` arguments and mapped-type keys, and a union with a non-string member. `namePattern` narrows it to exported type aliases whose name matches. Off in tests. |
+| `@typescript-eslint/consistent-type-assertions` | `assertionStyle: never` | `warn` in both presets | V-C-10. `as X`, `as any` and `as unknown as X` warn; `as const` and `satisfies` do not. Off in tests. |
 
-`const-class-values` is registered in the plugin but no preset turns it on: a few IGNIS types still
-break it. Enable it with `[ConstClassValuesRule.NAME]: ConstClassValuesRule.build()`.
+`const-class-values` and the cast rule only warn, so adopting them never fails a lint. Raise one to an error
+with `[ConstClassValuesRule.NAME]: ConstClassValuesRule.build({ severity: 'error' })`. The 5-parameter
+limit (V-C-02) is `venizia/max-params-own`, an error.
 
 ### namingConventionConfigs
 

package/dist/cli/clean.d.ts

@@ -1,7 +1,8 @@
-/** `devz clean`: removes what the build and the checks generate, and nothing else. */
+/** `devz clean`: removes what the build and the checks generate, and nothing else. `--help` prints the usage; any other argument is refused, and nothing is deleted. */
 export declare class CleanCommand {
     static run(opts: {
         root: string;
+        args?: string[];
     }): number;
 }
 //# sourceMappingURL=clean.d.ts.map

package/dist/cli/clean.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clean.d.ts","sourceRoot":"","sources":["../../src/cli/clean.ts"],"names":[],"mappings":"AAMA,sFAAsF;AACtF,qBAAa,YAAY;IACvB,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;CAO3C"}
+{"version":3,"file":"clean.d.ts","sourceRoot":"","sources":["../../src/cli/clean.ts"],"names":[],"mappings":"AAsBA,wKAAwK;AACxK,qBAAa,YAAY;IACvB,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,MAAM;CA2B5D"}

package/dist/cli/clean.js

@@ -5,12 +5,39 @@ const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 /** What a build and the checks generate, relative to the project root. */
 const GENERATED_PATHS = ['dist', 'node_modules/.cache'];
-/** `devz clean`: removes what the build and the checks generate, and nothing else. */
+/**
+ * `incremental` is on in the base tsconfig, so a type-check that emits nothing leaves
+ * `<tsconfig name>.tsbuildinfo` next to the tsconfig. One inside `dist` is already removed with it.
+ */
+const BUILD_INFO_SUFFIX = '.tsbuildinfo';
+const USAGE = `Usage: devz clean
+
+Removes what the build and the checks generate, in the current folder: dist, node_modules/.cache and
+the *.tsbuildinfo files next to the tsconfig. It takes no argument.
+
+  --help     print this text and exit`;
+/** A usage error: nothing was deleted. */
+const USAGE_ERROR_CODE = 2;
+/** `devz clean`: removes what the build and the checks generate, and nothing else. `--help` prints the usage; any other argument is refused, and nothing is deleted. */
 class CleanCommand {
     static run(opts) {
+        const { args = [] } = opts;
+        if (args.includes('--help') || args.includes('-h')) {
+            console.log(USAGE);
+            return 0;
+        }
+        if (args.length > 0) {
+            console.error(`devz clean: unexpected argument ${args.map((arg) => `"${arg}"`).join(', ')}\n${USAGE}`);
+            return USAGE_ERROR_CODE;
+        }
         for (const path of GENERATED_PATHS) {
             (0, node_fs_1.rmSync)((0, node_path_1.join)(opts.root, path), { recursive: true, force: true });
         }
+        for (const entry of (0, node_fs_1.readdirSync)(opts.root, { withFileTypes: true })) {
+            if (entry.isFile() && entry.name.endsWith(BUILD_INFO_SUFFIX)) {
+                (0, node_fs_1.rmSync)((0, node_path_1.join)(opts.root, entry.name), { force: true });
+            }
+        }
         return 0;
     }
 }

package/dist/cli/clean.js.map

@@ -1 +1 @@
-{"version":3,"file":"clean.js","sourceRoot":"","sources":["../../src/cli/clean.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AACjC,yCAAiC;AAEjC,0EAA0E;AAC1E,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;AAExD,sFAAsF;AACtF,MAAa,YAAY;IACvB,MAAM,CAAC,GAAG,CAAC,IAAsB;QAC/B,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;YACnC,IAAA,gBAAM,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AARD,oCAQC","sourcesContent":["import { rmSync } from 'node:fs';\nimport { join } from 'node:path';\n\n/** What a build and the checks generate, relative to the project root. */\nconst GENERATED_PATHS = ['dist', 'node_modules/.cache'];\n\n/** `devz clean`: removes what the build and the checks generate, and nothing else. */\nexport class CleanCommand {\n  static run(opts: { root: string }): number {\n    for (const path of GENERATED_PATHS) {\n      rmSync(join(opts.root, path), { recursive: true, force: true });\n    }\n\n    return 0;\n  }\n}\n"]}
+{"version":3,"file":"clean.js","sourceRoot":"","sources":["../../src/cli/clean.ts"],"names":[],"mappings":";;;AAAA,qCAA8C;AAC9C,yCAAiC;AAEjC,0EAA0E;AAC1E,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAEzC,MAAM,KAAK,GAAG;;;;;sCAKwB,CAAC;AAEvC,0CAA0C;AAC1C,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,wKAAwK;AACxK,MAAa,YAAY;IACvB,MAAM,CAAC,GAAG,CAAC,IAAuC;QAChD,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CACX,mCAAmC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CACxF,CAAC;YACF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;YACnC,IAAA,gBAAM,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAA,qBAAW,EAAC,IAAI,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YACpE,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAC7D,IAAA,gBAAM,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AA5BD,oCA4BC","sourcesContent":["import { readdirSync, rmSync } from 'node:fs';\nimport { join } from 'node:path';\n\n/** What a build and the checks generate, relative to the project root. */\nconst GENERATED_PATHS = ['dist', 'node_modules/.cache'];\n\n/**\n * `incremental` is on in the base tsconfig, so a type-check that emits nothing leaves\n * `<tsconfig name>.tsbuildinfo` next to the tsconfig. One inside `dist` is already removed with it.\n */\nconst BUILD_INFO_SUFFIX = '.tsbuildinfo';\n\nconst USAGE = `Usage: devz clean\n\nRemoves what the build and the checks generate, in the current folder: dist, node_modules/.cache and\nthe *.tsbuildinfo files next to the tsconfig. It takes no argument.\n\n  --help     print this text and exit`;\n\n/** A usage error: nothing was deleted. */\nconst USAGE_ERROR_CODE = 2;\n\n/** `devz clean`: removes what the build and the checks generate, and nothing else. `--help` prints the usage; any other argument is refused, and nothing is deleted. */\nexport class CleanCommand {\n  static run(opts: { root: string; args?: string[] }): number {\n    const { args = [] } = opts;\n\n    if (args.includes('--help') || args.includes('-h')) {\n      console.log(USAGE);\n      return 0;\n    }\n\n    if (args.length > 0) {\n      console.error(\n        `devz clean: unexpected argument ${args.map((arg) => `\"${arg}\"`).join(', ')}\\n${USAGE}`,\n      );\n      return USAGE_ERROR_CODE;\n    }\n\n    for (const path of GENERATED_PATHS) {\n      rmSync(join(opts.root, path), { recursive: true, force: true });\n    }\n\n    for (const entry of readdirSync(opts.root, { withFileTypes: true })) {\n      if (entry.isFile() && entry.name.endsWith(BUILD_INFO_SUFFIX)) {\n        rmSync(join(opts.root, entry.name), { force: true });\n      }\n    }\n\n    return 0;\n  }\n}\n"]}

package/dist/cli/codemod/files.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The source files a codemod may touch. Inside a git repository the list comes from git, so a
+ * `.gitignore`d folder (a worktree, a clone, a build output) is never entered. Outside git there is
+ * no ignore file to read, so the walk skips every dot-directory as well as `node_modules`, `dist`,
+ * `build` and `.git`.
+ */
+export declare class CodemodFiles {
+    /** Every `.ts`, `.tsx`, `.mts` or `.cts` file (declaration files excluded) the codemod may touch under `target`; a file target is returned as it is. */
+    static collect(opts: {
+        target: string;
+    }): string[];
+    /** Tracked files plus untracked files git does not ignore; `undefined` outside a repository or without git. */
+    static fromGit(opts: {
+        target: string;
+    }): string[] | undefined;
+    /** The directory walk used outside git: skips dot-directories and the build folders. */
+    static fromWalk(opts: {
+        target: string;
+    }): string[];
+    private static isSource;
+}
+//# sourceMappingURL=files.d.ts.map

package/dist/cli/codemod/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/cli/codemod/files.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,qBAAa,YAAY;IACvB,wJAAwJ;IACxJ,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE;IAUlD,+GAA+G;IAC/G,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE,GAAG,SAAS;IA2B9D,wFAAwF;IACxF,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE;IAoBnD,OAAO,CAAC,MAAM,CAAC,QAAQ;CAGxB"}

package/dist/cli/codemod/files.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodemodFiles = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const SKIPPED_DIRECTORIES = new Set(['node_modules', 'dist', 'build', '.git']);
+const SOURCE_PATTERN = /\.(?:ts|tsx|mts|cts)$/;
+/**
+ * The source files a codemod may touch. Inside a git repository the list comes from git, so a
+ * `.gitignore`d folder (a worktree, a clone, a build output) is never entered. Outside git there is
+ * no ignore file to read, so the walk skips every dot-directory as well as `node_modules`, `dist`,
+ * `build` and `.git`.
+ */
+class CodemodFiles {
+    /** Every `.ts`, `.tsx`, `.mts` or `.cts` file (declaration files excluded) the codemod may touch under `target`; a file target is returned as it is. */
+    static collect(opts) {
+        const { target } = opts;
+        if ((0, node_fs_1.statSync)(target).isFile()) {
+            return [target];
+        }
+        return CodemodFiles.fromGit({ target }) ?? CodemodFiles.fromWalk({ target });
+    }
+    /** Tracked files plus untracked files git does not ignore; `undefined` outside a repository or without git. */
+    static fromGit(opts) {
+        const { target } = opts;
+        let output;
+        try {
+            output = (0, node_child_process_1.execFileSync)('git', ['ls-files', '--cached', '--others', '--exclude-standard', '-z'], {
+                cwd: target,
+                encoding: 'utf8',
+                maxBuffer: 256 * 1024 * 1024,
+                stdio: ['ignore', 'pipe', 'ignore'],
+            });
+        }
+        catch {
+            return undefined;
+        }
+        return output
+            .split('\0')
+            .filter((path) => path !== '' && CodemodFiles.isSource({ name: path }))
+            .filter((path) => !path.split('/').some((segment) => SKIPPED_DIRECTORIES.has(segment)))
+            .map((path) => (0, node_path_1.join)(target, path))
+            .filter((path) => (0, node_fs_1.existsSync)(path) && (0, node_fs_1.statSync)(path).isFile());
+    }
+    /** The directory walk used outside git: skips dot-directories and the build folders. */
+    static fromWalk(opts) {
+        const { target } = opts;
+        const files = [];
+        for (const entry of (0, node_fs_1.readdirSync)(target, { withFileTypes: true })) {
+            if (entry.isDirectory()) {
+                if (!SKIPPED_DIRECTORIES.has(entry.name) && !entry.name.startsWith('.')) {
+                    files.push(...CodemodFiles.fromWalk({ target: (0, node_path_1.join)(target, entry.name) }));
+                }
+                continue;
+            }
+            if (CodemodFiles.isSource({ name: entry.name })) {
+                files.push((0, node_path_1.join)(target, entry.name));
+            }
+        }
+        return files;
+    }
+    static isSource(opts) {
+        return SOURCE_PATTERN.test(opts.name) && !opts.name.endsWith('.d.ts');
+    }
+}
+exports.CodemodFiles = CodemodFiles;
+//# sourceMappingURL=files.js.map

package/dist/cli/codemod/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/cli/codemod/files.ts"],"names":[],"mappings":";;;AAAA,2DAAkD;AAClD,qCAA4D;AAC5D,yCAAiC;AAEjC,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAC/E,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAE/C;;;;;GAKG;AACH,MAAa,YAAY;IACvB,wJAAwJ;IACxJ,MAAM,CAAC,OAAO,CAAC,IAAwB;QACrC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,IAAI,IAAA,kBAAQ,EAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;YAC9B,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC;QAED,OAAO,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,+GAA+G;IAC/G,MAAM,CAAC,OAAO,CAAC,IAAwB;QACrC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,IAAI,MAAc,CAAC;QAEnB,IAAI,CAAC;YACH,MAAM,GAAG,IAAA,iCAAY,EACnB,KAAK,EACL,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAChE;gBACE,GAAG,EAAE,MAAM;gBACX,QAAQ,EAAE,MAAM;gBAChB,SAAS,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI;gBAC5B,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC;aACpC,CACF,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,MAAM;aACV,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;aACtE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;aACtF,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;aACjC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,oBAAU,EAAC,IAAI,CAAC,IAAI,IAAA,kBAAQ,EAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,wFAAwF;IACxF,MAAM,CAAC,QAAQ,CAAC,IAAwB;QACtC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,MAAM,KAAK,IAAI,IAAA,qBAAW,EAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YACjE,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxE,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAA,gBAAI,EAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC7E,CAAC;gBACD,SAAS;YACX,CAAC;YAED,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBAChD,KAAK,CAAC,IAAI,CAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC5C,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AAhED,oCAgEC","sourcesContent":["import { execFileSync } from 'node:child_process';\nimport { existsSync, readdirSync, statSync } from 'node:fs';\nimport { join } from 'node:path';\n\nconst SKIPPED_DIRECTORIES = new Set(['node_modules', 'dist', 'build', '.git']);\nconst SOURCE_PATTERN = /\\.(?:ts|tsx|mts|cts)$/;\n\n/**\n * The source files a codemod may touch. Inside a git repository the list comes from git, so a\n * `.gitignore`d folder (a worktree, a clone, a build output) is never entered. Outside git there is\n * no ignore file to read, so the walk skips every dot-directory as well as `node_modules`, `dist`,\n * `build` and `.git`.\n */\nexport class CodemodFiles {\n  /** Every `.ts`, `.tsx`, `.mts` or `.cts` file (declaration files excluded) the codemod may touch under `target`; a file target is returned as it is. */\n  static collect(opts: { target: string }): string[] {\n    const { target } = opts;\n\n    if (statSync(target).isFile()) {\n      return [target];\n    }\n\n    return CodemodFiles.fromGit({ target }) ?? CodemodFiles.fromWalk({ target });\n  }\n\n  /** Tracked files plus untracked files git does not ignore; `undefined` outside a repository or without git. */\n  static fromGit(opts: { target: string }): string[] | undefined {\n    const { target } = opts;\n    let output: string;\n\n    try {\n      output = execFileSync(\n        'git',\n        ['ls-files', '--cached', '--others', '--exclude-standard', '-z'],\n        {\n          cwd: target,\n          encoding: 'utf8',\n          maxBuffer: 256 * 1024 * 1024,\n          stdio: ['ignore', 'pipe', 'ignore'],\n        },\n      );\n    } catch {\n      return undefined;\n    }\n\n    return output\n      .split('\\0')\n      .filter((path) => path !== '' && CodemodFiles.isSource({ name: path }))\n      .filter((path) => !path.split('/').some((segment) => SKIPPED_DIRECTORIES.has(segment)))\n      .map((path) => join(target, path))\n      .filter((path) => existsSync(path) && statSync(path).isFile());\n  }\n\n  /** The directory walk used outside git: skips dot-directories and the build folders. */\n  static fromWalk(opts: { target: string }): string[] {\n    const { target } = opts;\n    const files: string[] = [];\n\n    for (const entry of readdirSync(target, { withFileTypes: true })) {\n      if (entry.isDirectory()) {\n        if (!SKIPPED_DIRECTORIES.has(entry.name) && !entry.name.startsWith('.')) {\n          files.push(...CodemodFiles.fromWalk({ target: join(target, entry.name) }));\n        }\n        continue;\n      }\n\n      if (CodemodFiles.isSource({ name: entry.name })) {\n        files.push(join(target, entry.name));\n      }\n    }\n\n    return files;\n  }\n\n  private static isSource(opts: { name: string }): boolean {\n    return SOURCE_PATTERN.test(opts.name) && !opts.name.endsWith('.d.ts');\n  }\n}\n"]}

package/dist/cli/codemod/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * `devz codemod model-settings [paths...] [--write | --check]`: moves `@model` settings from the
+ * flat keys (`defaultFilter`, `defaultLimit`, `maxLimit`, `scopeFilter`) to `query` and `access`,
+ * and `skipMigrate` to `migration.use`. It is a dry run unless `--write` is given: it lists what
+ * would change. `--check` is the same dry run, and exits 1 when anything would change.
+ */
+export declare class CodemodCommand {
+    static run(opts: {
+        root: string;
+        args: string[];
+    }): Promise<number>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/codemod/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cli/codemod/index.ts"],"names":[],"mappings":"AAqCA;;;;;GAKG;AACH,qBAAa,cAAc;WACZ,GAAG,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CA0F1E"}

package/dist/cli/codemod/index.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodemodCommand = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const files_1 = require("./files");
+const model_settings_1 = require("./model-settings");
+const USAGE = `Usage: devz codemod model-settings [paths...] [--write | --check]
+
+Moves @model settings to the grouped shape and skipMigrate to migration.use.
+
+  --write    write the changed files (without it, nothing is written)
+  --check    dry run that exits 1 when anything would change (for CI)
+  --help     print this text and exit
+
+With no flag it lists what would change and writes nothing. Inside a git repository it reads the
+files git knows (tracked, or untracked and not ignored), so ignored folders are never touched.`;
+/** A usage error: nothing was read or written. */
+const USAGE_ERROR_CODE = 2;
+class CodemodFlags {
+    static { this.WRITE = '--write'; }
+    static { this.CHECK = '--check'; }
+    static { this.HELP = '--help'; }
+    static { this.HELP_SHORT = '-h'; }
+    static { this.SCHEME_SET = new Set([
+        this.WRITE,
+        this.CHECK,
+        this.HELP,
+        this.HELP_SHORT,
+    ]); }
+    static isValid(value) {
+        return this.SCHEME_SET.has(value);
+    }
+}
+/**
+ * `devz codemod model-settings [paths...] [--write | --check]`: moves `@model` settings from the
+ * flat keys (`defaultFilter`, `defaultLimit`, `maxLimit`, `scopeFilter`) to `query` and `access`,
+ * and `skipMigrate` to `migration.use`. It is a dry run unless `--write` is given: it lists what
+ * would change. `--check` is the same dry run, and exits 1 when anything would change.
+ */
+class CodemodCommand {
+    static async run(opts) {
+        const { args } = opts;
+        if (args.includes(CodemodFlags.HELP) || args.includes(CodemodFlags.HELP_SHORT)) {
+            console.log(USAGE);
+            return 0;
+        }
+        const [name, ...rest] = args;
+        if (name !== 'model-settings') {
+            console.error(`devz codemod: unknown codemod "${name ?? ''}"\n${USAGE}`);
+            return USAGE_ERROR_CODE;
+        }
+        const unknown = rest.filter((argument) => argument.startsWith('-') && !CodemodFlags.isValid(argument));
+        if (unknown.length > 0) {
+            console.error(`devz codemod: unknown option ${unknown.map((flag) => `"${flag}"`).join(', ')}\n${USAGE}`);
+            return USAGE_ERROR_CODE;
+        }
+        const isWrite = rest.includes(CodemodFlags.WRITE);
+        const isCheck = rest.includes(CodemodFlags.CHECK);
+        if (isWrite && isCheck) {
+            console.error(`devz codemod: ${CodemodFlags.WRITE} and ${CodemodFlags.CHECK} contradict each other\n${USAGE}`);
+            return USAGE_ERROR_CODE;
+        }
+        const paths = rest.filter((argument) => !argument.startsWith('-'));
+        const targets = (paths.length > 0 ? paths : ['.']).map((path) => (0, node_path_1.resolve)(opts.root, path));
+        let typescript;
+        try {
+            typescript = (await import('typescript')).default;
+        }
+        catch {
+            console.error('devz codemod: the "typescript" package is required to read your sources');
+            return 1;
+        }
+        let changedCount = 0;
+        let reportCount = 0;
+        for (const target of targets) {
+            for (const file of files_1.CodemodFiles.collect({ target })) {
+                const source = (0, node_fs_1.readFileSync)(file, 'utf8');
+                if (!source.includes('@model')) {
+                    continue;
+                }
+                const result = (0, model_settings_1.migrateModelSettings)({ typescript, fileName: file, source });
+                const shown = (0, node_path_1.relative)(opts.root, file) || file;
+                for (const report of result.reports) {
+                    reportCount += 1;
+                    console.warn(`${shown}:${report.line}:${report.column}  ${report.reason}`);
+                }
+                if (!result.changed) {
+                    continue;
+                }
+                changedCount += 1;
+                console.log(`${isWrite ? 'changed' : 'would change'}  ${shown}  (${result.rewritten} model(s))`);
+                if (isWrite) {
+                    (0, node_fs_1.writeFileSync)(file, result.output);
+                }
+            }
+        }
+        console.log(`devz codemod model-settings: ${changedCount} file(s) ${isWrite ? 'changed' : 'would change'}, ${reportCount} left untouched`);
+        if (!isWrite && changedCount > 0) {
+            console.log(`Nothing was written. Run again with ${CodemodFlags.WRITE} to apply.`);
+        }
+        return isCheck && changedCount > 0 ? 1 : 0;
+    }
+}
+exports.CodemodCommand = CodemodCommand;
+//# sourceMappingURL=index.js.map

package/dist/cli/codemod/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cli/codemod/index.ts"],"names":[],"mappings":";;;AAAA,qCAAsD;AACtD,yCAA8C;AAC9C,mCAAuC;AACvC,qDAAwD;AAExD,MAAM,KAAK,GAAG;;;;;;;;;+FASiF,CAAC;AAEhG,kDAAkD;AAClD,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,MAAM,YAAY;aACA,UAAK,GAAG,SAAS,CAAC;aAClB,UAAK,GAAG,SAAS,CAAC;aAClB,SAAI,GAAG,QAAQ,CAAC;aAChB,eAAU,GAAG,IAAI,CAAC;aAElB,eAAU,GAAG,IAAI,GAAG,CAAS;QAC3C,IAAI,CAAC,KAAK;QACV,IAAI,CAAC,KAAK;QACV,IAAI,CAAC,IAAI;QACT,IAAI,CAAC,UAAU;KAChB,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;;AAGH;;;;;GAKG;AACH,MAAa,cAAc;IACzB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAsC;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/E,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE7B,IAAI,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAC9B,OAAO,CAAC,KAAK,CAAC,kCAAkC,IAAI,IAAI,EAAE,MAAM,KAAK,EAAE,CAAC,CAAC;YACzE,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CACzB,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC1E,CAAC;QACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CACX,gCAAgC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAC1F,CAAC;YACF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAElD,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CACX,iBAAiB,YAAY,CAAC,KAAK,QAAQ,YAAY,CAAC,KAAK,2BAA2B,KAAK,EAAE,CAChG,CAAC;YACF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAO,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAE3F,IAAI,UAAuC,CAAC;QAC5C,IAAI,CAAC;YACH,UAAU,GAAG,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;YACzF,OAAO,CAAC,CAAC;QACX,CAAC;QAED,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,IAAI,WAAW,GAAG,CAAC,CAAC;QAEpB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,oBAAY,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;gBACpD,MAAM,MAAM,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAE1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC/B,SAAS;gBACX,CAAC;gBAED,MAAM,MAAM,GAAG,IAAA,qCAAoB,EAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAC5E,MAAM,KAAK,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC;gBAEhD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpC,WAAW,IAAI,CAAC,CAAC;oBACjB,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC7E,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,SAAS;gBACX,CAAC;gBAED,YAAY,IAAI,CAAC,CAAC;gBAClB,OAAO,CAAC,GAAG,CACT,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,KAAK,KAAK,MAAM,MAAM,CAAC,SAAS,YAAY,CACpF,CAAC;gBAEF,IAAI,OAAO,EAAE,CAAC;oBACZ,IAAA,uBAAa,EAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,CACT,gCAAgC,YAAY,YAAY,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,KAAK,WAAW,iBAAiB,CAC9H,CAAC;QAEF,IAAI,CAAC,OAAO,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,GAAG,CAAC,uCAAuC,YAAY,CAAC,KAAK,YAAY,CAAC,CAAC;QACrF,CAAC;QAED,OAAO,OAAO,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;CACF;AA3FD,wCA2FC","sourcesContent":["import { readFileSync, writeFileSync } from 'node:fs';\nimport { relative, resolve } from 'node:path';\nimport { CodemodFiles } from './files';\nimport { migrateModelSettings } from './model-settings';\n\nconst USAGE = `Usage: devz codemod model-settings [paths...] [--write | --check]\n\nMoves @model settings to the grouped shape and skipMigrate to migration.use.\n\n  --write    write the changed files (without it, nothing is written)\n  --check    dry run that exits 1 when anything would change (for CI)\n  --help     print this text and exit\n\nWith no flag it lists what would change and writes nothing. Inside a git repository it reads the\nfiles git knows (tracked, or untracked and not ignored), so ignored folders are never touched.`;\n\n/** A usage error: nothing was read or written. */\nconst USAGE_ERROR_CODE = 2;\n\nclass CodemodFlags {\n  static readonly WRITE = '--write';\n  static readonly CHECK = '--check';\n  static readonly HELP = '--help';\n  static readonly HELP_SHORT = '-h';\n\n  static readonly SCHEME_SET = new Set<string>([\n    this.WRITE,\n    this.CHECK,\n    this.HELP,\n    this.HELP_SHORT,\n  ]);\n\n  static isValid(value: string): boolean {\n    return this.SCHEME_SET.has(value);\n  }\n}\n\n/**\n * `devz codemod model-settings [paths...] [--write | --check]`: moves `@model` settings from the\n * flat keys (`defaultFilter`, `defaultLimit`, `maxLimit`, `scopeFilter`) to `query` and `access`,\n * and `skipMigrate` to `migration.use`. It is a dry run unless `--write` is given: it lists what\n * would change. `--check` is the same dry run, and exits 1 when anything would change.\n */\nexport class CodemodCommand {\n  static async run(opts: { root: string; args: string[] }): Promise<number> {\n    const { args } = opts;\n\n    if (args.includes(CodemodFlags.HELP) || args.includes(CodemodFlags.HELP_SHORT)) {\n      console.log(USAGE);\n      return 0;\n    }\n\n    const [name, ...rest] = args;\n\n    if (name !== 'model-settings') {\n      console.error(`devz codemod: unknown codemod \"${name ?? ''}\"\\n${USAGE}`);\n      return USAGE_ERROR_CODE;\n    }\n\n    const unknown = rest.filter(\n      (argument) => argument.startsWith('-') && !CodemodFlags.isValid(argument),\n    );\n    if (unknown.length > 0) {\n      console.error(\n        `devz codemod: unknown option ${unknown.map((flag) => `\"${flag}\"`).join(', ')}\\n${USAGE}`,\n      );\n      return USAGE_ERROR_CODE;\n    }\n\n    const isWrite = rest.includes(CodemodFlags.WRITE);\n    const isCheck = rest.includes(CodemodFlags.CHECK);\n\n    if (isWrite && isCheck) {\n      console.error(\n        `devz codemod: ${CodemodFlags.WRITE} and ${CodemodFlags.CHECK} contradict each other\\n${USAGE}`,\n      );\n      return USAGE_ERROR_CODE;\n    }\n\n    const paths = rest.filter((argument) => !argument.startsWith('-'));\n    const targets = (paths.length > 0 ? paths : ['.']).map((path) => resolve(opts.root, path));\n\n    let typescript: typeof import('typescript');\n    try {\n      typescript = (await import('typescript')).default;\n    } catch {\n      console.error('devz codemod: the \"typescript\" package is required to read your sources');\n      return 1;\n    }\n\n    let changedCount = 0;\n    let reportCount = 0;\n\n    for (const target of targets) {\n      for (const file of CodemodFiles.collect({ target })) {\n        const source = readFileSync(file, 'utf8');\n\n        if (!source.includes('@model')) {\n          continue;\n        }\n\n        const result = migrateModelSettings({ typescript, fileName: file, source });\n        const shown = relative(opts.root, file) || file;\n\n        for (const report of result.reports) {\n          reportCount += 1;\n          console.warn(`${shown}:${report.line}:${report.column}  ${report.reason}`);\n        }\n\n        if (!result.changed) {\n          continue;\n        }\n\n        changedCount += 1;\n        console.log(\n          `${isWrite ? 'changed' : 'would change'}  ${shown}  (${result.rewritten} model(s))`,\n        );\n\n        if (isWrite) {\n          writeFileSync(file, result.output);\n        }\n      }\n    }\n\n    console.log(\n      `devz codemod model-settings: ${changedCount} file(s) ${isWrite ? 'changed' : 'would change'}, ${reportCount} left untouched`,\n    );\n\n    if (!isWrite && changedCount > 0) {\n      console.log(`Nothing was written. Run again with ${CodemodFlags.WRITE} to apply.`);\n    }\n\n    return isCheck && changedCount > 0 ? 1 : 0;\n  }\n}\n"]}

package/dist/cli/codemod/model-settings.d.ts

@@ -0,0 +1,34 @@
+import type ts from 'typescript';
+type TTypeScript = typeof ts;
+/** One thing the codemod could not decide and left alone. */
+export interface IModelSettingsReport {
+    line: number;
+    column: number;
+    reason: string;
+}
+export interface IModelSettingsResult {
+    /** The source after the migration; equal to the input when nothing changed. */
+    output: string;
+    changed: boolean;
+    /** How many `@model` settings objects were rewritten. */
+    rewritten: number;
+    reports: IModelSettingsReport[];
+}
+/**
+ * Rewrites `@model({ ... })` from the old keys to the grouped ones. `skipMigrate` becomes
+ * `migration: { use: false }`. In the `settings` object literal:
+ * `defaultFilter` to `query.filter`, `defaultLimit` and `maxLimit` to `query.limit.default` and
+ * `query.limit.max`, `scopeFilter` to `access` (`writeGuard` to `write.mode`, `sharedRows` to
+ * `write.sharedRows`).
+ *
+ * It edits by source range, so comments and formatting outside the rewritten properties stay. It
+ * never guesses: a `settings` value that is not an object literal, a spread, a computed key, or a
+ * `scopeFilter` that is not an object literal is reported and the model is left untouched.
+ */
+export declare const migrateModelSettings: (opts: {
+    typescript: TTypeScript;
+    fileName: string;
+    source: string;
+}) => IModelSettingsResult;
+export {};
+//# sourceMappingURL=model-settings.d.ts.map

package/dist/cli/codemod/model-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-settings.d.ts","sourceRoot":"","sources":["../../../src/cli/codemod/model-settings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,KAAK,WAAW,GAAG,OAAO,EAAE,CAAC;AAE7B,6DAA6D;AAC7D,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACjC;AAWD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,MAAM;IACzC,UAAU,EAAE,WAAW,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,KAAG,oBAuXH,CAAC"}