Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(cli): output help when no conventional config + no subcommand #9648

Merged
merged 1 commit into from
Dec 21, 2023
Merged

fix(cli): output help when no conventional config + no subcommand #9648

merged 1 commit into from
Dec 21, 2023

Conversation

Josh-Cena
Copy link
Collaborator

Pre-flight checklist

Motivation

Test Plan

  • Delete website/docusaurus.config.ts
  • Run yarn docusaurus --help
  • See that it now outputs help instead of erroring

I'm not sure if this is a good solution, and I added a few TODOs.

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

@Josh-Cena Josh-Cena requested a review from slorber as a code owner December 19, 2023 20:05
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 19, 2023
@netlify Netlify
Copy link

netlify bot commented Dec 19, 2023

✅ [V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 5cb08c2
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/6581f7b178ed770008e09eec
😎 Deploy Preview https://deploy-preview-9648--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

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 GitHub Actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 81 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 89 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 75 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 75 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 65 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 75 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 78 🟢 100 🟢 100 🟢 90 🟠 89 Report

@slorber slorber added pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus labels Dec 21, 2023
@slorber
Copy link
Collaborator

slorber commented Dec 21, 2023

Thanks

That looks good enough to merge as-is and fix the error message
But if you want to follow-up and provide a way to support yarn docusaurus --config why not.

@slorber slorber merged commit 60d62d1 into facebook:main Dec 21, 2023
34 checks passed
@Josh-Cena Josh-Cena deleted the fix-cli branch December 21, 2023 21:56
slorber pushed a commit that referenced this pull request Jan 5, 2024
@Josh-Cena @slorber
fix(cli): output help when no conventional config + no subcommand (#9648
839ccbd 
)
slorber added a commit that referenced this pull request Jan 5, 2024
@slorber @Josh-Cena
@heysokam @c0h1b4 @jgarrow @OzakIOne @axmmisaka @tats-u @SimenB
chore: release Docusaurus v3.1 (#9705)
7b1b890 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Ivan Mar (sOkam!) <7308253+heysokam@users.noreply.github.com>
Co-authored-by: c0h1b4 <dwidman@gmail.com>
Co-authored-by: Janessa Garrow <janessa.garrow@gmail.com>
Co-authored-by: ozaki <29860391+OzakIOne@users.noreply.github.com>
Co-authored-by: axmmisaka <6500159+axmmisaka@users.noreply.github.com>
Co-authored-by: Tatsunori Uchino <tats.u@live.jp>
Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>
fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (#9477)
fix(content-blog): add baseUrl for author.image_url (#9581)
fix(type-aliases): add `title` prop for imported inline SVG React components (#9612)
fix(utils): Markdown link replacement with <> but no spaces (#9617)
fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (#9631)
fix(cli): output help when no conventional config + no subcommand (#9648)
fix CI job (#9604)
fix Lint Autofix workflow (#9632)
fix(pwa-plugin): upgrade workbox (#9668)
fix(create-docusaurus): fix init template code blocks, and little improvements (#9696)
fix(theme): allow empty code blocks and live playgrounds (#9704)
@slorber slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 5, 2024
slorber added a commit that referenced this pull request Jan 26, 2024
@slorber @Josh-Cena
@reece-white @Shreesh09 @NickGerleman @harryzcy @mcrstudio @heysokam @c0h1b4 @jgarrow @OzakIOne @axmmisaka @tats-u @SimenB @sanjaiyan-dev @jack-robson @dawei-wang @eitsupi
chore: release Docusaurus 3.1.1 (#9793)
72dcd0d 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Joey Clover <joey@popos.local>
Co-authored-by: reece-white <93522192+reece-white@users.noreply.github.com>
Co-authored-by: Shreesh Nautiyal <114166000+Shreesh09@users.noreply.github.com>
Co-authored-by: Nick Gerleman <nick@nickgerleman.com>
Co-authored-by: Chongyi Zheng <git@zcy.dev>
Co-authored-by: MCR Studio <99176216+mcrstudio@users.noreply.github.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Ivan Mar (sOkam!) <7308253+heysokam@users.noreply.github.com>
Co-authored-by: c0h1b4 <dwidman@gmail.com>
Co-authored-by: Janessa Garrow <janessa.garrow@gmail.com>
Co-authored-by: ozaki <29860391+OzakIOne@users.noreply.github.com>
Co-authored-by: axmmisaka <6500159+axmmisaka@users.noreply.github.com>
Co-authored-by: Tatsunori Uchino <tats.u@live.jp>
Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>
Co-authored-by: Sanjaiyan Parthipan <parthipankalayini@gmail.com>
Co-authored-by: Jack Robson <143492403+jack-robson@users.noreply.github.com>
Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com>
Co-authored-by: eitsupi <50911393+eitsupi@users.noreply.github.com>
fix(create-docusaurus): fix readme docusaurus 2 ref (#9487)
fix(theme): fix firefox CSS :has() support bug (#9530)
fix(theme): docs html sidebar items should always be visible (#9531)
fix: v3 admonitions should support v2 title syntax for nested admonitions (#9535)
fix(theme-classic): fixed wrong cursor on dropdown menu in navbar, when window is small (#9398)
fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (#9567)
fix: add v2 retrocompatible support for quoted admonitions (#9570)
fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (#9477)
fix(content-blog): add baseUrl for author.image_url (#9581)
fix(type-aliases): add `title` prop for imported inline SVG React components (#9612)
fix(utils): Markdown link replacement with <> but no spaces (#9617)
fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (#9631)
fix(cli): output help when no conventional config + no subcommand (#9648)
fix CI job (#9604)
fix Lint Autofix workflow (#9632)
fix(pwa-plugin): upgrade workbox (#9668)
fix(create-docusaurus): fix init template code blocks, and little improvements (#9696)
fix(theme): allow empty code blocks and live playgrounds (#9704)
fix(core): various broken anchor link fixes (#9732)
fix: remove old useless mdx typedefs (#9733)
fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (#9727)
fix(core): conditionally include `hostname` parameter when using… (#9407)
fix(create-docusaurus): fix typo in init template sample docs (#9783)
fix(mdx-loader): allow spaces before `mdx-code-block` info string (#9776)
fix(core): links with target "_blank" should no be checked by the broken link checker (#9788)
fix(core): broken links optimization behaves differently than non-optimized logic (#9791)
@NikolayS NikolayS mentioned this pull request Apr 24, 2024
Open
@Abuchtela Abuchtela mentioned this pull request May 20, 2024
Closed
This was referenced May 26, 2024
Closed
Closed
Closed
This was referenced May 26, 2024
Open
Open
Open
Open
This was referenced Jun 8, 2024
Open
Open
This was referenced Jun 14, 2024
Closed
Closed
This was referenced Jun 15, 2024
Closed
Closed
@qdraw qdraw mentioned this pull request Jun 15, 2024
Closed
This was referenced Jun 16, 2024
Closed
Closed
This was referenced Jun 20, 2024
Open
Open
@Abuchtela Abuchtela mentioned this pull request Jun 22, 2024
Closed
This was referenced Jun 22, 2024
Closed
Closed
Merged
@kaelynj kaelynj mentioned this pull request Jun 23, 2024
Closed
This was referenced Jul 17, 2024
Merged
Merged
Merged
Merged
This was referenced Jul 21, 2024
Closed
Closed
This was referenced Jul 21, 2024
Open
Open
Open
This was referenced Aug 4, 2024
Merged
Closed
@Abuchtela Abuchtela mentioned this pull request Aug 11, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slorber slorber Awaiting requested review from slorber slorber is a code owner

Assignees
No one assigned
Labels
backported This PR has been backported to a stable version of Docusaurus CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docusaurus CLI throws when no subcommand is provided and when not using conventional config name
3 participants
@Josh-Cena @slorber @facebook-github-bot