@nage-api/compat 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,215 @@
+# @nage-api/compat
+
+Migration tooling for an application moving off `nest-core-v2` (PLAN.md §23, §25 P1).
+
+Two halves that share nothing but a release:
+
+- a **runtime shim** that lets a ported controller keep answering old clients in
+  the old shape, so the controller and its callers can move weeks apart;
+- **codemods**, a build-time tool that an application never loads.
+
+The package is temporary by design. When no route carries `@LegacyEnvelope()`
+any more, delete the import and the dependency; nothing else holds it in place.
+
+## Which output to trust
+
+Every codemod declares a `kind`, and the distinction is the whole point of this
+surface. A codemod that is right most of the time is worse than no codemod: it
+produces a large, plausible diff that gets approved by scrolling.
+
+| Codemod            | Kind        | What it does                                                                                                                            |
+| ------------------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| `import-paths`     | **rewrite** | Repoints `…/core.responses` at `@nage-api/compat` and `…/core.decorators` at `@nage-api/core`. Reports the other eleven legacy modules. |
+| `env-rename`       | **rewrite** | Fixes the `RECAPTCHA_SECRET_KET` typo in source and `.env`. Reports `JWT_SECRET` and `APP_ENGINE`.                                      |
+| `res-envelope`     | report      | Locates every `@Res()` handler and manual envelope build, and says which of three ports each one is.                                    |
+| `config-inventory` | report      | Inventories every environment variable and config namespace the app reads — the input to `env.schema.ts`.                               |
+| `job-generics`     | report      | Locates the `any`s that defeated the legacy `Job` / `ModelService` generics.                                                            |
+
+A **rewrite** edits the file, and only where the result is what a careful
+developer would have typed: the two rewritten specifiers move name for name onto
+successors this repository ships, and the rewrite is skipped entirely if any name
+on the import has no successor. A **report** never edits anything; it prints
+`path:line`, what is wrong there and what to do, because the decision needs a
+fact the source does not carry.
+
+`runCodemods` enforces that: a codemod declared as a report that returns a file
+change throws rather than writing it.
+
+## Running them
+
+```text
+npx nage-codemod ../nest-core-v2            # report only; nothing is written
+npx nage-codemod ../nest-core-v2 --write    # apply the rewrites
+npx nage-codemod ../nest-core-v2 --only import-paths --write
+npx nage-codemod --list
+```
+
+Reporting is the default and `--write` is opt-in, which is the inverse of most
+codemod runners. Three of the five produce nothing but notes, so the useful first
+run is a read-only one.
+
+The same thing programmatically, for a runner of your own:
+
+```ts
+import { runCodemods } from '@nage-api/compat';
+
+const report = runCodemods({
+  files: [
+    {
+      path: 'src/order.controller.ts',
+      content: "import { Result } from '../../core/core.responses';\n",
+    },
+  ],
+});
+
+// `changed` lists the paths whose content differs; `files` carries every file,
+// edited or not, so a caller can write the whole set back or diff it.
+export const rewritten: readonly string[] = report.changed;
+export const toRead: number = report.notes.length;
+```
+
+## Serving the old envelope, one route at a time
+
+`NageCompatModule.forRoot()` changes nothing on its own — the interceptor it
+registers only acts on routes marked `@LegacyEnvelope()`:
+
+```ts
+import { Module } from '@nestjs/common';
+import { NageCompatModule } from '@nage-api/compat';
+
+@Module({ imports: [NageCompatModule.forRoot()] })
+export class AppModule {}
+```
+
+```ts
+import { Controller, Get } from '@nestjs/common';
+import { LegacyEnvelope } from '@nage-api/compat';
+import type { Paginated } from '@nage-api/contracts';
+
+interface Order {
+  readonly id: number;
+  readonly reference: string;
+}
+
+declare const orders: { findAll(): Promise<Paginated<Order>> };
+
+@Controller('orders')
+export class OrderController {
+  /** Ported: returns data, never touches `res`. Old clients still read `records`. */
+  @Get()
+  @LegacyEnvelope()
+  findAll(): Promise<Paginated<Order>> {
+    return orders.findAll();
+  }
+}
+```
+
+That route answers `{ records, offset, limit, count, timestamp }` — the counters
+back at the top level, undoing the `meta.pagination` nesting §16.1 introduced.
+Remove the decorator when the clients have moved and the route rejoins the
+standard envelope.
+
+**The flag is per route, not per application.** `NageCoreModule` registers
+`ResponseInterceptor` unconditionally, so a global switch would have to win a
+race with it decided by module import order — a correctness property invisible at
+the call site. `@LegacyEnvelope()` instead rides on `@NoEnvelope()`, which makes
+the core interceptor stand down for exactly these routes whatever order the
+modules were imported in. It also matches how §23.3 phase 5 says to migrate:
+controller by controller.
+
+## The legacy body is reconstructed, so check it
+
+`nest-core-v2` is not a dependency of this repository and its
+`src/core/core.responses.ts` is not readable from here. The default body is
+rebuilt from the two call sites PLAN.md quotes — `Result(res, { data, message })`
+(§4.1) and `Result(res, { records, offset, limit, count })` (§22) — plus §16.1's
+note that the old envelope stamped `timestamp` on 200s and not on errors. So it
+spreads the payload and stamps a timestamp, which is the only behaviour both
+quoted call sites agree on.
+
+Diff it against your own and, where it differs, supply the builder rather than
+patching this one:
+
+```ts
+import { NageCompatModule, type LegacyBodyBuilder } from '@nage-api/compat';
+import { Module } from '@nestjs/common';
+
+const ourBody: LegacyBodyBuilder = ({ payload, timestamp }) => ({
+  status: 'success',
+  result: payload,
+  timestamp,
+});
+
+@Module({ imports: [NageCompatModule.forRoot({ body: ourBody })] })
+export class AppModule {}
+```
+
+One thing is deliberately not reproduced: the legacy `ErrorResponse` echoed
+`error.message || error` to the client, which is how SQL text and upstream
+response bodies reached callers (§5.2). `legacyErrorBody` takes an already
+sanitised `ErrorPayload`, so the shape comes back and the leak does not.
+
+## `Result` and `Created` for controllers that still hold `@Res()`
+
+The `import-paths` codemod repoints `…/core.responses` here, which makes a
+legacy controller compile and behave inside a `@nage-api` application before anyone
+touches its signature:
+
+```ts
+import { Controller, Get, Res } from '@nestjs/common';
+import { Result, type LegacyResponse } from '@nage-api/compat';
+
+@Controller('orders')
+export class OrderController {
+  @Get()
+  findAll(@Res() res: LegacyResponse): unknown {
+    return Result(res, { records: [], offset: 0, limit: 10, count: 0 });
+  }
+}
+```
+
+This is a step, not a destination. A handler with `@Res()` in its signature is in
+library-specific mode: Nest ignores what it returns, `ResponseInterceptor` never
+sees the value and `AllExceptionsFilter` never sees its errors. That is the defect
+§16.1 replaced, and `res-envelope` lists every site of it.
+
+The response is typed as `LegacyResponse` — two methods — rather than Express's
+`Response`, so this package pulls no HTTP framework into an application running
+Fastify, and a test can pass an object literal.
+
+## What this deliberately does not do
+
+- **It does not repeat `nage doctor --legacy`.** That scan finds the insecure
+  literals the legacy framework shipped — `rejectUnauthorized: false`,
+  `enableCors()`, `Math.random(`, `synchronize: true`, the seeded credentials.
+  Run it first; nothing here duplicates it.
+- **It does not rewrite `Result(res, x)` to `return x`.** Rewriting the body
+  without removing the `@Res()` parameter produces a route that hangs, and
+  removing a parameter changes the signature, its callers and its tests — none of
+  which is decidable from the line being rewritten. `res-envelope` reports each
+  site with which of the three shapes it is.
+- **It does not repoint `…/core.errors`.** `NotFoundError` and `ValidationError`
+  exist in `@nage-api/core` under the same names, so that rewrite would compile — and
+  change the status code and the stable `error.code` the client receives. A
+  rewrite whose failure mode is a passing build is the one not to make.
+- **It ships no entity/schema introspection codemod**, though §23.4 names one.
+  Its input is a live database's `information_schema` rather than source; its
+  output is a migration in a format `nage db migrate` cannot yet apply; and
+  nothing here could test it against a real schema. Written against a guess it
+  would be the most dangerous artefact in the set — a plausible schema migration
+  for a production database.
+
+## Not yet implemented
+
+- **Errors on a `@LegacyEnvelope()` route still get the new error envelope.**
+  `AllExceptionsFilter` is global and this package does not replace it. Restoring
+  the old error body would mean a second filter carrying its own copy of the
+  status mapping, and the old shape is the one that leaked.
+- **`@NoEnvelope()` and `@LegacyEnvelope()` cannot both be meaningful on one
+  route**; the second is built from the first.
+- **None of this has been validated against a real `nest-core-v2` application.**
+  §28.10 asks for the migration guide to be proved by porting one end to end, and
+  no such application is reachable from this repository. The codemods are tested
+  against before/after fixtures written from PLAN.md's evidence, which proves they
+  do what they say — not that what they say covers a real codebase. Treat the
+  first run on a real repository as the review it is.

package/dist/cli.d.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+/**
+ * The `nage-codemod` executable.
+ *
+ * The only file in this package that reads `process` or touches disk; everything
+ * it calls is a function a test invokes directly.
+ */
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * The `nage-codemod` executable.
+ *
+ * The only file in this package that reads `process` or touches disk; everything
+ * it calls is a function a test invokes directly.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_js_1 = require("./codemods/node-fs.js");
+const cli_main_js_1 = require("./codemods/cli-main.js");
+(0, cli_main_js_1.runCodemodCli)({
+    argv: process.argv.slice(2),
+    cwd: process.cwd(),
+    io: {
+        out: (message) => void process.stdout.write(message),
+        err: (message) => void process.stderr.write(message),
+    },
+    fs: (0, node_fs_js_1.nodeCodemodFs)(),
+})
+    .then((code) => {
+    // `exitCode` rather than `exit()`: piped output is truncated otherwise.
+    process.exitCode = code;
+})
+    .catch((error) => {
+    process.stderr.write(`✖ ${error instanceof Error ? (error.stack ?? error.message) : String(error)}\n`);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=cli.js.map

package/dist/codemods/cli-main.d.ts

@@ -0,0 +1,32 @@
+/**
+ * `nage-codemod` — the command layer (PLAN.md §23.4).
+ *
+ * Everything here is a pure function of its arguments and two injected ports, so
+ * the whole command is testable without a filesystem or a process. The bin
+ * (`src/cli.ts`) is the only file that reads `process` or touches disk.
+ *
+ * Reporting is the default and `--write` is opt-in, which is the inverse of most
+ * codemod runners. The reason is the shape of this tool: three of its five
+ * codemods produce nothing but notes, so the useful first run is a read-only
+ * one, and a developer who has to ask for the edits has already decided to look
+ * at them.
+ */
+export interface CodemodIo {
+    out(message: string): void;
+    err(message: string): void;
+}
+/** The filesystem operations the runner needs, so tests can supply a fake. */
+export interface CodemodFileSystem {
+    /** Every candidate file under `root`, as paths `read`/`write` accept. */
+    list(root: string): Promise<readonly string[]>;
+    read(path: string): Promise<string>;
+    write(path: string, content: string): Promise<void>;
+}
+export interface CodemodCliOptions {
+    readonly argv: readonly string[];
+    readonly cwd: string;
+    readonly io: CodemodIo;
+    readonly fs: CodemodFileSystem;
+}
+export declare function runCodemodCli(options: CodemodCliOptions): Promise<number>;
+//# sourceMappingURL=cli-main.d.ts.map

package/dist/codemods/cli-main.js

@@ -0,0 +1,128 @@
+"use strict";
+/**
+ * `nage-codemod` — the command layer (PLAN.md §23.4).
+ *
+ * Everything here is a pure function of its arguments and two injected ports, so
+ * the whole command is testable without a filesystem or a process. The bin
+ * (`src/cli.ts`) is the only file that reads `process` or touches disk.
+ *
+ * Reporting is the default and `--write` is opt-in, which is the inverse of most
+ * codemod runners. The reason is the shape of this tool: three of its five
+ * codemods produce nothing but notes, so the useful first run is a read-only
+ * one, and a developer who has to ask for the edits has already decided to look
+ * at them.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCodemodCli = runCodemodCli;
+const node_util_1 = require("node:util");
+const registry_js_1 = require("./registry.js");
+const runner_js_1 = require("./runner.js");
+const types_js_1 = require("./types.js");
+const USAGE = `nage-codemod — migration codemods for nest-core-v2 → @nage-api (PLAN.md §23.4)
+
+  nage-codemod <path> [options]
+
+Options:
+  --only <names>   comma-separated codemod names (default: all)
+  --write          apply the rewrites; without it nothing is written
+  --list           list the codemods and what each one is
+  -h, --help       this text
+
+A "rewrite" codemod edits files. A "report" codemod never does: it prints the
+places a change is needed and what the change is, because the decision needs a
+fact the source does not carry. Trust the rewrites; read the reports.
+`;
+function listCodemods(io) {
+    io.out('\n');
+    for (const codemod of registry_js_1.CODEMODS) {
+        io.out(`  ${codemod.kind.padEnd(8)} ${codemod.name.padEnd(18)} ${codemod.section}\n`);
+        io.out(`  ${' '.repeat(8)} ${codemod.summary}\n\n`);
+    }
+    return 0;
+}
+/** `.env` files carry variable names too, so they are read alongside source. */
+function isCandidate(path) {
+    const name = path.split(/[/\\]/).pop() ?? '';
+    return (0, types_js_1.isSourceFile)(path) || name === '.env' || name.startsWith('.env.');
+}
+async function runCodemodCli(options) {
+    const { io } = options;
+    let parsed;
+    try {
+        parsed = (0, node_util_1.parseArgs)({
+            args: [...options.argv],
+            options: {
+                only: { type: 'string' },
+                write: { type: 'boolean' },
+                list: { type: 'boolean' },
+                help: { type: 'boolean', short: 'h' },
+            },
+            allowPositionals: true,
+        });
+    }
+    catch (error) {
+        io.err(`✖ ${error instanceof Error ? error.message : String(error)}\n`);
+        return 1;
+    }
+    if (parsed.values.help === true) {
+        io.out(USAGE);
+        return 0;
+    }
+    if (parsed.values.list === true)
+        return listCodemods(io);
+    const root = parsed.positionals[0];
+    if (root === undefined) {
+        io.err('✖ a path to scan is required.\n\n');
+        io.err(USAGE);
+        return 1;
+    }
+    let only;
+    if (parsed.values.only !== undefined) {
+        only = parsed.values.only.split(',').map((name) => name.trim());
+        const unknown = only.filter((name) => (0, registry_js_1.findCodemod)(name) === undefined);
+        if (unknown.length > 0) {
+            io.err(`✖ unknown codemod(s): ${unknown.join(', ')}\n`);
+            io.err(`  known: ${registry_js_1.CODEMODS.map((codemod) => codemod.name).join(', ')}\n`);
+            return 1;
+        }
+    }
+    const paths = (await options.fs.list(root)).filter(isCandidate);
+    const files = [];
+    for (const path of paths)
+        files.push({ path, content: await options.fs.read(path) });
+    const report = (0, runner_js_1.runCodemods)({ files, ...(only === undefined ? {} : { only }) });
+    io.out(`\nScanned ${String(files.length)} file(s) under ${root}\n`);
+    for (const codemod of only === undefined
+        ? registry_js_1.CODEMODS
+        : registry_js_1.CODEMODS.filter((c) => only.includes(c.name))) {
+        const edits = report.edits.filter((edit) => edit.codemod === codemod.name);
+        const notes = report.notes.filter((note) => note.codemod === codemod.name);
+        if (edits.length === 0 && notes.length === 0)
+            continue;
+        io.out(`\n── ${codemod.name} (${codemod.kind}, ${codemod.section}) ──\n`);
+        for (const edit of edits) {
+            io.out(`\n  ${edit.path}:${String(edit.line)}\n`);
+            io.out(`    - ${edit.before}\n`);
+            io.out(`    + ${edit.after}\n`);
+        }
+        for (const note of notes) {
+            io.out(`\n  ${note.path}:${String(note.line)}  [${note.rule}]\n`);
+            io.out(`    ${note.message}\n`);
+            io.out(`    → ${note.action}\n`);
+        }
+    }
+    if (parsed.values.write === true) {
+        for (const path of report.changed) {
+            const file = report.files.find((candidate) => candidate.path === path);
+            if (file !== undefined)
+                await options.fs.write(path, file.content);
+        }
+        io.out(`\n${String(report.changed.length)} file(s) rewritten.\n`);
+    }
+    else if (report.changed.length > 0) {
+        io.out(`\n${String(report.changed.length)} file(s) would be rewritten — nothing was written. Pass --write to apply.\n`);
+    }
+    io.out(`${String(report.notes.length)} note(s) to read.\n`);
+    return 0;
+}
+//# sourceMappingURL=cli-main.js.map

package/dist/codemods/config-inventory.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Config blob → `defineConfig` (PLAN.md §23.4) — as a report.
+ *
+ * `docs/migration.md` already reached this conclusion in prose: "mapping your
+ * old configuration onto this is the least mechanical part of the whole
+ * migration, and it is worth doing by hand rather than transliterating". The
+ * reason is that the legacy shape carries less information than the new one
+ * needs. `env.get<string>('DATABASE_URL')` is a cast, not a check, so the source
+ * says nothing about whether the value is required, what it must look like, or
+ * what happens when it is absent — and those three answers *are* the zod schema.
+ *
+ * What a machine can do is the tedious half: find every variable the application
+ * reads, wherever it reads it from, so the schema is written against a list
+ * rather than against memory. That is what this produces — one note per distinct
+ * variable, at its first use, plus a note at each site where a default is
+ * hiding a misconfiguration.
+ */
+import { type Codemod } from './types.js';
+export declare const configInventoryCodemod: Codemod;
+//# sourceMappingURL=config-inventory.d.ts.map