Added ability to use custom template for scaffolding. #3025

revanth0212 · 2021-02-25T23:34:48Z

Description

This PR adds the ability to request the scaffolding program to use a custom template/version while creating a new project.

Related Issue

Closes PWA-483

Acceptance

Should be able to scaffold a new project using any compatible template on NPM.

Verification Stakeholders

@jimbo @dpatil-magento

Specification

Need to update docs the mention the same.

Verification Steps

Note: This won't work yet with yarn create @magento/pwa because we did not publish the new @magento/create-pwa yet. So let's test this using the new unpublished version locally.

Go to a folder where you would like to scaffold the new project.
In terminal run node PATH_TO_PWA_STUDIO/packages/create-pwa/bin/create-pwa
Answer all the questions.
For the question Which template would you like to use to bootstrap test? Defaults to venia-concept. enter any version from NPM. For instance: @magento/venia-concept@9.0.1-alpha.3. If you don't provide anything, it would check in the file system for venia-concept. If it can not find that, then it would search for a venia-concept in the local machine cache and use that instead.

Checklist

I have added tests to cover my changes, if necessary.
I have added translations for new strings, if necessary.
I have updated the documentation accordingly, if necessary.

PWAStudioBot · 2021-02-25T23:45:45Z

	Messages
📖	Associated JIRA tickets: PWA-483.
📖	DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖	Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

Generated by 🚫 dangerJS against ef00b5b

larsroettig

✔️ CodeRevbiew
✔️ TestCoverage
✔️ Mannual QA

sirugh

I'd like to see the default be @magento/venia-concept if possible. But this is great and allows people to target a specific template version! So simple...why didn't we do this before 🤣

sirugh · 2021-03-01T17:00:54Z

packages/create-pwa/lib/index.js

+            name: 'template',
+            message: ({ name }) =>
+                `Which template would you like to use to bootstrap ${name}? Defaults to venia-concept.`,
+            default: 'venia-concept'


Is there a difference between @magento/venia-concept and venia-concept? If not maybe we can use the namespaced version since it is similar to how a user would define by version

We are maintaining an array which will be matched against first. If that doesn't work, that's when the code looks to pull the package from NPM. The object that we have in that array is looking for venia-concept. You are right, what you mentioned is what the code does but right now the way the code is laid out works this way:

if template === 'venia-concept` // use local mapping to find the local venia-concept package else if template === anything other than `venia-concept` // check inside mac cache and if it does not find that package, fetch from NPM // if template is `@magento/venia-concept` use the latest stable version // if template has a version string attached, use the package with that particular version.

If we change the default to @magento/venia-concept instead, we won't be able to use local packages while developing. There definitely will be a way to do that, but do we need to spend more time on that? I did think about what you mentioned but opted out personally, but wanted to check with the team. Thanks for bringing this up buddy. Good question.

We discussed in dev time and I think we want to be pretty explicit here to avoid the "magic" that helped obscure the release bug.

Basically the target template input text should be the deployed name of the package, as if you were doing a yarn add ie https://classic.yarnpkg.com/en/docs/cli/add/. So in this case, defaulting to @magento/venia-concept is fine, but it should default to fetch the latest release version from remote, not local. To use local we would be explicit such as template: file:/path/to/local/folder.

I think the team had input so if you want to start a thread on slack about it, let's do it!

Done, handled.

revanth0212 · 2021-03-03T23:35:31Z

packages/create-pwa/lib/index.js

+        await execa.shell(`${buildpackBinLoc} ${argsString}`, {
+            stdio: 'inherit'
+        });
+    } catch (e) {


This is just a small change. Moved catch statement to the end of the function.

Thanks for the call out! You can see this by appending ?w=1 :) https://github.com/magento/pwa-studio/pull/3025/files?w=1

Good to know 👍

packages/pwa-buildpack/lib/cli/create-project.js

packages/create-pwa/lib/index.js

sirugh

Preliminary approval so we can get this in QA. The last of my comments have really been minor string changes which I'd like to see updated but no sense in delaying things.

Co-authored-by: Stephen <sirugh@users.noreply.github.com>

dpatil-magento · 2021-03-12T15:02:27Z

@revanth0212 Project built with local (packages/venia-concept) repo has errors after launching Venia and also storybook build fails.

…sion_label

dpatil-magento · 2021-03-12T22:17:44Z

QA Approved.

…ento/pwa-studio into revanth/custom_version_label

revanth0212 added 4 commits February 24, 2021 17:27

Using custom npm version for template.

f2f8fad

Minor.

fadd50f

Added questions related tests.

0a82675

Removing temp work.

c7f5682

m2-community-project bot added the Progress: ready for review label Feb 25, 2021

PWAStudioBot added pkg:create-pwa pkg:pwa-buildpack labels Feb 25, 2021

revanth0212 changed the title ~~Revanth/custom version label~~ Added ability to use custom template for scaffolding. Feb 26, 2021

revanth0212 added the version: Minor This changeset includes functionality added in a backwards compatible manner. label Feb 26, 2021

revanth0212 marked this pull request as ready for review February 26, 2021 16:40

larsroettig self-requested a review February 28, 2021 10:32

larsroettig previously approved these changes Feb 28, 2021

View reviewed changes

m2-community-project bot assigned larsroettig Feb 28, 2021

m2-community-project bot added Progress: approved and removed Progress: ready for review labels Feb 28, 2021

sirugh requested changes Mar 1, 2021

View reviewed changes

m2-community-project bot assigned sirugh Mar 1, 2021

m2-community-project bot added Progress: changes requested and removed Progress: approved labels Mar 1, 2021

m2-community-project bot added Progress: review and removed Progress: changes requested labels Mar 2, 2021

revanth0212 added 2 commits March 3, 2021 17:08

Updated local package matching.

e70d9fe

Added remaining create pwa tests.

25bfdea

revanth0212 dismissed larsroettig’s stale review via 25bfdea March 3, 2021 23:33

Minor.

a58b073

revanth0212 commented Mar 3, 2021

View reviewed changes

Minor.

154a7f8

sirugh reviewed Mar 5, 2021

View reviewed changes

packages/pwa-buildpack/lib/cli/create-project.js Outdated Show resolved Hide resolved

Minor.

2c36eb4

sirugh reviewed Mar 9, 2021

View reviewed changes

packages/create-pwa/lib/index.js Outdated Show resolved Hide resolved

sirugh previously approved these changes Mar 9, 2021

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: review labels Mar 9, 2021

venia-concept -> @magento/venia-concept

26f08a9

Co-authored-by: Stephen <sirugh@users.noreply.github.com>

revanth0212 dismissed sirugh’s stale review via 26f08a9 March 9, 2021 16:11

sirugh previously approved these changes Mar 9, 2021

View reviewed changes

Merge remote-tracking branch 'origin/develop' into revanth/custom_ver…

7529f0e

…sion_label

revanth0212 dismissed sirugh’s stale review via 7529f0e March 12, 2021 18:14

Merge remote-tracking branch 'origin/develop' into revanth/custom_ver…

b89cc83

…sion_label

dpatil-magento force-pushed the revanth/custom_version_label branch from 7529f0e to b89cc83 Compare March 12, 2021 22:04

sirugh previously approved these changes Mar 15, 2021

View reviewed changes

Merge branch 'revanth/custom_version_label' of https://github.com/mag…

ef00b5b

…ento/pwa-studio into revanth/custom_version_label

dpatil-magento dismissed sirugh’s stale review via ef00b5b March 15, 2021 16:24

dpatil-magento force-pushed the revanth/custom_version_label branch from 0269eee to ef00b5b Compare March 15, 2021 16:24

dpatil-magento approved these changes Mar 15, 2021

View reviewed changes

m2-community-project bot assigned dpatil-magento Mar 15, 2021

sirugh approved these changes Mar 15, 2021

View reviewed changes

dpatil-magento merged commit e32bdff into develop Mar 15, 2021

m2-community-project bot added Progress: done and removed Progress: approved labels Mar 15, 2021

sirugh deleted the revanth/custom_version_label branch April 26, 2021 17:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added ability to use custom template for scaffolding. #3025

Added ability to use custom template for scaffolding. #3025

revanth0212 commented Feb 25, 2021 •

edited

Loading

PWAStudioBot commented Feb 25, 2021 •

edited

Loading

larsroettig left a comment

sirugh left a comment

sirugh Mar 1, 2021

revanth0212 Mar 2, 2021

sirugh Mar 2, 2021

revanth0212 Mar 3, 2021

revanth0212 Mar 3, 2021

sirugh Mar 4, 2021

revanth0212 Mar 4, 2021

sirugh left a comment

dpatil-magento commented Mar 12, 2021

dpatil-magento commented Mar 12, 2021

Added ability to use custom template for scaffolding. #3025

Added ability to use custom template for scaffolding. #3025

Conversation

revanth0212 commented Feb 25, 2021 • edited Loading

Description

Related Issue

Acceptance

Verification Stakeholders

Specification

Verification Steps

Checklist

PWAStudioBot commented Feb 25, 2021 • edited Loading

larsroettig left a comment

Choose a reason for hiding this comment

sirugh left a comment

Choose a reason for hiding this comment

sirugh Mar 1, 2021

Choose a reason for hiding this comment

revanth0212 Mar 2, 2021

Choose a reason for hiding this comment

sirugh Mar 2, 2021

Choose a reason for hiding this comment

revanth0212 Mar 3, 2021

Choose a reason for hiding this comment

revanth0212 Mar 3, 2021

Choose a reason for hiding this comment

sirugh Mar 4, 2021

Choose a reason for hiding this comment

revanth0212 Mar 4, 2021

Choose a reason for hiding this comment

sirugh left a comment

Choose a reason for hiding this comment

dpatil-magento commented Mar 12, 2021

dpatil-magento commented Mar 12, 2021

revanth0212 commented Feb 25, 2021 •

edited

Loading

PWAStudioBot commented Feb 25, 2021 •

edited

Loading