refactor: use yargs for the cli #791
Conversation
🦋 Changeset detectedLatest commit: a160fb5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
commit: |
Unknown args and args after If |
Is it what we want? |
| import { createOpenNextConfigIfNotExistent } from "../build/utils/create-config-files.js"; | ||
| import { setupCLI, withWranglerOptions, withWranglerPassthroughArgs } from "./setup-cli.js"; | ||
|
|
||
| async function buildCommand(args: { |
There was a problem hiding this comment.
It would be nice to add some JSDoc here.
i.e. does wranglerArgs contain config and env ?
Something like:
/**
* Implementation of the `opennextjs- clouflare command`
*
* @param ...
* @returns
*/An explicit return type would be nice too
| return buildImpl(options, config, { ...args, minify: !args.noMinify, sourceDir: baseDir }, wranglerConfig); | ||
| } | ||
|
|
||
| export function addBuildCommand<T extends yargs.Argv>(y: T) { |
There was a problem hiding this comment.
| export function addBuildCommand<T extends yargs.Argv>(y: T) { | |
| /** | |
| * Add the `build` command to yargs configuration | |
| * | |
| * Consumes 1 positional parameter | |
| */ | |
| export function addBuildCommand<T extends yargs.Argv>(y: T) { |
|
|
||
| async function buildCommand(args: { | ||
| wranglerArgs: string[]; | ||
| config: string | undefined; |
There was a problem hiding this comment.
nit: rename this to configPath (we also use config for the values in i.e. populateR2IncrementalCache)
| const nextAppDir = process.cwd(); | ||
|
|
||
| /** | ||
| * Setup the CLI, print necessary messages, and retrieve various options and configs. |
There was a problem hiding this comment.
setupCompiledAppCLI has the same comment.
What's the difference, when to use which ?
There was a problem hiding this comment.
IIUC the callback is to do some work in the middle of this function.
Another way could be do move this to the caller:
ShowHeader();
CompileConfig(); // for build
LoadConfig(); // for other commands
ExecuteCommand();Not sure if this would make the code easier to follow?
| }); | ||
| } | ||
|
|
||
| export function withWranglerOptions<T extends yargs.Argv>(args: T) { |
There was a problem hiding this comment.
Some JSDoc would help for those 3 functions
|
|
||
| async function runCommand(args: Arguments) { | ||
| printHeader(`Cloudflare ${args.command}`); | ||
| y = addBuildCommand(y); |
There was a problem hiding this comment.
maybe this can return y for chaining?
Up to you
Changes
outputarg as it was never used.--envand--configbecome proper first class citizens.Replaces #790
Commands Tested
buildpreviewdeployuploadpopulateCache