[legacy-framework] Allow user to select a recipe with `blitz install` command #2828

mochi-sann · 2021-10-09T05:36:41Z

What are the changes and their implications?

If a user doesn't provide a recipe name, the command will show a prompt to choose a recipe from a list of available recipes.

Bug Checklist

Integration test added (see test docs if needed)

Feature Checklist

Integration test added (see test docs if needed)
Documentation added/updated (submit PR to blitzjs.com repo)
document page pull request

mochi-sann · 2021-10-10T13:33:28Z

Oops, the list of recipes contains tsconfig.json which is not a recipe, I'll fix it.

mochi-sann · 2021-10-11T02:55:23Z

Oops, the list of recipes contains tsconfig.json which is not a recipe, I'll fix it.

I fixed it

Comments that have been pointed out `https://github.com/blitz-js/blitzjs.com/pull/568#pullrequestreview-775673698`

packages/cli/src/commands/install.ts

beerose · 2021-10-11T09:44:20Z

Thanks for your contribution, @mochi-sann!

And thanks for the review, @piotrski!

Accept reviews for blitz-js#2828 (comment) Co-authored-by: Piotrek Tomczewski <[email protected]>

…itz into blitz-cli-add-import_-list

mochi-sann · 2021-10-12T05:54:16Z

Fixed to use table helper from @blitzjs/display. Please review.

beerose

Great job! Left minor comments.

Do you think, we could have some tests for that here: https://github.com/blitz-js/blitz/blob/canary/packages/cli/test/commands/install.test.ts#L4?

packages/cli/src/commands/install.ts

beerose · 2021-10-16T09:18:50Z

I made it so that the prompt to select Recipe appears as in the video.

Wow! So cool! I'll take a look on Monday and review.

abuuzayr · 2021-10-16T09:29:31Z

this looks awesome @mochi-sann thank you!

s-r-x · 2021-10-17T05:45:18Z

👍 good stuff

packages/cli/src/commands/install.ts

beerose · 2021-10-17T14:43:10Z

packages/cli/src/commands/install.ts

+    if (flags.list || !args.recipe) {
+      const officialRecipeList = await this.getOfficialRecipeList()
+      recipeInfo = this.normalizeRecipePath(await this.officialRecipeListTable(officialRecipeList))


Wondering do we still need the --list flag if it's handled in the same way as not passing the arg? What do you think?

The Gatsby.js cli, which also implements Recipe, works in a similar way, but without the list flag, so we think the Blitz cli should be able to do the same without the list flag

9661bf3
I removed list flag

Co-authored-by: Aleksandra Sikora <[email protected]>

…t flag is present or not.

beerose

Works amazing! Thank you a lot for your contribution and sorry for a lot of back and forth with review

I pushed a small change to fix Cloning GitHub repository for undefined recipe message when selecting a recipe via prompt

beerose · 2021-10-18T09:15:45Z

You can go ahead and update the docs PR according to the latest changes :)

…itz into blitz-cli-add-import_-list

packages/cli/src/commands/install.ts

packages/cli/test/commands/install.test.ts

blitzjs-bot · 2021-10-18T11:13:06Z

Added @mochi-sann contributions for code and test

mochi-sann added 6 commits October 9, 2021 11:05

add -list flags

ab76352

Create a function to display a list of official recipes

04334f1

set to callback null

934fe8d

Array without undefinded

41b5257

show official list in cli table

81bd445

fix: recipe list Head text

a902f94

blitzjs-bot added the status/in-progress label Oct 9, 2021

Merge branch 'canary' into blitz-cli-add-import_-list

ee3f540

mochi-sann marked this pull request as ready for review October 9, 2021 07:57

mochi-sann requested review from beerose and flybayer as code owners October 9, 2021 07:57

blitzjs-bot added status/in-review and removed status/in-progress labels Oct 9, 2021

mochi-sann changed the title ~~blitz cli add import list~~ Add a list of recipes to the Blitz CLI command Oct 9, 2021

This was referenced Oct 10, 2021

docs: add blitz install --list document mochi-sann/blitzjs.com#1

Closed

update blitz install docs blitz-js/blitzjs.com#568

Merged

fix(cli): Don't include tsconfig.json in Recipe list.

a91ea88

fix(cli): change table head

2187d1d

Comments that have been pointed out `https://github.com/blitz-js/blitzjs.com/pull/568#pullrequestreview-775673698`

piotrski reviewed Oct 11, 2021

View reviewed changes

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

mochi-sann and others added 4 commits October 12, 2021 13:53

use to reduce Update packages/cli/src/commands/install.ts

620ab7f

Accept reviews for blitz-js#2828 (comment) Co-authored-by: Piotrek Tomczewski <[email protected]>

Change table display from cli-table to @blitzjs/display

be2ef2d

Merge branch 'blitz-cli-add-import_-list' of github.com:mochi-sann/bl…

3c5e0fc

…itz into blitz-cli-add-import_-list

add return

a3d7f4b

beerose reviewed Oct 12, 2021

View reviewed changes

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

beerose reviewed Oct 17, 2021

View reviewed changes

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

beerose reviewed Oct 17, 2021

View reviewed changes

mochi-sann and others added 4 commits October 18, 2021 09:20

Update packages/cli/src/commands/install.ts

ebf437d

Co-authored-by: Aleksandra Sikora <[email protected]>

Modify as suggested

be69493

Remove the list flag because the behavior is the same whether the lis…

9661bf3

…t flag is present or not.

minor changes

3a04e8a

beerose previously approved these changes Oct 18, 2021

View reviewed changes

beerose added 4 commits October 18, 2021 11:15

Merge branch 'canary' into blitz-cli-add-import_-list

1f35d3f

Merge branch 'canary' into blitz-cli-add-import_-list

7c04687

fix console message

08cdf28

Merge branch 'blitz-cli-add-import_-list' of github.com:mochi-sann/bl…

57a4588

…itz into blitz-cli-add-import_-list

beerose dismissed their stale review via 57a4588 October 18, 2021 09:28

beerose reviewed Oct 18, 2021

View reviewed changes

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

Update packages/cli/src/commands/install.ts

d582aab

beerose reviewed Oct 18, 2021

View reviewed changes

packages/cli/src/commands/install.ts Outdated Show resolved Hide resolved

Fix typo

d23f966

beerose changed the title ~~Add a list of recipes to the Blitz CLI command~~ Add recipes prompt to blitz install command Oct 18, 2021

beerose changed the title ~~Add recipes prompt to blitz install command~~ Allow user to select a recipe with blitz install command Oct 18, 2021

beerose reviewed Oct 18, 2021

View reviewed changes

packages/cli/test/commands/install.test.ts Outdated Show resolved Hide resolved

Update packages/cli/test/commands/install.test.ts

875d41e

beerose merged commit 3c62425 into blitz-js:canary Oct 18, 2021

blitzjs-bot added status/done and removed status/in-review labels Oct 18, 2021

itsdillon changed the title ~~Allow user to select a recipe with blitz install command~~ [legacy-framework] Allow user to select a recipe with blitz install command Jul 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[legacy-framework] Allow user to select a recipe with `blitz install` command #2828

[legacy-framework] Allow user to select a recipe with `blitz install` command #2828

mochi-sann commented Oct 9, 2021 •

edited by beerose

Loading

mochi-sann commented Oct 10, 2021

mochi-sann commented Oct 11, 2021

beerose commented Oct 11, 2021 •

edited

Loading

mochi-sann commented Oct 12, 2021

beerose left a comment

beerose commented Oct 16, 2021

abuuzayr commented Oct 16, 2021

s-r-x commented Oct 17, 2021

beerose Oct 17, 2021

mochi-sann Oct 18, 2021 •

edited

Loading

mochi-sann Oct 18, 2021

beerose left a comment •

edited

Loading

beerose commented Oct 18, 2021

blitzjs-bot commented Oct 18, 2021

[legacy-framework] Allow user to select a recipe with blitz install command #2828

[legacy-framework] Allow user to select a recipe with blitz install command #2828

Conversation

mochi-sann commented Oct 9, 2021 • edited by beerose Loading

What are the changes and their implications?

Bug Checklist

Feature Checklist

mochi-sann commented Oct 10, 2021

mochi-sann commented Oct 11, 2021

beerose commented Oct 11, 2021 • edited Loading

mochi-sann commented Oct 12, 2021

beerose left a comment

Choose a reason for hiding this comment

beerose commented Oct 16, 2021

abuuzayr commented Oct 16, 2021

s-r-x commented Oct 17, 2021

beerose Oct 17, 2021

Choose a reason for hiding this comment

mochi-sann Oct 18, 2021 • edited Loading

Choose a reason for hiding this comment

mochi-sann Oct 18, 2021

Choose a reason for hiding this comment

beerose left a comment • edited Loading

Choose a reason for hiding this comment

beerose commented Oct 18, 2021

blitzjs-bot commented Oct 18, 2021

[legacy-framework] Allow user to select a recipe with `blitz install` command #2828

[legacy-framework] Allow user to select a recipe with `blitz install` command #2828

mochi-sann commented Oct 9, 2021 •

edited by beerose

Loading

beerose commented Oct 11, 2021 •

edited

Loading

mochi-sann Oct 18, 2021 •

edited

Loading

beerose left a comment •

edited

Loading