fix(remix-dev/cli): Remove excess fetching and improve error handling #2500

chaance · 2022-03-25T21:07:48Z

Instead of fetching early to detect template types in the CLI, we can simplify the code and speed up the setup process with a few heuristics:

Check if the user passed a local file. If they hand us an explicit file URL, we'll validate it first. Otherwise we just ping the filesystem to see if the string references a filepath and, if not, move on.
If the provided template contains no slashes, spaces, or special chars, we assume it is one of our templates and attempt to fetch it.
If the template is a GitHub URL or shorthand :org/:repo, we fetch the repo.
Any other URLs are assumed to be direct tarball URLs, so we try to fetch them.

Worth noting that there are probably more opportunities to improve error handling. We'll want to iterate here.

Docs
Tests

Instead of fetching early to detect template types, we can simplify the code and speed up the setup process with a few heuristics.

…mizations

packages/remix-dev/cli/create.ts

…mizations

mcansh · 2022-03-29T14:56:08Z

can you cut an experimental when you get time? looks great 👌

packages/remix-dev/cli/run.ts

Co-authored-by: Logan McAnsh <logan@mcan.sh>

chaance · 2022-03-29T16:20:42Z

@mcansh Cut before I committed your suggested change, but you can test everything else w/ v0.0.0-experimental-21ec8370

mcansh · 2022-03-29T16:22:45Z

packages/remix-dev/cli/run.ts

@@ -305,7 +305,8 @@ export async function run(argv: string[] = process.argv.slice(2)) {
          templateType! || (answers.appType === "stack" ? "repo" : "template"),
        projectDir,
        remixVersion: flags.remixVersion,
-        installDeps: flags.install ?? answers.install,
+        installDeps: flags.install || answers.install,
+        useTypeScript: flags.typescript || answers.useTypeScript,
        useTypeScript: flags.typescript ?? answers.useTypeScript,


heh oops, the commit suggestion didn't let me remove the previous useTypeScript 🤦

and appTemplate needs to be updated to || as well :oof:

kentcdodds · 2022-03-29T20:27:47Z

packages/remix-dev/cli/run.ts

 import inquirer from "inquirer";
-// import chalkAnimation from "chalk-animation";


Could you remove this dep from the lockfile and package.json so we can close #2547?

kiliman · 2022-03-29T20:55:19Z

Hmm.. just noticed that create-remix@latest doesn't even announce that you're creating a Remix project. Also, a previous version stopped displaying the version as well.

Any chance we can get those back in the CLI? It's nice knowing what version I'm going to be installing.

kentcdodds · 2022-03-29T20:59:59Z

Once we get this merged, I'm going to be doing a bit more work in the CLI too. I may bring back the animated thing as well.

mcansh · 2022-03-29T21:03:02Z

Hmm.. just noticed that create-remix@latest doesn't even announce that you're creating a Remix project. Also, a previous version stopped displaying the version as well.

looks like 1.3.3 dropped the "welcome" message and 1.3.0 dropped the version and animation when we did some reshuffling - hoping to bring both back soon enough

mcansh · 2022-03-29T21:03:56Z

Once we get this merged, I'm going to be doing a bit more work in the CLI too. I may bring back the animated thing as well.

sweet! i loved that little touch

brophdawg11 · 2022-03-29T21:36:33Z

I may bring back the animated thing as well.

yes please!! 🙌

chaance · 2022-03-29T22:00:15Z

Note about the animation: I like it as well but it creates some noise for screen-reader users. Want to make sure we ensure that the --no-color flag is respected there.

kentcdodds · 2022-03-30T17:17:43Z

I'm going to get this across the line. Just putting it into cli-temp for now so I can combine it with my test improvements.

…#2500) Co-authored-by: Logan McAnsh <logan@mcan.sh>

chaance added 2 commits March 25, 2022 13:59

fix(cli): Remove excess fetching + error handling

ec9cbec

Instead of fetching early to detect template types, we can simplify the code and speed up the setup process with a few heuristics.

Merge branch 'dev' of github.com:remix-run/remix into chance/cli-opti…

2da79b4

…mizations

remix-cla-bot bot added the CLA Signed label Mar 25, 2022

chaance commented Mar 25, 2022

View reviewed changes

packages/remix-dev/cli/create.ts Outdated Show resolved Hide resolved

rm error

ab86188

brophdawg11 reviewed Mar 25, 2022

View reviewed changes

packages/remix-dev/cli/create.ts Show resolved Hide resolved

chaance added 3 commits March 26, 2022 14:40

update tests

f6eb0e3

Check for existing template before extraction

bbca18b

fix stack entries

a30bbd9

MichaelDeBoey changed the title ~~fix(cli): Remove excess fetching and improve error handling~~ fix(remix-dev/cli): Remove excess fetching and improve error handling Mar 27, 2022

MichaelDeBoey added the package:dev label Mar 27, 2022

chaance added 4 commits March 27, 2022 17:24

move validation to initial run stage

4813297

Merge branch 'dev' of github.com:remix-run/remix into chance/cli-opti…

c0d5e12

…mizations

simplify error handling

34ccdee

re-org and fix bug

1111563

chaance mentioned this pull request Mar 28, 2022

fix(cli): stop CLI from logging full stack trace on known errors #2525

Merged

chaance added 5 commits March 28, 2022 15:25

tweak error handling

64d5cf0

Merge branch 'dev' into chance/cli-optimizations

937e804

Merge branch 'dev' into chance/cli-optimizations

a4821a2

rm extra case

178569b

fix logging and update tests

25faed6

mcansh approved these changes Mar 29, 2022

View reviewed changes

This was referenced Mar 29, 2022

feat(remix-dev): add validation when choosing a directory in create command #2439

Closed

test(remix-dev): mock api calls to GitHub #2467

Closed

chore(remix-dev): update error message in the event of a bad GITHUB_TOKEN #2446

Closed

mcansh reviewed Mar 29, 2022

View reviewed changes

packages/remix-dev/cli/run.ts Outdated Show resolved Hide resolved

chaance and others added 3 commits March 29, 2022 08:05

formatting

15f77bd

formatting

e83cb14

Update packages/remix-dev/cli/run.ts

cd5451d

Co-authored-by: Logan McAnsh <logan@mcan.sh>

mcansh reviewed Mar 29, 2022

View reviewed changes

kentcdodds reviewed Mar 29, 2022

View reviewed changes

mcansh mentioned this pull request Mar 29, 2022

create-remix templates don't work if a local folder of the same name as the template exists #2491

Closed

chaance mentioned this pull request Mar 29, 2022

chore(remix-dev): remove unused chalk-animation dependency #2547

Merged

MichaelDeBoey mentioned this pull request Mar 30, 2022

Running npm audit fix when using remix 1.3.3 causes broken build #2553

Closed

kentcdodds changed the base branch from dev to cli-temp March 30, 2022 17:17

kentcdodds merged commit f957655 into cli-temp Mar 30, 2022

kentcdodds deleted the chance/cli-optimizations branch March 30, 2022 17:17

kentcdodds pushed a commit that referenced this pull request Apr 5, 2022

fix(remix-dev/cli): Remove excess fetching and improve error handling (…

f2330c9

…#2500) Co-authored-by: Logan McAnsh <logan@mcan.sh>

kentcdodds pushed a commit that referenced this pull request Apr 5, 2022

fix(remix-dev/cli): Remove excess fetching and improve error handling (…

39d4b5b

…#2500) Co-authored-by: Logan McAnsh <logan@mcan.sh>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(remix-dev/cli): Remove excess fetching and improve error handling #2500

fix(remix-dev/cli): Remove excess fetching and improve error handling #2500

chaance commented Mar 25, 2022 •

edited

Loading

mcansh commented Mar 29, 2022

chaance commented Mar 29, 2022

mcansh Mar 29, 2022 •

edited

Loading

kentcdodds Mar 29, 2022

kiliman commented Mar 29, 2022

kentcdodds commented Mar 29, 2022

mcansh commented Mar 29, 2022

mcansh commented Mar 29, 2022

brophdawg11 commented Mar 29, 2022

chaance commented Mar 29, 2022

kentcdodds commented Mar 30, 2022

		import inquirer from "inquirer";
		// import chalkAnimation from "chalk-animation";

fix(remix-dev/cli): Remove excess fetching and improve error handling #2500

fix(remix-dev/cli): Remove excess fetching and improve error handling #2500

Conversation

chaance commented Mar 25, 2022 • edited Loading

mcansh commented Mar 29, 2022

chaance commented Mar 29, 2022

mcansh Mar 29, 2022 • edited Loading

Choose a reason for hiding this comment

kentcdodds Mar 29, 2022

Choose a reason for hiding this comment

kiliman commented Mar 29, 2022

kentcdodds commented Mar 29, 2022

mcansh commented Mar 29, 2022

mcansh commented Mar 29, 2022

brophdawg11 commented Mar 29, 2022

chaance commented Mar 29, 2022

kentcdodds commented Mar 30, 2022

chaance commented Mar 25, 2022 •

edited

Loading

mcansh Mar 29, 2022 •

edited

Loading