openapi-typesafe-migrate 0.0.0 → 1.0.0-rc.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Drew Powers
+Copyright (c) 2026 Fedor Chishchin and openapi-typesafe contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,59 @@
 # openapi-typesafe-migrate
 
-This name is reserved for openapi-typesafe. This version contains no code.
+Move a project from `openapi-typescript`, `openapi-fetch`, `openapi-react-query` and
+`openapi-typescript-helpers` to the openapi-typesafe packages.
+
+```sh
+npx openapi-typesafe-migrate          # report what would change
+npx openapi-typesafe-migrate --write  # change the files
+```
+
+Run it in the project root, with a clean git tree, so you can review the diff.
+
+Run it with `npx` (or `pnpm dlx`, `yarn dlx`, `bunx`), not as a dependency: it uses TypeScript 6
+(`@typescript/typescript6`), and an npm install of it links the project's `tsc` to TypeScript 6.
+
+## What it changes
+
+| Where                                                                                  | Change                                                                                                                                                                                                            |
+| -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Every `package.json`                                                                   | `dependencies`, `devDependencies`, `peerDependencies` and `optionalDependencies` get the new names, with the version of this tool; `^`, `~` and exact ranges keep their style. `catalog:` and `workspace:` stay.  |
+| `pnpm-workspace.yaml`                                                                  | Entries of `catalog:` and `catalogs:`. Comments and formatting stay.                                                                                                                                              |
+| `package.json` scripts, shell scripts, YAML (CI), `Makefile`, `justfile`, `Dockerfile` | The `openapi-typescript` command, and the flags it renamed: `--immutable-types` / `-it` → `--immutable`, `--support-array-length` → `--array-length`, `--redoc` → `--redocly`, `-ap` → `--additional-properties`. |
+| Sources (`.ts`, `.tsx`, `.js`, `.mjs`, `.cjs`, `.vue`, `.svelte`, `.astro`, …)         | Quoted module specifiers: imports, `require()`, `import()`, `vi.mock()`, `declare module`, tool configs.                                                                                                          |
+| `openapiTS(source, { transform })` calls                                               | When `transform` is the only callback and returns plain `ts.factory` types (or the helper constants), the returns become type text and `irCallbacks: true` is added.                                              |
+
+`node_modules`, `.git`, `dist` and the output folders `.next`, `.nuxt`, `.output`, `.svelte-kit`,
+`.turbo` and `coverage` are skipped; links are not followed.
+
+## What it leaves to you
+
+The report lists each of these with the file and line:
+
+- a version spec it cannot replace (`latest`, a URL, a file, an npm alias), and `overrides` /
+  `resolutions` / `pnpm` settings (in `package.json` or `pnpm-workspace.yaml`, patches included)
+  that name an old package;
+- a renamed peer dependency: users of your package must switch too;
+- `npx openapi-typescript@<version>`: the old package is pinned, change it by hand;
+- deep imports such as `openapi-fetch/dist/...`: check that the file exists in the new package;
+- `transform` callbacks it cannot rewrite, and `postTransform` / `transformProperty`: they keep
+  working with a deprecation warning; see
+  [IR callbacks](https://github.com/openapi-typesafe/openapi-typesafe/blob/main/docs/node.md#ir-callbacks).
+
+Then install, regenerate your types and commit them once (the file header names openapi-typesafe
+now, so `--check` fails until you do), and run your type check and tests.
+
+## Options
+
+| Option         | Default                                                                      |
+| -------------- | ---------------------------------------------------------------------------- |
+| `--write`      | Dry run: nothing is written                                                  |
+| `--root <dir>` | The current directory                                                        |
+| `--log <file>` | A new JSON Lines file in the system temporary directory; its path is printed |
+
+Exit codes: `0` done, `1` the migration failed (the message and the log say why), `2` unknown
+option.
+
+## License
+
+[MIT](./LICENSE)

package/bin/migrate.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+// The command is built from src/cli/main.ts.
+import "../dist/cli/main.mjs";