feat(create-docusaurus): ask user for preferred language when no language CLI option provided #9442

Rafael-Martins · 2023-10-24T00:29:25Z

Pre-flight checklist

I have read the Contributing Guidelines on pull requests.

Motivation

Following the issue #9401, I created a prompt that just shows up when neither --javascript or --typescript is passed

Usage screenshot

Related issues/PRs

#9401

…rmed

facebook-github-bot · 2023-10-24T00:29:30Z

Hi @Rafael-Martins!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

netlify · 2023-10-24T00:33:05Z

✅ [V2]

Name	Link
🔨 Latest commit	`fd41b61`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/65cdfaa2d4de890008aa1172
😎 Deploy Preview	https://deploy-preview-9442--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2023-10-24T00:35:04Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 67	🟢 98	🟢 96	🟢 100	🟠 88	Report
/docs/installation	🟠 89	🟢 96	🟢 100	🟢 100	🟠 88	Report
/docs/category/getting-started	🟠 76	🟢 100	🟢 100	🟢 90	🟠 88	Report
/blog	🟠 71	🟢 100	🟢 100	🟢 90	🟠 88	Report
/blog/preparing-your-site-for-docusaurus-v3	🟠 64	🟢 96	🟢 100	🟢 100	🟠 88	Report
/blog/tags/release	🟠 71	🟢 100	🟢 100	🟠 80	🟠 88	Report
/blog/tags	🟠 76	🟢 100	🟢 100	🟢 90	🟠 88	Report

facebook-github-bot · 2023-10-24T01:10:11Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

slorber

Thanks

It's probably working but the code flow is not super clear, I'd appreciate if you refactor it a bit more.

For example getSource should probably get a clear language: "javascript" | "typescript" attribute instead of overridden cli options

Not sure how hard this would be but if there's only a JS template option and no TS variant available for that template, maybe we could avoid the extra prompt because we'll ask an extra useless question

slorber · 2023-10-24T09:59:32Z

packages/create-docusaurus/src/index.ts

+  let language: {javascript?: boolean; typescript?: boolean} = {};
+  if (!cliOptions.typescript && !cliOptions.javascript) {
+    const {language: selectedLanguage} = (await prompts(
+      {
+        type: 'select',
+        name: 'language',
+        message: 'What language you want to use?',
+        choices: [
+          {title: 'JavaScript', value: 'javascript'},
+          {title: 'TypeScript', value: 'typescript'},
+        ],
+      },
+      {
+        onCancel() {
+          logger.info`Falling back to language=${'javascript'}`;
+        },
+      },
+    )) as {language: keyof Languages};
+
+    language = {[selectedLanguage]: true};
+  }


Could you encapsulate all this under an abstraction?

Something like:

async function getLanguage(languages: LanguagesOptions): Promise<"javascript" | "typescript">

We'll likely use in other places in the future, cf swizzle CLI:
#9402

So that's worth extracting this to docusaurus-utils > cliUtils.ts immediately IMHO so that we'll be able to reuse it in other places

packages/create-docusaurus/src/index.ts

extract language logic into cliUtils consider template to decide if the prompt will show or not

Rafael-Martins · 2023-10-25T19:41:28Z

Hey @slorber, I addressed the comments above, let me now if we can improve it even more!

Josh-Cena · 2023-10-29T16:29:25Z

packages/docusaurus-utils/src/cliUtils.ts

+  typescript?: boolean;
+};
+
+export async function getLanguage(


This function is only used in create-docusaurus. Please don't put it in utils. (You even had to add an entire prompts dependency.)

Hello, I carried out this extraction in response to @slorber's comment, which suggested that it might be reused in another part of the code. If that's the case, I'm considering passing the 'prompt' function as a parameter to eliminate the dependency. What are your thoughts on this idea? I'm also open to the possibility of reintegrating it into 'create-docusaurus' if that's a better solution.

yes, considering we also want this for swizzle it's fine to add it to docusaurus utils

see also related pr: #9681

slorber · 2024-01-12T22:29:27Z

packages/docusaurus-utils/src/cliUtils.ts

+  typescript?: boolean;
+};
+
+export async function getLanguage(


yes, considering we also want this for swizzle it's fine to add it to docusaurus utils

see also related pr: #9681

slorber · 2024-01-12T22:30:15Z

packages/docusaurus-utils/src/cliUtils.ts

+  if (noTsVersionAvailable) {
+    return {javascript: true};
+  }


I'm not sure it's a good thing to have this thing here, will try to see where to move it

…efactor

slorber · 2024-02-15T12:04:22Z

Thanks 👍

I took the opportunity to refactor a bit the CLI because it was quite messy 🤪

Also adjusting the way we prompt for the language choice because we are going to share some code with another related PR: #9681

will be in v3.2

feat(create-docusaurus): added a language prompt when no flag is info…

e5f7b9b

…rmed

Rafael-Martins requested review from slorber, lex111 and Josh-Cena as code owners October 24, 2023 00:29

Rafael-Martins changed the title ~~feat(create-docusaurus): added a language prompt when no flag is info…~~ feat(create-docusaurus): added a language prompt when no flag is provided Oct 24, 2023

facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 24, 2023

slorber requested changes Oct 24, 2023

View reviewed changes

fix: address pr review

0d38d2d

extract language logic into cliUtils consider template to decide if the prompt will show or not

Rafael-Martins requested a review from slorber October 25, 2023 19:39

Josh-Cena reviewed Oct 29, 2023

View reviewed changes

slorber added pr: new feature This PR adds a new API or behavior. to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 12, 2024

slorber requested changes Jan 12, 2024

View reviewed changes

slorber added 5 commits February 15, 2024 11:01

Merge branch 'main' into feature-language-selector-create-docussaurus

bd04865

Better handling of create-docusaurus javascript/typescript option + r…

7a3ce2a

…efactor

make sure generate examples is not prompted for js/ts language question

6bbaecd

fix e2e test script

5e97cee

lint

fd41b61

slorber changed the title ~~feat(create-docusaurus): added a language prompt when no flag is provided~~ feat(create-docusaurus): ask user for preferred language when no language CLI option provided Feb 15, 2024

slorber merged commit 628752d into facebook:main Feb 15, 2024
31 checks passed

slorber mentioned this pull request Feb 15, 2024

feat(swizzle): ask user preferred language if no language CLI option provided #9681

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(create-docusaurus): ask user for preferred language when no language CLI option provided #9442

feat(create-docusaurus): ask user for preferred language when no language CLI option provided #9442

Rafael-Martins commented Oct 24, 2023

facebook-github-bot commented Oct 24, 2023

netlify bot commented Oct 24, 2023 •

edited

github-actions bot commented Oct 24, 2023 •

edited

facebook-github-bot commented Oct 24, 2023

slorber left a comment •

edited

slorber Oct 24, 2023

Rafael-Martins commented Oct 25, 2023

Josh-Cena Oct 29, 2023 •

edited

Rafael-Martins Oct 30, 2023 •

edited

slorber Jan 12, 2024

slorber Jan 12, 2024

slorber Jan 12, 2024

slorber commented Feb 15, 2024

feat(create-docusaurus): ask user for preferred language when no language CLI option provided #9442

feat(create-docusaurus): ask user for preferred language when no language CLI option provided #9442

Conversation

Rafael-Martins commented Oct 24, 2023

Pre-flight checklist

Motivation

Usage screenshot

Related issues/PRs

facebook-github-bot commented Oct 24, 2023

Action Required

Process

netlify bot commented Oct 24, 2023 • edited

✅ [V2]

github-actions bot commented Oct 24, 2023 • edited

⚡️ Lighthouse report for the deploy preview of this PR

facebook-github-bot commented Oct 24, 2023

slorber left a comment • edited

Choose a reason for hiding this comment

slorber Oct 24, 2023

Choose a reason for hiding this comment

Rafael-Martins commented Oct 25, 2023

Josh-Cena Oct 29, 2023 • edited

Choose a reason for hiding this comment

Rafael-Martins Oct 30, 2023 • edited

Choose a reason for hiding this comment

slorber Jan 12, 2024

Choose a reason for hiding this comment

slorber Jan 12, 2024

Choose a reason for hiding this comment

slorber Jan 12, 2024

Choose a reason for hiding this comment

slorber commented Feb 15, 2024

netlify bot commented Oct 24, 2023 •

edited

github-actions bot commented Oct 24, 2023 •

edited

slorber left a comment •

edited

Josh-Cena Oct 29, 2023 •

edited

Rafael-Martins Oct 30, 2023 •

edited