feat(create-turbo): support examples #4398

tknickman · 2023-03-30T13:24:33Z

Description

create-turbo with examples support! Same API as create-next-app

TODO:

Docs
Tests

Issues

fixes #313
fixes #664
fixes #2688

vercel · 2023-03-30T13:24:44Z

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

Name	Status	Preview	Comments	Updated (UTC)
examples-basic-web	🔄 Building (Inspect)			Apr 4, 2023 1:50pm
examples-svelte-web	🔄 Building (Inspect)			Apr 4, 2023 1:50pm

9 Ignored Deployments

Name	Status	Preview	Updated (UTC)
examples-cra-web	⬜️ Ignored (Inspect)		Apr 4, 2023 1:50pm
examples-designsystem-docs	⬜️ Ignored (Inspect)		Apr 4, 2023 1:50pm
examples-gatsby-web	⬜️ Ignored (Inspect)		Apr 4, 2023 1:50pm
examples-kitchensink-blog	⬜️ Ignored (Inspect)		Apr 4, 2023 1:50pm
examples-native-web	⬜️ Ignored (Inspect)	Visit Preview	Apr 4, 2023 1:50pm
examples-nonmonorepo	⬜️ Ignored (Inspect)	Visit Preview	Apr 4, 2023 1:50pm
examples-tailwind-web	⬜️ Ignored (Inspect)		Apr 4, 2023 1:50pm
examples-vite-web	⬜️ Ignored (Inspect)		Apr 4, 2023 1:50pm
turbo-site	⬜️ Ignored (Inspect)	Visit Preview	Apr 4, 2023 1:50pm

socket-security · 2023-03-30T13:32:02Z

New dependency changes detected. Learn more about Socket for GitHub ↗︎

🚨 Potential security issues found in this pull request. To accept the risk, merge this PR and you will not be notified again.

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore esbuild@0.14.49
@SocketSecurity ignore esbuild@0.14.54
@SocketSecurity ignore esbuild@0.15.11
@SocketSecurity ignore esbuild@0.15.12
@SocketSecurity ignore esbuild@0.15.15
@SocketSecurity ignore esbuild@0.15.18
@SocketSecurity ignore esbuild@0.15.6
@SocketSecurity ignore esbuild@0.16.10
@SocketSecurity ignore esbuild@0.17.12
@SocketSecurity ignore esbuild@0.17.15
@SocketSecurity ignore turbo@1.0.0
@SocketSecurity ignore turbo@1.5.6
@SocketSecurity ignore turbo@1.6.3
@SocketSecurity ignore turbo@1.7.0

📜 Install scripts

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.

Package	Script field	Source
esbuild@0.14.49 (added)	`postinstall`	`pnpm-lock.yaml`, `packages/create-turbo/package.json` via ts-jest@27.1.5, tsup@5.12.9, `packages/turbo-codemod/package.json` via ts-jest@27.1.5, tsup@5.12.9, `packages/turbo-ignore/package.json` via ts-jest@27.1.5, tsup@5.12.9, `packages/turbo-utils/package.json` via ts-jest@27.1.5, tsup@5.12.9, `packages/turbo-workspaces/package.json` via ts-jest@27.1.5, tsup@5.12.9
esbuild@0.14.54 (added)	`postinstall`	`examples/design-system/pnpm-lock.yaml`, `examples/design-system/apps/docs/package.json` via vite@2.9.15, `examples/design-system/packages/acme-core/package.json` via , `examples/design-system/packages/acme-utils/package.json` via , `examples/with-changesets/pnpm-lock.yaml`, `examples/with-changesets/packages/acme-core/package.json` via , `examples/with-changesets/packages/acme-utils/package.json` via , `examples/with-docker/apps/api/package.json`, `examples/with-prisma/package.json` via tsup@5.12.9, `examples/with-prisma/packages/database/package.json` via tsup@5.12.9
esbuild@0.15.11 (added)	`postinstall`	`pnpm-lock.yaml`, `packages/eslint-plugin-turbo/package.json` via ts-jest@27.1.5, tsup@6.2.3
esbuild@0.15.12 (added)	`postinstall`	`crates/turbopack/tests/node-file-trace/package.json`, `crates/turbopack/tests/node-file-trace/pnpm-lock.yaml`
esbuild@0.15.15 (added)	`postinstall`	`examples/with-create-react-app/pnpm-lock.yaml`, `examples/with-create-react-app/packages/ui/package.json` via , `examples/with-react-native-web/package.json` via tsup@6.5.0, `examples/with-react-native-web/packages/ui/package.json` via tsup@6.5.0, `examples/with-tailwind/pnpm-lock.yaml`, `examples/with-tailwind/packages/ui/package.json` via
esbuild@0.15.18 (added)	`postinstall`	`examples/kitchen-sink/pnpm-lock.yaml`, `examples/kitchen-sink/apps/admin/package.json` via vite@3.2.5
esbuild@0.15.6 (added)	`postinstall`	`pnpm-lock.yaml`, `benchmark/package.json`, `pnpm-lock.yaml` via esbuild-register@3.3.3, `cli/package.json`, `pnpm-lock.yaml` via esbuild-register@3.3.3
esbuild@0.16.10 (added)	`postinstall`	`examples/with-vite/pnpm-lock.yaml`, `examples/with-vite/apps/docs/package.json` via vite@4.0.3, `examples/with-vite/apps/web/package.json` via vite@4.0.3
esbuild@0.17.12 (added)	`postinstall`	`examples/with-prisma/package.json` via tsup@5.12.9, tsx@3.12.6, `examples/with-prisma/packages/database/package.json` via tsup@5.12.9, tsx@3.12.6
esbuild@0.17.15 (added)	`postinstall`	`examples/with-docker/package.json` via esbuild-register@3.4.1, `examples/with-docker/apps/api/package.json` via esbuild-register@3.4.1, `examples/with-react-native-web/package.json` via tsup@6.5.0, `examples/with-react-native-web/packages/ui/package.json` via tsup@6.5.0
turbo@1.0.0 (added)	`postinstall`	`packages/turbo-codemod/__tests__/__fixtures__/get-turbo-upgrade-command/normal-workspaces/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/get-turbo-upgrade-command/normal-workspaces-dev-install/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/get-turbo-upgrade-command/pnpm-workspaces/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/get-turbo-upgrade-command/pnpm-workspaces-dev-install/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/get-turbo-upgrade-command/single-package/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/get-turbo-upgrade-command/single-package-dev-install/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/migrate/old-turbo/package.json`, `packages/turbo-codemod/__tests__/__fixtures__/transform/basic/package.json`
turbo@1.5.6 (added)	`postinstall`	`cli/integration_tests/lockfile_aware_caching/npm/package-lock.json`, `cli/integration_tests/lockfile_aware_caching/npm/package.json`, `cli/integration_tests/lockfile_aware_caching/pnpm/package.json`, `cli/integration_tests/lockfile_aware_caching/pnpm/pnpm-lock.yaml`, `cli/integration_tests/lockfile_aware_caching/yarn/package.json`
turbo@1.6.3 (added)	`postinstall`	`examples/design-system/package.json`, `examples/design-system/pnpm-lock.yaml`, `examples/with-changesets/package.json`, `examples/with-changesets/pnpm-lock.yaml`, `examples/with-create-react-app/package.json`, `examples/with-create-react-app/pnpm-lock.yaml`, `examples/with-docker/package.json`, `examples/with-prisma/package.json`, `examples/with-react-native-web/package.json`, `examples/with-vite/pnpm-lock.yaml`
turbo@1.7.0 (added)	`postinstall`	`examples/with-rollup/package.json`, `examples/with-rollup/pnpm-lock.yaml`, `examples/with-tailwind/package.json`, `examples/with-tailwind/pnpm-lock.yaml`

Pull request alert summary

Issue	Status
Install scripts	⚠️ 14 issues
Native code	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

📊 Modified Dependency Overview:

➕ Added Package	Capability Access	`+/-` Transitive Count	Publisher
next@13.0.6	eval, network, filesystem, shell, environment	`+6`	vercel-release-bot
next@13.0.3	eval, network, filesystem, shell, environment	`+4`	vercel-release-bot
@turbo/workspaces@1.8.9-canary.1	eval, network, filesystem, shell, environment	`+0`	turbobot
@vercel/analytics@0.1.1	filesystem, environment	`+0`	chriswdmr
@types/cross-spawn@6.0.2	None	`+0`	types
@types/async-retry@1.4.5	None	`+1`	types
async-retry@1.3.3	None	`+1`	leerobinson
next-themes@0.2.0	network, filesystem, shell, environment	`+5`	paco
tailwindcss@3.1.8	eval, network, filesystem, environment	`+4`	adamwathan
got@10.7.0	network, filesystem	`+6`	sindresorhus
@types/tar@6.1.4	None	`+0`	types
@mdx-js/react@2.1.5	filesystem, environment	`+1`	wooorm
esbuild-register@3.3.3	eval, filesystem, environment	`+0`	egoist
autoprefixer@10.4.14	filesystem, shell, environment	`+0`	ai
ts-jest@27.1.5	eval, network, filesystem, shell, environment	`+50`	kul
eslint-config-next@13.0.6	eval, filesystem, shell, environment	`+12`	vercel-release-bot
eslint-config-next@12.3.1	eval, filesystem, environment	`+17`	vercel-release-bot
@heroicons/react@1.0.6	filesystem, environment	`+0`	bradlc
@sentry/nextjs@7.17.3	network, filesystem, shell, environment	`+21`	sentry-bot
nextra@2.0.1	eval, network, filesystem, shell, environment	`+61`	quietshu
nextra-theme-docs@2.0.1	eval, network, filesystem, shell, environment	`+24`	quietshu
@react-spring/web@9.6.1	filesystem, environment	`+5`	tdfka_rick
@next/react-refresh-utils@13.0.6	environment	`+1`	vercel-release-bot
@headlessui/react@1.7.3	filesystem, environment	`+0`	malfaitrobin
tsup@6.2.3	eval, network, filesystem, shell, environment	`+4`	egoist
swr@1.3.0	filesystem, environment	`+0`	quietshu
framer-motion@7.3.6	filesystem, environment	`+10`	popmotion
@react-aria/ssr@3.3.0	filesystem, environment	`+0`	devongovett

🚮 Removed packages: eslint-config-turbo@1.8.8, eslint-plugin-react@7.31.8, meow@7.1.1

github-actions · 2023-03-30T13:33:01Z

✅ This changes can build next-swc

github-actions · 2023-03-30T13:42:34Z

🟢 CI successful 🟢

Thanks

mehulkar

Left a first pass review. My main blocking comment is that if npx create-turbo -e <something> should respect <something> as-is.

If we absolutely have to transform it somehow, I suggest two things:

Ensure that all transformations are additional git commits after the first (if we're initializing a git repo in the first place)
Model transformation code so that we can make it optional (we can do this in follow up work, but I think it would be better to do first time around, even if it's just moving the logic to a new function in a separate file).

As an aside: I somewhat like degit's approach of using templates. Do we want to support using create-turbo without initializing git repo?

packages/create-turbo/package.json

packages/create-turbo/src/cli.ts

packages/create-turbo/src/commands/create/createProject.ts

mehulkar · 2023-03-30T20:23:32Z

packages/create-turbo/src/commands/create/createProject.ts

+          `"${example}"`
+        )} might be incorrect.\n`,
+        `2. You might not be connected to the internet or you are behind a proxy.`
+      );


Two very different types of errors. Seems like something we could throw/catch different known errors instead of this? (maybe i'm getting too used to Golang 😃 )

This is straight from Next, I'll look into improving it

packages/create-turbo/src/commands/create/createProject.ts

mehulkar · 2023-03-30T20:30:25Z

packages/create-turbo/src/commands/create/createProject.ts

+    repoInfo && repoInfo.username === "vercel" && repoInfo.name === "turbo";
+  const availableScripts = [];
+
+  // remove the meta file from turbo examples


can we model this as a "transformer" that gets applied to known repos? it will be easier to rip it out if we decide we don't want our examples to be fancy and have "compile" time logic to build.

We could, but I'm not sure if that's worth the time right now when we would only have one transformer. I'm usually a fan of optimizing later when the patterns emerge. This is a pretty straight-forward case. The example is either one of ours (in which case we have a few special rules) or it's not (we don't do anything)

Let me play with it and see how it feels, if we add a skip transform option it would be nice to not have that logic spread throughout and just consolidated in a few places where we're applying transforms

packages/create-turbo/src/commands/create/createProject.ts

mehulkar · 2023-03-30T20:34:25Z

packages/create-turbo/src/utils/examples.ts

+  }
+}
+
+export async function getRepoInfo(


The github url parsing logic here seems like something we can find from an existing package 🤔 . I've personally implemented this so many times in so many languages and I always feel like it's an easy place to save some intenral LOC. It's not a lot of code and sunk cost etc etc, but just a suggestion

This is also from create-next-app

can we publish it as a library and use it instead of copy pasting?

Yep, i'm planning to talk to the next team about this to see about a core-create or similar we could all utilize and open source.

packages/create-turbo/src/utils/isFolderEmpty.ts

arlyon

A few comments and questions. I will say generally attention to detail / ux is exceptional 😍

packages/create-turbo/__tests__/isWritable.test copy.ts

packages/create-turbo/package.json

packages/create-turbo/src/commands/create/createProject.ts

packages/create-turbo/src/utils/examples.ts

packages/create-turbo/src/utils/git.ts

tknickman · 2023-03-30T21:16:34Z

@mehulkar good call RE the transformations, maybe we can support a --skip-transform option or something that doesn't prompt you for the package manager and skips the rest of the transforms as well

tknickman · 2023-04-03T15:50:19Z

@mehulkar we now have lite (internal) transformers.

This added a little more complexity because it introduces the case when you have specified skip-transform, but the example uses a package manager that you don't have installed. So we have to handle the downstream effects of that (disabling install, etc)

For future iterations, we can think about supporting these more. For example - reading transforms from examples as well, and an in-example config is tell us about what transforms should run etc.

mehulkar · 2023-04-03T17:01:07Z

we now have lite (internal) transformers.

nice. for what it's worth, I don't think we need the transformers to be skippable today, I was just asking to model it as a transformer rather than inlining a bunch of conditions. I'll take another pass at the review

mehulkar · 2023-04-03T17:02:42Z

packages/create-turbo/src/cli.ts

+const createTurboCli = new Command();
+
+// create
+createTurboCli


Do we want a --skip-git option?

I don't think we need to support that, if you don't have git setup we'll just skip past these. If you want to remove git you can just remove it yourself afterwards. Plus turbo behaves much better with git available, so I don't think our own starter should fully bless that path.

mehulkar

There are still a few improvements that I would recommend, but it's too time consuming to review incremental changes on a large PR like this. I'm ok with merging and then doing follow up work. Let me know if you'd like me to pull down the branch and try it out before merge!

packages/create-turbo/src/commands/create/index.ts

packages/create-turbo/src/transforms/index.ts

packages/create-turbo/src/transforms/internal-example.ts

packages/create-turbo/src/transforms/package-manager.ts

mehulkar · 2023-04-03T17:21:00Z

packages/create-turbo/src/utils/examples.ts

+  }
+}
+
+export async function getRepoInfo(


can we publish it as a library and use it instead of copy pasting?

packages/create-turbo/src/utils/isDefaultExample.ts

Changes addressed

This reverts commit 2f6e12f.

tknickman requested a review from a team as a code owner March 30, 2023 13:24

tknickman requested review from mehulkar and arlyon March 30, 2023 13:24

turbo-orchestrator bot added pkg: create-turbo Issues related to npx create-turbo team: turborepo labels Mar 30, 2023

vercel bot deployed to Preview – turbo-site March 30, 2023 13:25 View deployment

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from 8416799 to 5971a98 Compare March 30, 2023 15:06

vercel bot deployed to Preview – turbo-site March 30, 2023 15:07 View deployment

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from b38e6f6 to c5ea2db Compare March 30, 2023 20:06

mehulkar reviewed Mar 30, 2023

View reviewed changes

arlyon previously requested changes Mar 30, 2023

View reviewed changes

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch 3 times, most recently from 7b5f516 to 4bd3535 Compare April 3, 2023 15:45

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from 4bd3535 to 0fc05a5 Compare April 3, 2023 15:55

mehulkar reviewed Apr 3, 2023

View reviewed changes

mehulkar approved these changes Apr 3, 2023

View reviewed changes

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from b7c0f90 to 0087325 Compare April 3, 2023 19:17

tknickman requested a review from a team as a code owner April 3, 2023 19:45

turbo-orchestrator bot added area: ci team: turbopack labels Apr 3, 2023

vercel bot deployed to Preview – turbo-site April 3, 2023 19:50 View deployment

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from 0404285 to b693a23 Compare April 3, 2023 20:43

vercel bot deployed to Preview – turbo-site April 3, 2023 20:44 View deployment

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from b693a23 to b9fba6a Compare April 3, 2023 21:38

turbo-orchestrator bot removed area: ci team: turbopack labels Apr 3, 2023

vercel bot deployed to Preview – turbo-site April 3, 2023 21:39 View deployment

tknickman added 3 commits April 4, 2023 09:05

feat(create-turbo): support examples

4e76c7b

feat(create-turbo): address review

77b98c3

more improvments

f536dec

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from b9fba6a to 4a93b1c Compare April 4, 2023 13:05

vercel bot deployed to Preview – turbo-site April 4, 2023 13:07 View deployment

better comments

2d4c526

tknickman force-pushed the tomknickman/turbo-661-support-starting-from-examples-in-create branch from 4a93b1c to 2d4c526 Compare April 4, 2023 13:50

tknickman enabled auto-merge (squash) April 4, 2023 13:54

tknickman merged commit 2f6e12f into main Apr 4, 2023

tknickman deleted the tomknickman/turbo-661-support-starting-from-examples-in-create branch April 4, 2023 14:11

tknickman mentioned this pull request Apr 4, 2023

fix(lockfile): pnpm #4459

Closed

tknickman restored the tomknickman/turbo-661-support-starting-from-examples-in-create branch April 4, 2023 19:24

tknickman mentioned this pull request Apr 4, 2023

fix(lockfile): correct lockfile version #4461

Merged

tknickman added a commit that referenced this pull request Apr 4, 2023

Revert "feat(create-turbo): support examples (#4398)"

a739ad7

This reverts commit 2f6e12f.

tknickman deleted the tomknickman/turbo-661-support-starting-from-examples-in-create branch April 4, 2023 20:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(create-turbo): support examples #4398

feat(create-turbo): support examples #4398

tknickman commented Mar 30, 2023 •

edited

Loading

vercel bot commented Mar 30, 2023 •

edited

Loading

socket-security bot commented Mar 30, 2023 •

edited

Loading

github-actions bot commented Mar 30, 2023

github-actions bot commented Mar 30, 2023 •

edited

Loading

mehulkar left a comment

mehulkar Mar 30, 2023

tknickman Mar 30, 2023

mehulkar Mar 30, 2023

tknickman Mar 30, 2023 •

edited

Loading

mehulkar Mar 30, 2023

tknickman Mar 30, 2023

mehulkar Apr 3, 2023

tknickman Apr 3, 2023

arlyon left a comment

tknickman commented Mar 30, 2023

tknickman commented Apr 3, 2023 •

edited

Loading

mehulkar commented Apr 3, 2023

mehulkar Apr 3, 2023

tknickman Apr 4, 2023

mehulkar left a comment

mehulkar Apr 3, 2023

feat(create-turbo): support examples #4398

feat(create-turbo): support examples #4398

Conversation

tknickman commented Mar 30, 2023 • edited Loading

Description

Issues

vercel bot commented Mar 30, 2023 • edited Loading

socket-security bot commented Mar 30, 2023 • edited Loading

github-actions bot commented Mar 30, 2023

github-actions bot commented Mar 30, 2023 • edited Loading

🟢 CI successful 🟢

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

tknickman Mar 30, 2023 • edited Loading

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

arlyon left a comment

Choose a reason for hiding this comment

tknickman commented Mar 30, 2023

tknickman commented Apr 3, 2023 • edited Loading

mehulkar commented Apr 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mehulkar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tknickman commented Mar 30, 2023 •

edited

Loading

vercel bot commented Mar 30, 2023 •

edited

Loading

socket-security bot commented Mar 30, 2023 •

edited

Loading

github-actions bot commented Mar 30, 2023 •

edited

Loading

tknickman Mar 30, 2023 •

edited

Loading

tknickman commented Apr 3, 2023 •

edited

Loading