Skip to content

Refactor CLI to cac #2009

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

Merged
bluwy merged 7 commits into from
May 17, 2026
Merged

Refactor CLI to cac #2009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3291ddc
Initial refactor
bluwy May 14, 2026
4f78af1
update
bluwy May 14, 2026
a625951
Fix test
bluwy May 14, 2026
acd01cc
Add changeset
bluwy May 14, 2026
fca0d4c
add some examples
beeequeue May 16, 2026
9515636
Fix ignore parsing
bluwy May 16, 2026
26135a6
Update
bluwy May 17, 2026
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
5 changes: 5 additions & 0 deletions .changeset/loose-towns-care.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@changesets/cli": patch
---

Use `cac` for CLI arg parsing and handling
2 changes: 1 addition & 1 deletion packages/cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@
"@changesets/write": "workspace:^",
"@clack/prompts": "^1.4.0",
"@manypkg/get-packages": "^3.0.0",
"cac": "^7.0.0",
"import-meta-resolve": "^4.2.0",
"launch-editor": "^2.13.2",
"mri": "^1.2.0",
"package-manager-detector": "^1.1.0",
"semver": "^7.5.3",
"tinyexec": "^1.0.2"
Expand Down
173 changes: 112 additions & 61 deletions packages/cli/src/commands/add/__tests__/add.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,11 @@ describe("Add command", () => {
name: "pkg-b",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset(cwd, { empty: false }, defaultConfig);
await addChangeset({ cwd });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand Down Expand Up @@ -148,14 +149,15 @@ describe("Add command", () => {
name: "pkg-b",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

mockUserResponses({
releases: { "pkg-a": "patch" },
consoleSummaries,
editorSummaries,
});
await addChangeset(cwd, { empty: false }, defaultConfig);
await addChangeset({ cwd });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand All @@ -175,6 +177,7 @@ describe("Add command", () => {
name: "single-package",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

const summary = "summary message mock";
Expand All @@ -193,7 +196,7 @@ describe("Add command", () => {
throw new Error(`An answer could not be found for ${question}`);
});

await addChangeset(cwd, { empty: false }, defaultConfig);
await addChangeset({ cwd });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand Down Expand Up @@ -224,13 +227,7 @@ describe("Add command", () => {
name: "pkg-b",
version: "1.0.0",
}),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset(
cwd,
{ empty: false },
{
".changeset/config.json": JSON.stringify({
...defaultConfig,
commit: [
path.resolve(
Expand All @@ -243,8 +240,11 @@ describe("Add command", () => {
),
null,
],
},
);
}),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset({ cwd });

const result = await exec("git", ["log", "--oneline", "-1"], {
nodeOptions: { cwd },
Expand All @@ -266,9 +266,10 @@ describe("Add command", () => {
name: "pkg-a",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

await addChangeset(cwd, { empty: true }, defaultConfig);
await addChangeset({ cwd, empty: true });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand All @@ -287,16 +288,13 @@ describe("Add command", () => {
name: "single-package",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

mockedUtils.askList.mockReturnValueOnce(Promise.resolve("minor"));
mockedUtils.askConfirm.mockReturnValueOnce(Promise.resolve(true));

await addChangeset(
cwd,
{ empty: false, message: "summary from message" },
defaultConfig,
);
await addChangeset({ cwd, message: "summary from message" });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand All @@ -320,12 +318,13 @@ describe("Add command", () => {
name: "single-package",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

mockedUtils.askList.mockReturnValueOnce(Promise.resolve("patch"));
mockedUtils.askConfirm.mockReturnValueOnce(Promise.resolve(true));

await addChangeset(cwd, { empty: false, message: "" }, defaultConfig);
await addChangeset({ cwd, message: "" });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand Down Expand Up @@ -355,14 +354,11 @@ describe("Add command", () => {
name: "pkg-b",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset(
cwd,
{ empty: false, message: "monorepo summary from message" },
defaultConfig,
);
await addChangeset({ cwd, message: "monorepo summary from message" });

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand Down Expand Up @@ -391,13 +387,14 @@ describe("Add command", () => {
name: "pkg-a",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

await addChangeset(
await addChangeset({
cwd,
{ empty: true, message: "empty changeset summary" },
defaultConfig,
);
empty: true,
message: "empty changeset summary",
});

const changesets = await getChangesets(cwd);
expect(changesets.length).toBe(1);
Expand Down Expand Up @@ -425,7 +422,7 @@ describe("Add command", () => {
name: "pkg-b",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify({}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

await exec("git", ["checkout", "-b", "foo"], { nodeOptions: { cwd } });
Expand All @@ -445,7 +442,7 @@ describe("Add command", () => {
await git.commit("update pkg-b", cwd);

mockUserResponses({ releases: { "pkg-b": "patch" } });
await addChangeset(cwd, { empty: false, since: "foo" }, defaultConfig);
await addChangeset({ cwd, empty: false, since: "foo" });

expect(mockedUtils.askMultiselect).toHaveBeenCalledWith(
expect.stringContaining("Which packages"),
Expand Down Expand Up @@ -477,33 +474,23 @@ describe("Add command", () => {
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.3",
dependencies: {
"pkg-b": "~1.2.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "pkg-b",
version: "1.2.0",
dependencies: {
"pkg-c": "2.0.0",
"pkg-a": "^1.0.3",
},
}),
"packages/pkg-c/package.json": JSON.stringify({
name: "pkg-c",
version: "2.0.0",
dependencies: {
"pkg-a": "^1.0.3",
},
}),
".changeset/config.json": JSON.stringify({
...defaultConfig,
ignore: ["pkg-b"],
}),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset(
cwd,
{ empty: false },
{ ...defaultConfig, ignore: ["pkg-b"] },
);
await addChangeset({ cwd });
const choices =
mockedUtils.askMultiselect.mock.calls[0][1]["unchanged packages"];
expect(choices).toMatchObject([{ value: "pkg-a" }, { value: "pkg-c" }]);
Expand All @@ -529,10 +516,11 @@ describe("Add command", () => {
name: "pkg-c",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset(cwd, { empty: false }, defaultConfig);
await addChangeset({ cwd });
const choices =
mockedUtils.askMultiselect.mock.calls[0][1]["unchanged packages"];
expect(choices).toStrictEqual([{ value: "pkg-a" }, { value: "pkg-c" }]);
Expand All @@ -559,20 +547,17 @@ describe("Add command", () => {
name: "pkg-c",
version: "1.0.0",
}),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset(
cwd,
{ empty: false },
{
".changeset/config.json": JSON.stringify({
...defaultConfig,
privatePackages: {
version: false,
tag: false,
},
},
);
}),
});

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset({ cwd });
const choices =
mockedUtils.askMultiselect.mock.calls[0][1]["unchanged packages"];
expect(choices).toStrictEqual([{ value: "pkg-a" }, { value: "pkg-c" }]);
Expand All @@ -585,11 +570,12 @@ describe("Add command", () => {
"package.json": JSON.stringify({
name: "test-missing-version",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

await expect(() =>
addChangeset(cwd, { empty: false }, defaultConfig),
).rejects.toThrow("The process exited with code: 1");
await expect(() => addChangeset({ cwd })).rejects.toThrow(
"The process exited with code: 1",
);

expect(loggerErrorSpy).toHaveBeenCalledOnce();
const output = stripVTControlCharacters(loggerErrorSpy.mock.calls[0][0]);
Expand All @@ -614,11 +600,12 @@ describe("Add command", () => {
"packages/pkg-b/package.json": JSON.stringify({
name: "pkg-b",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

await expect(() =>
addChangeset(cwd, { empty: false }, defaultConfig),
).rejects.toThrow("The process exited with code: 1");
await expect(() => addChangeset({ cwd })).rejects.toThrow(
"The process exited with code: 1",
);

expect(loggerErrorSpy).toHaveBeenCalledOnce();
const output = stripVTControlCharacters(loggerErrorSpy.mock.calls[0][0]);
Expand All @@ -628,4 +615,68 @@ describe("Add command", () => {
Ensure that relevant package.json files have a \`version\` field"
`);
});

it("should be able to add a changeset when called from subdirectory", async () => {
const rootDir = await testdir({
"package.json": JSON.stringify({
private: true,
name: "root-pkg",
workspaces: ["packages/*"],
}),
"package-lock.json": "",
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "pkg-b",
version: "1.0.0",
}),
".changeset/config.json": JSON.stringify(defaultConfig),
});

const cwd = path.resolve(rootDir, "packages", "pkg-a");

mockUserResponses({ releases: { "pkg-a": "patch" } });
await addChangeset({ cwd });

const changesets = await getChangesets(rootDir);
expect(changesets.length).toBe(1);
expect(changesets[0]).toEqual(
expect.objectContaining({
summary: "summary message mock",
releases: [{ name: "pkg-a", type: "patch" }],
}),
);
});

it("should throw when .changeset folder is missing when called from subdirectory", async () => {
const loggerErrorSpy = vi.spyOn(clack.log, "error");

const rootDir = await testdir({
"package.json": JSON.stringify({
private: true,
name: "root-pkg",
workspaces: ["packages/*"],
}),
"package-lock.json": "",
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
});

const cwd = path.resolve(rootDir, "packages", "pkg-a");

try {
await addChangeset({ cwd, message: "test" });
} catch {
// ignore the error. We just want to validate the error message
}

const arg = loggerErrorSpy.mock.calls[0][0];
expect(stripVTControlCharacters(arg)).toEqual(
expect.stringContaining("There is no .changeset folder."),
);
});
});
Loading