Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): add code gen page #4978

Merged
merged 5 commits into from May 17, 2023
Merged

feat(docs): add code gen page #4978

merged 5 commits into from May 17, 2023

Conversation

tknickman
Copy link
Member

Description

Docs for code gen

@vercel
Copy link

vercel bot commented May 16, 2023 •
edited

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

Name Status Preview Comments Updated (UTC)
examples-basic-web 🔄 Building (Inspect) May 17, 2023 9:22pm
examples-cra-web 🔄 Building (Inspect) May 17, 2023 9:22pm
examples-native-web 🔄 Building (Inspect) May 17, 2023 9:22pm
examples-nonmonorepo 🔄 Building (Inspect) May 17, 2023 9:22pm
examples-tailwind-web 🔄 Building (Inspect) May 17, 2023 9:22pm
turbo-site ✅ Ready (Inspect) Visit Preview ✅ 17 resolved May 17, 2023 9:22pm
5 Ignored Deployments
Name Status Preview Comments Updated (UTC)
examples-designsystem-docs ⬜️ Ignored (Inspect) May 17, 2023 9:22pm
examples-gatsby-web ⬜️ Ignored (Inspect) May 17, 2023 9:22pm
examples-kitchensink-blog ⬜️ Ignored (Inspect) May 17, 2023 9:22pm
examples-svelte-web ⬜️ Ignored (Inspect) May 17, 2023 9:22pm
examples-vite-web ⬜️ Ignored (Inspect) May 17, 2023 9:22pm

@tknickman tknickman requested review from a team as code owners May 16, 2023 16:07
@turbo-orchestrator turbo-orchestrator bot added area: docs Improvements or additions to documentation area: site team: turbopack labels May 16, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 16, 2023 •
edited

🟢 CI successful 🟢

Thanks

@weyert
Copy link
Contributor

weyert commented May 16, 2023 •
edited

@tknickman Is this supposed to be compatible with Plop? When I add a line import globby from 'globby'-line to config.ts it all stops working for me. Stops finding custom generators when I remove this line it can find the custom generators again

globby is a dev dependency in the root package.json of the monorepo

@tknickman
Copy link
Member Author

Thanks for taking a look @weyert, I would expect that to work - I'll take a look before release.

Thanks!

@weyert
Copy link
Contributor

weyert commented May 16, 2023

@tknickman I have made a small repro: https://github.com/weyert/turbo-gen-repro

turbo generate adr doesn't work until I remove this line:
https://github.com/weyert/turbo-gen-repro/blob/main/turbo/generators/config.ts#L37

@tknickman
Copy link
Member Author

@weyert thanks for the repro - this is happening because we're bundling our utility package to CJS, and globby is ESM.

After we get this initial version out I'll look into supporting ESM dependencies as well!

I'm also going to update this now to output a meaningful error instead of nothing at all in the meantime.

@tknickman tknickman force-pushed the tomknickman/turbo-1086-documentation-for-turbogen branch from fe24b41 to 67231c4 Compare May 16, 2023 23:21
@tknickman tknickman force-pushed the tomknickman/turbo-1086-documentation-for-turbogen branch from 67231c4 to b201b1c Compare May 17, 2023 15:07
@tknickman tknickman mentioned this pull request May 17, 2023
Merged
mehulkar
mehulkar reviewed May 17, 2023
View reviewed changes
Copy link
Contributor

@mehulkar mehulkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left my 2c, not blocking

docs/pages/repo/docs/core-concepts/monorepos/_meta.json Show resolved Hide resolved
docs/pages/repo/docs/core-concepts/monorepos/code-generation.mdx Outdated Show resolved Hide resolved
@tknickman tknickman enabled auto-merge (squash) May 17, 2023 21:49
@tknickman tknickman merged commit 29284c8 into main May 17, 2023
41 checks passed
@tknickman tknickman deleted the tomknickman/turbo-1086-documentation-for-turbogen branch May 17, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mehulkar mehulkar mehulkar left review comments

@chris-olszewski chris-olszewski chris-olszewski approved these changes

@anthonyshew anthonyshew anthonyshew approved these changes

@nathanhammond nathanhammond Awaiting requested review from nathanhammond nathanhammond is a code owner automatically assigned from vercel/turbo-oss

@NicholasLYang NicholasLYang Awaiting requested review from NicholasLYang NicholasLYang is a code owner automatically assigned from vercel/turbo-oss

Assignees
No one assigned
Labels
area: docs Improvements or additions to documentation area: site docs: next release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@tknickman @weyert @mehulkar @chris-olszewski @anthonyshew