refactor(cli): make the CLI an even thinner wrapper around command functions #7583
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Josh-Cena
added
the
pr: maintenance
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +79 B (0%) Total Size: 801 kB
ℹ️ View Unchanged
|
slorber
approved these changes
Jun 15, 2022
| siteDir: string, | ||
| ): Promise<void> { | ||
| export async function externalCommand(cli: CommanderStatic): Promise<void> { | ||
| const siteDir = await fs.realpath('.'); |
There was a problem hiding this comment.
🤔 that looks different from the other cli commands 🤪
But same as before so maybe a different issue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pre-flight checklist
Motivation
The reason is because the commander functions are very weakly typed: basically
action(fn: (...args: any[]) => void | Promise<void>). This makes TS-ESLint whine about unsafe arguments when we pass theseanyinto our actual function, even when it's actually safe.This also means people who try to use these functions on Node side do not immediately get feature parity with the CLI: they have to resolve site directory, they have to apply default values (see also #7220), they have to even change the order of parameters.
We should just handle these ourselves. The CLI is just a very thin wrapper that automatically invokes these functions. Now users can do
await docusaurus.build();without passing any arguments.Test Plan
Test links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs