Add codemod to transform literals to wildcards #5054

nathanhammond · 2023-05-22T12:32:02Z

In 1.10 all existing literal env var names become wildcards. Users with literals env vars that could be confused as wildcards need to be escaped. This automates that process.

vercel · 2023-05-22T12:32:11Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
examples-basic-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 24, 2023 10:14am
examples-cra-web	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	May 24, 2023 10:14am
turbo-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 24, 2023 10:14am

8 Ignored Deployments

Name	Status	Preview	Updated (UTC)
examples-designsystem-docs	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-gatsby-web	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-kitchensink-blog	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-native-web	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-nonmonorepo	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-svelte-web	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-tailwind-web	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am
examples-vite-web	⬜️ Ignored (Inspect)	Visit Preview	May 24, 2023 10:14am

vercel · 2023-05-22T12:32:13Z

Someone is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

mehulkar

lgtm! some suggestions inline, nothing blocking

docs/pages/repo/docs/reference/codemods.mdx

mehulkar · 2023-05-22T17:09:03Z

packages/turbo-codemod/src/commands/migrate/steps/getTransformsForMigration.ts

+    } else {
+      return -1;
+    }
+  });


I can never remember what positive and negative means. Is this sorting so more recent transforms run first or vice versa? a comment would be useful if that's why we're sorting in the first place

This sorts ascending; transforms run from oldest to newest, allowing us to rely on the previous transforms having already been completed.

As for remembering:

JS sort is default ascending.

1 > 0, so return 1 when it is greater.

0 = 0, so map 0 to equal.

-1 < 0, so -1 maps to smaller.

If you pass negative zero in, well, you get what was coming. (I don't know if JS cares or not.)

😬 good catch!

mehulkar · 2023-05-22T17:12:00Z

packages/turbo-codemod/src/transforms/transform-literals-to-wildcards.ts

+
+function migrateTaskConfigs(config: TurboJsonSchema) {
+  for (const [_, taskDef] of Object.entries(config.pipeline)) {
+    let { env, passThroughEnv } = taskDef;


Could pull this list of known env var fields

for const field of knownEnvFields { taskDef[field] = taskDef[field].map(transformEnvVarName) }

This was a "keep with the pattern" since we do exactly this in four other codemods. 🤷‍♂️

mehulkar · 2023-05-22T17:12:32Z

packages/turbo-codemod/src/transforms/transform-literals-to-wildcards.ts

+  if ("turbo" in packageJSON) {
+    return runner.abortTransform({
+      reason:
+        '"turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first',


When can we just stop handling this use case across the board?

Probably now; the transforms weren't sorted previously resulting in this being a requirement to not have everything blow up.

We also still support running these as one offs, so it's possible someone will get the order wrong themselves. So I would still be in favor of keeping this check around for the nice error - but it is definitely a little painful

When / under what conditions would you be in favor of removing this handling @tknickman?

Since the purpose of these codemods are intended for migration, I think we should leave them in.

I think these have a different contract than the core CLI, where it's totally fine to remove the features / logs / checks etc. after deprecation.

For all new codemods going forward too?

mehulkar · 2023-05-22T17:13:18Z

packages/turbo-types/src/types/config.ts

@@ -270,3 +270,4 @@ export type OutputMode =
  | "none";

 export type AnchoredUnixPath = string;
+export type EnvWildcard = string;


does this get documented somehow?

I've got that over in the wildcard PR; I did this to minimize conflicts. This ends up documented in the schema, but never gets presented to the user in VS Code. 😕

tknickman · 2023-05-23T12:50:46Z

packages/turbo-codemod/src/commands/migrate/steps/getTransformsForMigration.ts

+    } else {
+      return -1;
+    }
+  });


😬 good catch!

tknickman · 2023-05-23T12:52:21Z

packages/turbo-codemod/src/transforms/transform-literals-to-wildcards.ts

+  if ("turbo" in packageJSON) {
+    return runner.abortTransform({
+      reason:
+        '"turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first',


We also still support running these as one offs, so it's possible someone will get the order wrong themselves. So I would still be in favor of keeping this check around for the nice error - but it is definitely a little painful

nathanhammond requested review from a team and anthonyshew as code owners May 22, 2023 12:32

nathanhammond requested review from mehulkar and NicholasLYang May 22, 2023 12:32

turbo-orchestrator bot added area: docs Improvements or additions to documentation pkg: turbo-codemod team: turborepo labels May 22, 2023

This comment was marked as spam.

Sign in to view

mehulkar approved these changes May 22, 2023

View reviewed changes

tknickman approved these changes May 23, 2023

View reviewed changes

Nathan Hammond added 2 commits May 24, 2023 18:08

Add codemod to transform literals to wildcards

818b798

Update for feedback

0731771

nathanhammond force-pushed the wildcard-codemod branch from c348f49 to 0731771 Compare May 24, 2023 10:08

vercel bot deployed to Preview – turbo-site May 24, 2023 10:14 View deployment

nathanhammond added the pr: automerge Kodiak will merge these automatically after checks pass label May 24, 2023

kodiakhq bot merged commit f717cc6 into vercel:main May 24, 2023

nathanhammond deleted the wildcard-codemod branch May 24, 2023 10:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add codemod to transform literals to wildcards #5054

Add codemod to transform literals to wildcards #5054

nathanhammond commented May 22, 2023

vercel bot commented May 22, 2023 •

edited

Loading

vercel bot commented May 22, 2023

This comment was marked as spam.

mehulkar left a comment

mehulkar May 22, 2023

nathanhammond May 23, 2023

tknickman May 23, 2023

mehulkar May 22, 2023

nathanhammond May 23, 2023

mehulkar May 22, 2023

nathanhammond May 23, 2023

tknickman May 23, 2023

mehulkar May 23, 2023

tknickman May 23, 2023

mehulkar May 23, 2023

mehulkar May 22, 2023

nathanhammond May 23, 2023

tknickman May 23, 2023

tknickman May 23, 2023

Add codemod to transform literals to wildcards #5054

Add codemod to transform literals to wildcards #5054

Conversation

nathanhammond commented May 22, 2023

vercel bot commented May 22, 2023 • edited Loading

vercel bot commented May 22, 2023

This comment was marked as spam.

mehulkar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented May 22, 2023 •

edited

Loading