[CLI] Add interactive options for templates and starters #10433

markkaylor · 2021-06-03T15:58:24Z

What does it do?

Prompts user to select a template or starter

How to test it?

create-strapi-app: ./node_modules/.bin/create-strapi-app
create-strapi-starter: ./node_modules/.bin/create-strapi-starter

codecov · 2021-06-03T16:04:35Z

Codecov Report

Merging #10433 (e41e96c) into master (a860d74) will not change coverage.
The diff coverage is n/a.

❗ Current head e41e96c differs from pull request most recent head 32c36bc. Consider uploading reports for the commit 32c36bc to get more accurate results

@@           Coverage Diff           @@
##           master   #10433   +/-   ##
=======================================
  Coverage   58.01%   58.01%           
=======================================
  Files         185      185           
  Lines        6431     6431           
  Branches     1400     1400           
=======================================
  Hits         3731     3731           
  Misses       2236     2236           
  Partials      464      464

Flag	Coverage Δ
front	`∅ <ø> (∅)`
unit	`58.01% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a860d74...32c36bc. Read the comment docs.

alexandrebodin

My comments generaly also apply to the start CLI :)

packages/create-strapi-app/utils/prompt-user.js

packages/create-strapi-app/create-strapi-app.js

alexandrebodin · 2021-06-14T12:01:21Z

packages/create-strapi-app/utils/prompt-user.js

+ * @param {string} cliType - The type of cli: starters or templates
+ * @returns
+ */
+module.exports = async function promptUser(projectArgs) {


you are colling it with 2 args but only using one here

alexandrebodin · 2021-06-14T12:01:52Z

packages/create-strapi-app/utils/prompt-user.js

+ */
+module.exports = async function promptUser(projectArgs) {
+  const questions = await getPromptQuestions(projectArgs);
+  const prompt = await inquirer.prompt(questions);


you can return inquirer.prompt directly

alexandrebodin · 2021-06-14T12:02:38Z

packages/create-strapi-app/utils/prompt-user.js

+  return prompt;
+};
+
+async function getPromptOptions() {


this is only for template not for all options you might want to rename it to something more meaningful

packages/create-strapi-app/utils/prompt-user.js

packages/create-strapi-app/create-strapi-app.js

alexandrebodin · 2021-06-15T13:41:32Z

packages/create-strapi-app/create-strapi-app.js

+  });
+}
+
+initProject(projectName, program);


We can try to do programm.action(directory => initProject(directoru)))

maybe we will need to do .parseAsync(process.argv)

packages/create-strapi-app/create-strapi-app.js

packages/create-strapi-app/utils/prompt-user.js

alexandrebodin · 2021-06-21T18:06:15Z

packages/create-strapi-app/utils/prompt-user.js

+        'Would you like to use a template? (Templates are Strapi configurations designed for a specifc use case)',
+    },
+    {
+      name: 'template',


can we fetch the question choices only when the question should be displayed ? I think we should avoid fetching the question before rendering the prompt to improve the perceived speed

yes, sorry I thought that was already the behavior but it is not. I will take a look this morning.

pwizla · 2021-06-22T08:10:01Z

packages/create-strapi-app/utils/prompt-user.js

+      name: 'useTemplate',
+      when: !template,
+      message:
+        'Would you like to use a template? (Templates are Strapi configurations designed for a specifc use case)',


Suggested change

'Would you like to use a template? (Templates are Strapi configurations designed for a specifc use case)',

'Would you like to use a template? (Templates are Strapi configurations designed for a specific use case)',

Noticed a tiny typo while documenting / testing the feature :-)

Thanks so much Pierre!

See [this product PR](strapi/strapi#10433)

* Merge branch dev/installation-guides--cli * Merge branch dev/installation-guides--docker * Merge branch dev/installation-guides--render * Merge branch dev/installation-guides--platformsh * Update file-structure.md to properly format comments * Merge branch dev/installation-guides--intro * Merge branch dev/installation-guides--digitalocean * Update link to database section * Rework DigitalOcean customization part * Improve install. guides introduction * Replace deployed by hosted * Finalize Render install. guide * Use our new callout style 🤓 * Finalize CLI install. guide * Switch to card-style tabs in Docker install. guide * Finalize DigitalOcean install. guide * Add first draft of dedicated DigitalOcean config. guide * Improve the DigitalOcean config. guide * Add more improvements to the DigitalOcean config. guide * Add missing MongoDB drop warnings * Update PlatformSH guide to remove unnecessary *Next* steps. * Update docs/developer-docs/latest/setup-deployment-guides/installation/cli.md Co-authored-by: DMehaffy <derrickmehaffy@gmail.com> * Update docs/developer-docs/latest/setup-deployment-guides/installation.md Co-authored-by: DMehaffy <derrickmehaffy@gmail.com> * Add consistency for PaaS / IaaS * Remove commented out starters part * Put negative first on not-in-production note * Update docs/developer-docs/latest/setup-deployment-guides/installation/digitalocean-one-click.md * Fix duplicate warning in CLI.md after Github conflict fix commit * Update CLI install guide to reflect interactive CLI enhancements See [this product PR](strapi/strapi#10433) Co-authored-by: DMehaffy <derrickmehaffy@gmail.com>

markkaylor self-assigned this Jun 3, 2021

markkaylor force-pushed the feat/interactive-cli branch 3 times, most recently from 25da9e5 to eb9f660 Compare June 4, 2021 14:54

markkaylor changed the title ~~[CLI] Interactive CLI~~ [CLI] Add interactive options for templates and starters Jun 4, 2021

markkaylor force-pushed the feat/interactive-cli branch 2 times, most recently from 130bda7 to 5976b48 Compare June 4, 2021 16:03

markkaylor marked this pull request as ready for review June 7, 2021 09:30

markkaylor requested review from alexandrebodin and remidej June 7, 2021 09:30

markkaylor force-pushed the feat/interactive-cli branch from 5976b48 to 9fa7354 Compare June 14, 2021 07:47

alexandrebodin requested changes Jun 14, 2021

View reviewed changes

markkaylor requested a review from alexandrebodin June 14, 2021 15:49

alexandrebodin reviewed Jun 15, 2021

View reviewed changes

markkaylor force-pushed the feat/interactive-cli branch from b56785c to 3edc089 Compare June 16, 2021 14:05

markkaylor requested a review from alexandrebodin June 16, 2021 14:18

markkaylor force-pushed the feat/interactive-cli branch 2 times, most recently from e81192b to 4f97832 Compare June 18, 2021 14:55

alexandrebodin reviewed Jun 21, 2021

View reviewed changes

packages/create-strapi-app/utils/prompt-user.js Show resolved Hide resolved

markkaylor requested a review from alexandrebodin June 21, 2021 08:49

markkaylor force-pushed the feat/interactive-cli branch from 308d187 to d82dbbc Compare June 21, 2021 11:31

alexandrebodin added this to the 3.6.7 milestone Jun 21, 2021

alexandrebodin added source: cli Source is cli package issue: enhancement Issue suggesting an enhancement to an existing feature labels Jun 21, 2021

alexandrebodin reviewed Jun 21, 2021

View reviewed changes

pwizla reviewed Jun 22, 2021

View reviewed changes

markkaylor force-pushed the feat/interactive-cli branch 2 times, most recently from 0e976e9 to db38b73 Compare June 22, 2021 08:29

markkaylor requested a review from alexandrebodin June 22, 2021 08:30

markkaylor force-pushed the feat/interactive-cli branch from db38b73 to 1816825 Compare June 22, 2021 08:31

pwizla added a commit to strapi/documentation that referenced this pull request Jun 22, 2021

Update CLI install guide to reflect interactive CLI enhancements

3306376

See [this product PR](strapi/strapi#10433)

markkaylor force-pushed the feat/interactive-cli branch from 1816825 to 5cfcb14 Compare June 22, 2021 15:37

add interactive CLI for starters and templates

a655f86

markkaylor force-pushed the feat/interactive-cli branch from 5cfcb14 to a655f86 Compare June 23, 2021 12:12

Revert to node-fetch to lighten the packages

32c36bc

alexandrebodin approved these changes Jun 23, 2021

View reviewed changes

alexandrebodin merged commit 157f6cd into master Jun 23, 2021

alexandrebodin deleted the feat/interactive-cli branch June 23, 2021 13:16

This was referenced Jul 29, 2021

fix(deps): update strapi monorepo to v3.6.8 lucasaugustodeveloper/backend-won-games#6

Closed

Update strapi monorepo to v3.6.7 spences10/strapi-starter-nextjs-blog#34

Merged

renovate bot mentioned this pull request Aug 11, 2021

Update strapi monorepo to v3.6.7 spences10/dope-devs-backend#7

Merged

1 task

Bhanditz mentioned this pull request Jun 25, 2023

[Snyk] Fix for 14 vulnerabilities Bhanditz/strapi#130

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLI] Add interactive options for templates and starters #10433

[CLI] Add interactive options for templates and starters #10433

markkaylor commented Jun 3, 2021 •

edited

codecov bot commented Jun 3, 2021 •

edited

alexandrebodin left a comment

alexandrebodin Jun 14, 2021

alexandrebodin Jun 14, 2021

alexandrebodin Jun 14, 2021

alexandrebodin Jun 15, 2021

alexandrebodin Jun 21, 2021

markkaylor Jun 22, 2021

pwizla Jun 22, 2021

markkaylor Jun 22, 2021

	'Would you like to use a template? (Templates are Strapi configurations designed for a specifc use case)',
	'Would you like to use a template? (Templates are Strapi configurations designed for a specific use case)',

[CLI] Add interactive options for templates and starters #10433

[CLI] Add interactive options for templates and starters #10433

Conversation

markkaylor commented Jun 3, 2021 • edited

What does it do?

How to test it?

codecov bot commented Jun 3, 2021 • edited

Codecov Report

alexandrebodin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markkaylor commented Jun 3, 2021 •

edited

codecov bot commented Jun 3, 2021 •

edited