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.

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

feat(create-remix): rewrite create-remix CLI #6887

Merged
merged 13 commits into from Jul 21, 2023

Conversation

markdalgleish
Copy link
Member

@markdalgleish markdalgleish commented Jul 20, 2023

This PR makes the following changes to create-remix.

  • Moves the logic for create-remix out of @remix-run/dev. The Remix CLI no longer has a remix create command (which was kind of odd in the context of an existing app). This means create-remix is now much smaller since it's not downloading the entire Remix CLI and its dependencies up-front.
  • Removes the template prompt. This puts official templates and community/third-party templates/stacks on a more equal footing. You need to provide the --template option for anything other than the basic template.
  • Adds support for directories in GitHub repo shorthands, e.g. --template remix-run/remix/templates/express
  • Replaces the "Stacks" documentation with more general "Templates" docs
  • Displays a link to the new "Templates" docs when the --template option isn't provided
  • Adds a prompt to automatically run git init.
  • Adds a prompt to run the remix.init script if it's detected. This makes it clear when we're running code from the template/stack rather than create-remix itself. This means you can explicitly opt-out too which previously wasn't possible. Instead, you could only implicitly opt out by choosing not to install dependencies.
  • Removes support for index.ts in remix.init scripts to simplify things and remove the esbuild dependency from create-remix.
  • Removes the option to automatically convert TypeScript to JavaScript.
  • Makes the UI a bit nicer.
  • Updates all docs to reflect these changes.

Note: This PR replaces #6391 (which was already approved), targeting dev instead of the discarded v2 branch.

@changeset-bot
Copy link

changeset-bot bot commented Jul 20, 2023

🦋 Changeset detected

Latest commit: 07fb787

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 18 packages
Name Type
create-remix Major
@remix-run/dev Major
remix Major
@remix-run/architect Major
@remix-run/cloudflare Major
@remix-run/cloudflare-pages Major
@remix-run/cloudflare-workers Major
@remix-run/css-bundle Major
@remix-run/deno Major
@remix-run/eslint-config Major
@remix-run/express Major
@remix-run/netlify Major
@remix-run/node Major
@remix-run/react Major
@remix-run/serve Major
@remix-run/server-runtime Major
@remix-run/testing Major
@remix-run/vercel Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@markdalgleish markdalgleish marked this pull request as ready for review July 20, 2023 23:48
@markdalgleish markdalgleish self-assigned this Jul 21, 2023
@markdalgleish markdalgleish merged commit cd0ecf5 into dev Jul 21, 2023
9 checks passed
@markdalgleish markdalgleish deleted the markdalgleish/create-remix-v2 branch July 21, 2023 00:43
@github-actions github-actions bot added the awaiting release This issue has been fixed and will be released soon label Jul 21, 2023
@markdalgleish markdalgleish added BREAKING CHANGE This change will require a major version bump v2 Issues related to v2 apis labels Jul 21, 2023
@github-actions
Copy link
Contributor

🤖 Hello there,

We just published version v0.0.0-nightly-657c9d5-20230721 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

🤖 Hello there,

We just published version v0.0.0-nightly-974954f-20230722 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

🤖 Hello there,

We just published version v0.0.0-nightly-3b808ce-20230802 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

🤖 Hello there,

We just published version 1.19.2-pre.1 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 3, 2023

🤖 Hello there,

We just published version v0.0.0-nightly-7cb1e7e-20230803 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

🤖 Hello there,

We just published version 1.19.2-pre.2 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 5, 2023

🤖 Hello there,

We just published version v0.0.0-nightly-6e250f7-20230805 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions
Copy link
Contributor

🤖 Hello there,

We just published version v0.0.0-nightly-b1149bb-20230810 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting release This issue has been fixed and will be released soon BREAKING CHANGE This change will require a major version bump CLA Signed package:create-remix v2 Issues related to v2 apis
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants