Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use Node's built-in `parseArgs` utility for CLI argument parsing and remove the `arg` dependency.
31 changes: 31 additions & 0 deletions packages/create-react-router/__tests__/create-react-router-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,18 @@ describe("create-react-router CLI", () => {
expect(!!semver.valid(stdout.trim())).toBe(true);
});

it("supports short aliases", async () => {
let [{ stdout: helpOutput }, { stdout: versionOutput }] = await Promise.all(
[
execCreateReactRouter({ args: ["-h"] }),
execCreateReactRouter({ args: ["-V"] }),
],
);

expect(helpOutput).toContain("Usage:");
expect(!!semver.valid(versionOutput.trim())).toBe(true);
});

it("allows you to go through the prompts", async () => {
let projectDir = getProjectDir("prompts");

Expand Down Expand Up @@ -195,6 +207,25 @@ describe("create-react-router CLI", () => {
).toBeTruthy();
});

it("ignores unknown flags", async () => {
let projectDir = getProjectDir("unknown-flags");

let { status, stderr } = await execCreateReactRouter({
args: [
projectDir,
"--future-flag",
"--yes",
"--no-git-init",
"--no-install",
],
});

expect(stderr.trim()).toBeFalsy();
expect(status).toBe(0);
expect(existsSync(path.join(projectDir, "package.json"))).toBeTruthy();
expect(existsSync(path.join(projectDir, "app/root.tsx"))).toBeTruthy();
});

it("supports the --no-agent-skills flag", async () => {
let projectDir = getProjectDir("no-agent-skills");

Expand Down
114 changes: 54 additions & 60 deletions packages/create-react-router/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import { cp, readFile, realpath, writeFile } from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { parseArgs } from "node:util";
import stripAnsi from "strip-ansi";
import { execa } from "execa";
import arg from "arg";
import * as semver from "semver";
import sortPackageJSON from "sort-package-json";

Expand Down Expand Up @@ -76,55 +76,43 @@ async function createReactRouter(argv: string[]) {
}

async function getContext(argv: string[]): Promise<Context> {
let flags = arg(
{
"--debug": Boolean,
"--react-router-version": String,
"-v": "--react-router-version",
"--template": String,
"--token": String,
"--yes": Boolean,
"-y": "--yes",
"--install": Boolean,
"--no-install": Boolean,
"--package-manager": String,
"--show-install-output": Boolean,
"--agent-skills": Boolean,
"--no-agent-skills": Boolean,
"--git-init": Boolean,
"--no-git-init": Boolean,
"--help": Boolean,
"-h": "--help",
"--version": Boolean,
"--V": "--version",
"--no-color": Boolean,
"--no-motion": Boolean,
"--overwrite": Boolean,
let { values, positionals } = parseArgs({
args: argv,
allowPositionals: true,
// Preserve arg's permissive mode so unknown flags don't fail existing usage.
strict: false,
options: {
"agent-skills": { type: "boolean" },
debug: { type: "boolean" },
"git-init": { type: "boolean" },
help: { type: "boolean", short: "h" },
install: { type: "boolean" },
"no-agent-skills": { type: "boolean" },
"no-color": { type: "boolean" },
"no-git-init": { type: "boolean" },
"no-install": { type: "boolean" },
"no-motion": { type: "boolean" },
overwrite: { type: "boolean" },
"package-manager": { type: "string" },
"react-router-version": { type: "string", short: "v" },
"show-install-output": { type: "boolean" },
template: { type: "string" },
token: { type: "string" },
version: { type: "boolean", short: "V" },
yes: { type: "boolean", short: "y" },
},
{ argv, permissive: true },
);
});

let getBooleanArg = (
value: string | boolean | Array<string | boolean> | undefined,
) => (typeof value === "boolean" ? value : undefined);
let getStringArg = (
value: string | boolean | Array<string | boolean> | undefined,
) => (typeof value === "string" ? value : undefined);

let {
"--debug": debug = false,
"--help": help = false,
"--react-router-version": selectedReactRouterVersion,
"--template": template,
"--token": token,
"--install": install,
"--no-install": noInstall,
"--package-manager": pkgManager,
"--show-install-output": showInstallOutput = false,
"--agent-skills": agentSkills,
"--no-agent-skills": noAgentSkills,
"--git-init": git,
"--no-git-init": noGit,
"--no-motion": noMotion,
"--yes": yes,
"--version": versionRequested,
"--overwrite": overwrite,
} = flags;

let cwd = flags["_"][0] as string;
let selectedReactRouterVersion = getStringArg(values["react-router-version"]);
let yes = getBooleanArg(values.yes);
let cwd = positionals[0] as string;
let interactive = isInteractive();
let projectName = cwd;

Expand Down Expand Up @@ -155,27 +143,33 @@ async function getContext(argv: string[]): Promise<Context> {
`create-react-router--${Math.random().toString(36).substr(2, 8)}`,
),
cwd,
overwrite,
overwrite: getBooleanArg(values.overwrite),
interactive,
debug,
agentSkills: agentSkills ?? (noAgentSkills ? false : yes),
git: git ?? (noGit ? false : yes),
help,
install: install ?? (noInstall ? false : yes),
showInstallOutput,
noMotion,
debug: getBooleanArg(values.debug) ?? false,
agentSkills:
getBooleanArg(values["agent-skills"]) ??
(getBooleanArg(values["no-agent-skills"]) ? false : yes),
git:
getBooleanArg(values["git-init"]) ??
(getBooleanArg(values["no-git-init"]) ? false : yes),
help: getBooleanArg(values.help) ?? false,
install:
getBooleanArg(values.install) ??
(getBooleanArg(values["no-install"]) ? false : yes),
showInstallOutput: getBooleanArg(values["show-install-output"]) ?? false,
noMotion: getBooleanArg(values["no-motion"]),
pkgManager: validatePackageManager(
pkgManager ??
getStringArg(values["package-manager"]) ??
// npm, pnpm, Yarn, Bun and Deno (v2.0.5+) set the user agent environment variable that can be used
// to determine which package manager ran the command.
(process.env.npm_config_user_agent ?? "npm").split("/")[0],
),
projectName,
prompt,
reactRouterVersion: selectedReactRouterVersion || pkgJson.version,
template,
token,
versionRequested,
template: getStringArg(values.template),
token: getStringArg(values.token),
versionRequested: getBooleanArg(values.version),
};

return context;
Expand Down
1 change: 0 additions & 1 deletion packages/create-react-router/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
}
},
"dependencies": {
"arg": "^5.0.1",
"execa": "9.6.1",
"gunzip-maybe": "^1.4.2",
"log-update": "^8.0.0",
Expand Down
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.