feat(command-init): recommend build plugins #1836

erezrokah · 2021-02-02T18:16:52Z

- Summary

Fixes #1832 pending netlify/framework-info#123 and netlify/next-runtime#93

- Test plan

Going to do some more testing once the blocking issues are completed

- Description for the changelog

Recommend plugins during ntl init command and let the user choose if to install them

- A picture of a cute animal (not mandatory but encouraged)

TODO

Get site Node.js runtime version and pass to framework-info
Maybe use plugin names instead of package names?

verythorough · 2021-02-03T01:41:20Z

This is cool, @erezrokah! Is it possible to add an explanatory line before the question prompt?

erezrokah · 2021-02-03T10:09:33Z

This is cool, @erezrokah! Is it possible to add an explanatory line before the question prompt?

Great idea! Of course we can

verythorough · 2021-02-05T01:01:46Z

This is cool, @erezrokah! Is it possible to add an explanatory line before the question prompt?

Great idea! Of course we can

🎉 @rstavchansky Can you work with @erezrokah to develop an appropriate message? Since this functionality will be used for multiple frameworks/plugins, I'm guessing this will need to be a more general message, like, "Based on the technology used in your site, we recommend the following plugin(s):"

rstavchansky · 2021-02-05T17:11:43Z

After some discussion in Slack to understand the mode of detection, I'm making this recommendation:

Single recommended plugin flow

Seems like this is a {detected framework} site. 
Recommended Build Plugin: {list single plugin}
Install {single plugin name}?

Multiple recommended plugins flow

Seems like this is a {detected framework} site. 
Recommended Build Plugins: {list multiple plugins}
Which plugins to install?

One thing to consider - Is it possible to add a link to the plugin's readme so people can see what they're installing? (I supposed you’d have to get that link from the plugins.json file, though, unless you could predict it programmatically.)

A note on capitalization from the Style Guide: Build Plugins is capitalized since it's a formal feature name. plugins is not.

erezrokah · 2021-02-09T19:43:03Z

One thing to consider - Is it possible to add a link to the plugin's readme so people can see what they're installing? (I supposed you’d have to get that link from the plugins.json file, though, unless you could predict it programmatically.)

Sure we can add the link

erezrokah · 2021-02-09T20:20:31Z

Update

Single plugin:
Multiple plugins:

This is pending a decision if to use plugin package names or plugins names.
I also opened netlify/framework-info#133 so we can show a pretty title of the framework.
Also I'm not sure where we can fit a README link (unless we shorten them, I think @eduardoboucas had that idea a while back).

verythorough · 2021-02-11T03:46:11Z

This is pending a decision if to use plugin package names or plugins names.

If the human-readable names are available, I think those are best.

erezrokah · 2021-02-11T11:44:25Z

Latest version:

Single plugin

Multiple plugins

Pre-selection

Post-selection

erezrokah · 2021-02-17T14:53:27Z

tests/command.init.test.js

+}
+
+test('netlify init existing site', async (t) => {
+  const initQuestions = [


Figured it's time for us to be able to test the CLI input prompts. If you think of a better way to do this please let me know.

This is great! 🎉

JGAntunes

👍 🚀

JGAntunes · 2021-02-17T16:28:22Z

src/utils/init/frameworks.js

+const getFrameworkInfo = async ({ siteRoot, nodeVersion }) => {
+  const frameworks = await listFrameworks({ projectDir: siteRoot, nodeVersion })
+  if (frameworks.length !== 0) {
+    const [


Are we only considering the first element of the array on purpose (i.e. the framework-info lib is only returning one framework for the time being)?

It might detect a few frameworks - the first one has higher priority based on the order in https://github.com/netlify/framework-info/blob/32c58bb8de2f86874a61bdc7abab059c4c638f6c/src/frameworks/main.js#L4.

I wouldn't mind having a comment here just highlighting that (we pick the first as its the highest priority). Not critical though, happy to move forward if you feel like it doesn't make sense @erezrokah 👍

That makes sense. I'll add it

Done in e1a410e

JGAntunes · 2021-02-17T16:31:46Z

tests/command.init.test.js

+}
+
+test('netlify init existing site', async (t) => {
+  const initQuestions = [


This is great! 🎉

erezrokah · 2021-02-17T17:54:30Z

FYI, this is pending the release of netlify/next-runtime#94 (it was merged but not released). cc @lindsaylevine

iKristy · 2021-02-17T20:08:59Z

Just a suggestion, and please show me the door if you think this is crazy or stupid, but wondering if some iconography (utilizing emojis) might help to grok this (since the message is a bit longer than the other one-liner prompts), as well kind of indent the text under the first line.

So... something like this, maybe?

Seems like this is a {detected framework} site.
❇️ Recommended Build Plugin: {list single plugin}
➡️ Install {single plugin name}?

Again, totally a non-blocking suggestion! Feel free to ignore.

lindsaylevine · 2021-02-18T02:46:38Z

FYI, this is pending the release of netlify/netlify-plugin-nextjs#94 (it was merged but not released). cc @lindsaylevine

released to npm, pending this PR to plugins netlify/plugins#222

github-actions bot added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Feb 2, 2021

This was referenced Feb 7, 2021

chore: enforce Netlify style guide in CLI #1846

Open

Feature: add frameworks titles netlify/framework-info#133

Closed

erezrokah force-pushed the feat/recommend_plugins branch from 7c311ab to 81ef433 Compare February 9, 2021 20:23

erezrokah mentioned this pull request Feb 10, 2021

feat!: rename name property to id netlify/framework-info#137

Merged

erezrokah force-pushed the feat/recommend_plugins branch from 81ef433 to 69b7d81 Compare February 10, 2021 14:31

erezrokah mentioned this pull request Feb 10, 2021

fix(deps): update dependency @netlify/framework-info to v3 #1866

Closed

1 task

erezrokah force-pushed the feat/recommend_plugins branch 2 times, most recently from 238ba5f to b80e574 Compare February 11, 2021 11:49

erezrokah marked this pull request as ready for review February 11, 2021 11:53

erezrokah requested a review from a team as a code owner February 11, 2021 11:53

erezrokah force-pushed the feat/recommend_plugins branch 4 times, most recently from 28dee85 to 8f021c6 Compare February 17, 2021 13:59

erezrokah requested a review from JGAntunes February 17, 2021 14:51

erezrokah commented Feb 17, 2021

View reviewed changes

JGAntunes approved these changes Feb 17, 2021

View reviewed changes

erezrokah force-pushed the feat/recommend_plugins branch from 8f021c6 to e1a410e Compare February 17, 2021 17:52

erezrokah added 5 commits March 16, 2021 11:00

fix: don't add plugins to netlify.toml

697cb19

fix: set defaut for multiple plugins list

23ddd67

chore: sync deps

9fa0fd8

fix: update messages and fix tests

7232b11

fix: revert command custom api host workaround

d69403b

erezrokah force-pushed the feat/recommend_plugins branch from fa06c9b to d69403b Compare March 16, 2021 10:12

erezrokah enabled auto-merge (squash) March 16, 2021 10:12

erezrokah disabled auto-merge March 16, 2021 10:12

erezrokah enabled auto-merge (squash) March 16, 2021 10:13

erezrokah merged commit 6a28c04 into master Mar 16, 2021

erezrokah deleted the feat/recommend_plugins branch March 16, 2021 10:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(command-init): recommend build plugins #1836

feat(command-init): recommend build plugins #1836

erezrokah commented Feb 2, 2021 •

edited

Loading

verythorough commented Feb 3, 2021

erezrokah commented Feb 3, 2021

verythorough commented Feb 5, 2021

rstavchansky commented Feb 5, 2021 •

edited

Loading

erezrokah commented Feb 9, 2021

erezrokah commented Feb 9, 2021

verythorough commented Feb 11, 2021

erezrokah commented Feb 11, 2021

erezrokah Feb 17, 2021

JGAntunes Feb 17, 2021

JGAntunes left a comment

JGAntunes Feb 17, 2021

erezrokah Feb 17, 2021

JGAntunes Feb 17, 2021

erezrokah Feb 17, 2021

erezrokah Feb 17, 2021

JGAntunes Feb 17, 2021

erezrokah commented Feb 17, 2021 •

edited

Loading

iKristy commented Feb 17, 2021

lindsaylevine commented Feb 18, 2021

feat(command-init): recommend build plugins #1836

feat(command-init): recommend build plugins #1836

Conversation

erezrokah commented Feb 2, 2021 • edited Loading

TODO

verythorough commented Feb 3, 2021

erezrokah commented Feb 3, 2021

verythorough commented Feb 5, 2021

rstavchansky commented Feb 5, 2021 • edited Loading

erezrokah commented Feb 9, 2021

erezrokah commented Feb 9, 2021

Update

verythorough commented Feb 11, 2021

erezrokah commented Feb 11, 2021

Single plugin

Multiple plugins

Pre-selection

Post-selection

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JGAntunes 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

erezrokah commented Feb 17, 2021 • edited Loading

iKristy commented Feb 17, 2021

lindsaylevine commented Feb 18, 2021

erezrokah commented Feb 2, 2021 •

edited

Loading

rstavchansky commented Feb 5, 2021 •

edited

Loading

erezrokah commented Feb 17, 2021 •

edited

Loading