Add codemod to set default outputs in turbo.json #2714
Conversation
This behavior is frameworks-specific and unintuitive to new users. Specifically, this removes the confusion between omitting the outputs key and setting to an empty array. Additionally, this will allow us to more clearly define turbo.json composition, so locally-scoped turbo.json configs can override outputs, without rationalizing what happens to this implicit behavior.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Ignored Deployments
|
d3da1bd to
8122a0f
Compare
1ff7964 to
b5b5110
Compare
| [taskName: string]: TaskDefinition; | ||
| } | ||
|
|
||
| export default function addDefaultOutputs(files: string[], flags: Flags) { |
There was a problem hiding this comment.
Naming thoughts:
- specify-default-outputs?
There was a problem hiding this comment.
I followed add-package-manager, but maybe it should be more like like "fill-in-previously-implicit-defaults" 😆 . Ok with anything though if you have a mild or strong opinion; i have none!
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
There was a problem hiding this comment.
I only mention codemod naming because it's also dropping []. If you have a better idea go for it, otherwise this is non-blocking.
There was a problem hiding this comment.
Good point. Renamed to set-default-outputs
Co-authored-by: Nathan Hammond <nathan.hammond@vercel.com>
🟢 CI successful 🟢Thanks |
packages/turbo-codemod/__tests__/__fixtures__/thingie/turbo.json
Outdated
Show resolved
Hide resolved
| [taskName: string]: TaskDefinition; | ||
| } | ||
|
|
||
| export default function addDefaultOutputs(files: string[], flags: Flags) { |
There was a problem hiding this comment.
I only mention codemod naming because it's also dropping []. If you have a better idea go for it, otherwise this is non-blocking.
Co-authored-by: Nathan Hammond <nathan.hammond@vercel.com>
Co-authored-by: Nathan Hammond <nathan.hammond@vercel.com>
|
@tknickman nice catch!! updated |
There was a problem hiding this comment.
Two more nitpicks, but approving in the meantime!
packages/turbo-codemod/__tests__/set-default-ouptuts.test.tsfilename is misspelled (should beset-default-outputs.test.ts)- All of the other codemods include a summary section:
console.log("All done.");
console.log("Results:");
console.log(chalk.red(`0 errors`));
console.log(chalk.yellow(`${skippedCount} skipped`));
console.log(chalk.yellow(`${unmodifiedCount} unmodified`));
console.log(chalk.green(`${modifiedCount} modified`));
I would recommend adding this for consistency (should be simple since we're only ever touching one file here)
Stacked PRs:
turbo@1.7