openapi-typesafe-migrate 1.0.0-rc.10 → 1.0.0-rc.11

package/CHANGELOG.md

@@ -1,5 +1,83 @@
 # openapi-typesafe-migrate
 
+## 1.0.0-rc.11
+
+### Patch Changes
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A generator command appended to a variable that the file does not set before
+  (`H+="npx openapi-typescript -it"` in a shell script, `GEN += npx openapi-typescript` in a
+  Makefile) is migrated where it is written. Before, it was only reported. The flags after a later
+  `$H` are still reported, since the value from outside may start with another program.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - bun's `trustedDependencies` in package.json is reported when it names an old package, as pnpm's
+  `onlyBuiltDependencies` already was.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - The migration reads the parameters of more CI files as it reads GitHub Actions inputs: CircleCI
+  `parameters` with `<< parameters.gen >>`, GitLab `spec: inputs` with `$[[ inputs.gen ]]`, and Azure
+  Pipelines template `parameters` with `${{ parameters.gen }}`. A parameter's default is renamed, and
+  the old flags after or inside such a reference are reported. Each file kind reads only its own
+  parameters, and `${{ inputs['flags'] }}` is read like `${{ inputs.flags }}`. Before, the flags
+  after these references were kept without a word, and a GitLab input default was renamed while the
+  flags after `$[[ inputs.gen ]]` were not.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - When a CI file sets a variable to the generator (GitLab `variables`, Compose `environment`,
+  CircleCI `environment`, Task `vars`, Azure `variables`, a workflow `env`), the migration now also
+  reads the scripts and other command files that expand it (`$GEN api.yaml -it` in
+  `scripts/gen.sh`), even when they name no old package, and reports the old flags after `$GEN`
+  there. Before, the variable was renamed and those flags were kept without a word.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - The old flags that a container gives the generator through its command are renamed: a
+  Dockerfile `CMD ["api.yaml", "-it"]` after `ENTRYPOINT ["openapi-typescript"]` (also from an
+  earlier build stage), a Compose, GitLab or CircleCI `command` after an `entrypoint`, and
+  Kubernetes `args` after a `command`. Before, the entrypoint got the new name while the command
+  kept `-it`, and the container failed with a removed flag. An entrypoint script that may pass its
+  arguments on is reported.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - The migration renames the `options` of a GitLab CI variable together with its `value`, and reads
+  each option as a value the variable can have. Before, only the value was renamed, so it was no
+  longer one of the options and GitLab rejected the pipeline.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A YAML file that a Taskfile `includes`, a GitLab CI `include: local:` or an Azure Pipelines
+  `template:` names is now migrated as a file of the kind that includes it, whatever its name: its
+  `cmds`, `variables`, `$(gen)` macros and inputs are read as there. GitLab `*` and `**` patterns
+  are followed, and so are the files that included files include. Before, such a file was read as
+  plain YAML, and the report could say there was nothing to migrate.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A Makefile call of a function with a hyphen in its name, such as
+  `$(filter-out x,npx openapi-typescript)`, is reported when its arguments name an old package.
+  Before, the file was neither changed nor reported ("Nothing to migrate").
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A shell variable whose value is written with a backslash or in several quoted parts
+  (`GEN=npx\ openapi-typescript`, `GEN="npx "openapi-typescript`) now gets the new generator name
+  too. Before, the flags after `$GEN` were renamed while the value kept `openapi-typescript`, and the
+  report said nothing about it.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A variable that a step, a job or a stage written as a list item sets (an Azure Pipelines or
+  GitHub Actions step `env`, an Azure stage's `variables`) now counts for the commands of that item
+  only. Before, it counted for the whole file, so the flags after `$GEN` in another step were
+  renamed although `GEN` was not set there.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A command line passed to a program as a variable is migrated:
+  `cross-env GEN="npx openapi-typescript -it" node gen.js`, `env GEN="…" make` and
+  `$(MAKE) -C api GEN="…"` get the new generator name and flags. A one-word value that names an
+  old package (`make GEN=openapi-typescript`) is reported. Before, both were left without a word.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A command that runs the old generator from a Windows folder outside the project
+  (`C:\tools\openapi-typescript a.yaml`) is reported, as a POSIX path such as
+  `/usr/local/bin/openapi-typescript` already was.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - The migration reads the command line of an exec-form shell in a YAML file as shell text:
+  `command: ["sh", "-c", "…"]` in a Compose file, and a Kubernetes `command: ["/bin/sh", "-c"]`
+  with the script in `args`. A Compose `entrypoint` list and `command` list, and a Kubernetes
+  `command` list and `args` list, are read as one command, and Compose's `$$GEN` is read as the
+  service's `$GEN`. Before, the generator and its old flags in these commands were kept without a
+  word, or `$GEN` was renamed while the flags after `$$GEN` were not.
+
+- [#134](https://github.com/openapi-typesafe/openapi-typesafe/pull/134) [`e6bbda7`](https://github.com/openapi-typesafe/openapi-typesafe/commit/e6bbda77200c0888c387ec32b8fe6d774a071aeb) Thanks [@fedorello](https://github.com/fedorello)! - A renamed dependency whose spec is Yarn's `npm:` protocol with a bare range
+  (`"openapi-fetch": "npm:^0.13.0"`) gets the new version after the same protocol
+  (`"openapi-typesafe-fetch": "npm:^1.0.0"`). Before, it kept the old range, which no version of
+  the new package matches, and the report asked to fix it by hand.
+
 ## 1.0.0-rc.10
 
 ### Patch Changes

package/README.md

@@ -45,7 +45,15 @@ them (quotes, `\` line continuations, comments, `&&`, `|`,
 own flags are renamed, and a script name (`npm run openapi-typescript`) is never changed. A
 Dockerfile's exec form (`RUN ["npx",
 "openapi-typescript", …]`, also after `RUN --mount=…`) is read word by word, and the command line of
-`["sh", "-c", "…"]` as shell text. A Makefile variable that holds the generator (`OAT :=
+`["sh", "-c", "…"]` as shell text. The items of an exec-form `CMD` are the arguments of the
+exec-form `ENTRYPOINT` of its stage (or of the stage it starts `FROM`), so after
+`ENTRYPOINT ["openapi-typescript"]` the old flags of `CMD ["api.yaml", "-it"]` are renamed, and an
+entrypoint script that may pass them on is reported. A YAML `command` after an `entrypoint` of
+the same map (Compose, GitLab, CircleCI) and Kubernetes `args` after a `command` are read the
+same way; when both are lists, they are one exec-form command, the entrypoint first
+(`entrypoint: ["npx"]` with `command: ["openapi-typescript", "-it"]`, or `command: ["/bin/sh",
+"-c"]` with its script in `args`), and Compose's `$$GEN` there is the container's `$GEN`. A
+Makefile variable that holds the generator (`OAT :=
 openapi-typescript`, also for some targets only, and `GEN := $(OAT)`) is renamed where it is set,
 and the flags after `$(OAT)` (or `$G` for a one-letter name) where it runs; so is an `env` variable
 of a workflow and the flags after `$GEN` or `${{ env.GEN }}` (also GitLab CI `variables`,
@@ -59,8 +67,14 @@ as a command line where it is written: in a value that just computes
 (`env_var_or_default("GEN", "npx openapi-typescript")`, an `if`), in a recipe parameter default
 (`types gen="npx openapi-typescript":`) and in an interpolation; such a value and a parameter (the
 command line can set it) may run another program, so the flags after them are reported. A shell variable that a script, a `run` block or a package.json
-script sets itself (`GEN="npx openapi-typescript"`, also after `export`, `local` or `readonly`)
-is renamed where it is set, and the flags after `$GEN` where it runs. Text appended to such a
+script sets itself (`GEN="npx openapi-typescript"`, also after `export`, `local` or `readonly`,
+and written with a backslash or in several quoted parts, `GEN=npx\ openapi-typescript`, which
+is read as the shell reads it) is renamed where it is set, and the flags after `$GEN` where it
+runs. A command line passed to a program as a variable (`cross-env GEN="npx openapi-typescript
+-it" node gen.js`, `env GEN="…" make`, `$(MAKE) GEN="…"`) is migrated where it is written. Text
+appended to a variable the file does not set before is the value when it runs the generator
+itself (`H+="npx openapi-typescript"`, a Makefile `GEN += npx openapi-typescript`), so it is
+migrated where it is written. Text appended to such a
 variable (a Makefile `GEN += --immutable-types`, a shell `G+=" -it"`, a justfile
 `"npx openapi-typescript" + " -it"`) holds arguments of the program its value runs, so its old
 flags are renamed where they are written, or reported when the variable may run another program;
@@ -79,7 +93,8 @@ computes (`$(or $(GEN),npx openapi-typescript)`, `$(shell …)`) may run the gen
 flags after it are reported; the arguments that `$(or …)`, `$(and …)` and `$(if …)` can give, and
 the text of `$(strip …)`, are read as command lines where they are written, so the old name in
 them is renamed. A call of any other make function whose arguments name an old package
-(`$(firstword npx openapi-typescript)`, `$(call …)`, `$(shell …)`) is reported. A Makefile
+(`$(firstword npx openapi-typescript)`, `$(filter-out …)`, `$(call …)`, `$(shell …)`) is
+reported. A Makefile
 variable set with `?=` (the environment can override it) or to a value that make computes is
 reported the same way where it runs. The flags change only when every definition of the variable
 in the file sets it to the generator: a variable that another Dockerfile stage, a step `env` or a
@@ -93,7 +108,14 @@ flags that the generator gets (`$(FLAGS)` with `FLAGS := -it`, a justfile `{{fla
 `${{ inputs.flags }}` with an input default `-it`, also as `${{ github.event.inputs.flags }}`,
 through an `env` value `FL: ${{ inputs.flags }}`, or as a literal in an expression,
 `${{ inputs.flags || '-it' }}`) may serve other commands too, so it
-is reported, not changed. YAML files are changed only in command
+is reported, not changed. A GitLab variable's `options` are values of the variable. A variable map in a list item
+(a step's `env`) reaches only that item. The defaults of CircleCI `parameters`
+(`<< parameters.gen >>`), GitLab `spec: inputs` (`$[[ inputs.gen ]]`) and Azure Pipelines
+`parameters` (`${{ parameters.gen }}`) are read as input defaults are. A file that a Taskfile
+`includes`, a GitLab local `include` (also with `*` and `**`) or an Azure `template` names is read
+as a file of that kind. A variable that a YAML variable map sets to the generator may run it in
+any file the tool reads (a script that a CI job runs), so the flags after `$GEN` there are
+reported. YAML files are changed only in command
 keys (`run`, `script`, `command`, `entrypoint`, …), in the values of the variable maps above and in input
 defaults, in block and flow style, never in other values. An anchor that an alias uses under such
 a key (`script: [*gen_scripts]`, `env: *common`) is migrated where it is written, once. A CI step whose `shell` is another program (`shell: python`) runs
@@ -165,10 +187,12 @@ The report and the log show a spec with credentials (`git+https://<token>@…`)
 
 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` /
+- a version spec it cannot replace (`latest`, a URL, a file, an npm alias of another package;
+  Yarn's `npm:^0.13.0` is a range and gets the new version), and `overrides` /
   `resolutions` and every other package manager setting (`packageExtensions`,
-  `allowedDeprecatedVersions`, …, in `package.json`, `pnpm-workspace.yaml` or `.yarnrc.yml`,
-  patches included) that names an old package, except an override that aliases it to its
+  `allowedDeprecatedVersions`, bun's `trustedDependencies`, …, in `package.json`,
+  `pnpm-workspace.yaml` or `.yarnrc.yml`, patches included) that names an old package, except an
+  override that aliases it to its
   successor (`"openapi-fetch": "npm:openapi-typesafe-fetch@^1.0.0"`), which is the migration done;
 - a dependency under an old name on a local package (`workspace:*`, `link:`, `file:`, `portal:`),
   such as a fork in the workspace: it and the imports of it keep the old name, because the new
@@ -179,7 +203,9 @@ The report lists each of these with the file and line:
 - a patch file of an old package (`patches/openapi-fetch+0.13.0.patch`): the new package has other
   code, so check whether the fix is still needed;
 - a word in a command that names an old package where the tool cannot tell what runs it (an
-  argument of a program it does not know, a script name), and a Kubernetes `env` item
+  argument of a program it does not know, a script name, a one-word variable passed to a
+  program such as `make GEN=openapi-typescript`), a generator installed outside the project
+  (`/usr/local/bin/openapi-typescript`, `C:\tools\openapi-typescript`), and a Kubernetes `env` item
   (`- name: GEN / value: npx openapi-typescript`), which no shell reads: migrate it by hand;
 - a CI step whose `shell` is another program (`shell: python`), a justfile recipe with a shebang
   for one, or inline code (`python3 -c '…'`) that names an old package: the tool does not read