Stop asking for changeset confirmation when it has been provided using an external editor (#562)

Co-authored-by: Mitchell Hamilton <mitchell@hamil.town>

Author: Andarist

.changeset/shaggy-bobcats-roll.md

@@ -0,0 +1,5 @@
+---
+"@changesets/cli": minor
+---
+
+Stop asking for changeset confirmation when it has been provided using an external editor.

packages/cli/src/commands/add/__tests__/add.ts

@@ -95,13 +95,14 @@ describe("Changesets", () => {
  mockUserResponses({ releases: { "pkg-a": "patch" } });
  await addChangeset(cwd, { empty: false }, defaultConfig);
 
- const expectedChangeset = {
- summary: "summary message mock",
- releases: [{ name: "pkg-a", type: "patch" }]
- };
  // @ts-ignore
  const call = writeChangeset.mock.calls[0][0];
- expect(call).toEqual(expectedChangeset);
+ expect(call).toEqual(
+ expect.objectContaining({
+ summary: "summary message mock",
+ releases: [{ name: "pkg-a", type: "patch" }]
+ })
+ );
  });
 
  it.each`
@@ -123,13 +124,14 @@ describe("Changesets", () => {
  });
  await addChangeset(cwd, { empty: false }, defaultConfig);
 
- const expectedChangeset = {
- summary: expectedSummary,
- releases: [{ name: "pkg-a", type: "patch" }]
- };
  // @ts-ignore
  const call = writeChangeset.mock.calls[0][0];
- expect(call).toEqual(expectedChangeset);
+ expect(call).toEqual(
+ expect.objectContaining({
+ summary: expectedSummary,
+ releases: [{ name: "pkg-a", type: "patch" }]
+ })
+ );
  }
  );
 
@@ -161,13 +163,14 @@ describe("Changesets", () => {
 
  await addChangeset(cwd, { empty: false }, defaultConfig);
 
- const expectedChangeset = {
- summary: "summary message mock",
- releases: [{ name: "single-package", type: "minor" }]
- };
  // @ts-ignore
  const call = writeChangeset.mock.calls[0][0];
- expect(call).toEqual(expectedChangeset);
+ expect(call).toEqual(
+ expect.objectContaining({
+ summary: "summary message mock",
+ releases: [{ name: "single-package", type: "minor" }]
+ })
+ );
  });
  it("should commit when the commit flag is passed in", async () => {
  const cwd = await f.copy("simple-project-custom-config");
@@ -185,12 +188,13 @@ describe("Changesets", () => {
 
  await addChangeset(cwd, { empty: true }, defaultConfig);
 
- const expectedChangeset = {
- releases: [],
- summary: ""
- };
  // @ts-ignore
  const call = writeChangeset.mock.calls[0][0];
- expect(call).toEqual(expectedChangeset);
+ expect(call).toEqual(
+ expect.objectContaining({
+ releases: [],
+ summary: ""
+ })
+ );
  });
 });

packages/cli/src/commands/add/createChangeset.ts

@@ -99,7 +99,7 @@ function formatPkgNameAndVersion(pkgName: string, version: string) {
 export default async function createChangeset(
  changedPackages: Array<string>,
  allPackages: Package[]
-): Promise<{ summary: string; releases: Array<Release> }> {
+): Promise<{ confirmed: boolean; summary: string; releases: Array<Release> }> {
  const releases: Array<Release> = [];
 
  if (allPackages.length > 1) {
@@ -239,6 +239,7 @@ export default async function createChangeset(
  );
  if (summary.length > 0) {
  return {
+ confirmed: true,
  summary,
  releases
  };
@@ -258,6 +259,7 @@ export default async function createChangeset(
  }
 
  return {
+ confirmed: false,
  summary,
  releases
  };

packages/cli/src/commands/add/index.ts

@@ -13,6 +13,10 @@ import createChangeset from "./createChangeset";
 import printConfirmationMessage from "./messages";
 import { ExternalEditor } from "external-editor";
 
+type UnwrapPromise<T extends Promise<any>> = T extends Promise<infer R>
+ ? R
+ : never;
+
 export default async function add(
  cwd: string,
  { empty, open }: { empty?: boolean; open?: boolean },
@@ -21,14 +25,13 @@ export default async function add(
  const packages = await getPackages(cwd);
  const changesetBase = path.resolve(cwd, ".changeset");
 
- let newChangeset;
- let changesetConfirmed = false;
+ let newChangeset: UnwrapPromise<ReturnType<typeof createChangeset>>;
  if (empty) {
  newChangeset = {
+ confirmed: true,
  releases: [],
  summary: ``
  };
- changesetConfirmed = true;
  } else {
  const changedPackages = await git.getChangedPackagesSinceRef({
  cwd,
@@ -40,12 +43,15 @@ export default async function add(
  newChangeset = await createChangeset(changePackagesName, packages.packages);
  printConfirmationMessage(newChangeset, packages.packages.length > 1);
 
- changesetConfirmed = await cli.askConfirm(
- "Is this your desired changeset?"
- );
+ if (!newChangeset.confirmed) {
+ newChangeset = {
+ ...newChangeset,
+ confirmed: await cli.askConfirm("Is this your desired changeset?")
+ };
+ }
  }
 
- if (changesetConfirmed) {
+ if (newChangeset.confirmed) {
  const changesetID = await writeChangeset(newChangeset, cwd);
  if (config.commit) {
  await git.add(path.resolve(changesetBase, `${changesetID}.md`), cwd);