Prevent fatal errors when using the newly-introduced prettier option (#1590)

bennypowers · Andarist · web-flow · commit b9df59627623 · 2025-02-20T12:52:35.000+01:00
* fix(config): validate prettier option

* style: format

* test(cli): prettier config

* test(cli): prettier config

* fix tests

* Update .changeset/curly-cameras-serve.md

---------

Co-authored-by: Mateusz Burzyński &lt;mateuszburzynski@gmail.com&gt;
diff --git a/.changeset/curly-cameras-serve.md b/.changeset/curly-cameras-serve.md
@@ -0,0 +1,5 @@
+---
+"@changesets/config": patch
+---
+
+Prevent fatal error when using the newly-introduced `prettier` option
diff --git a/packages/cli/src/run.test.ts b/packages/cli/src/run.test.ts
@@ -2,6 +2,7 @@ import { error } from "@changesets/logger";
 import { testdir } from "@changesets/test-utils";
 
 import { run } from "./run";
+import writeChangeset from "@changesets/write";
 
 jest.mock("@changesets/logger");
 jest.mock("./commands/version");
@@ -168,5 +169,59 @@ describe("cli", () => {
         `It looks like you are trying to use the \`--ignore\` option while ignore is defined in the config file. This is currently not allowed, you can only use one of them at a time.`
       );
     });
+
+    it("should not throw if `prettier: false` is configured", async () => {
+      const cwd = await testdir({
+        "package.json": JSON.stringify({
+          private: true,
+          workspaces: ["packages/*"],
+        }),
+        "packages/pkg-a/package.json": JSON.stringify({
+          name: "pkg-a",
+          version: "1.0.0",
+        }),
+        ".changeset/config.json": JSON.stringify({
+          prettier: false,
+        }),
+      });
+      await writeChangeset(
+        {
+          summary: "This is a summary",
+          releases: [{ name: "pkg-a", type: "minor" }],
+        },
+        cwd
+      );
+
+      await expect(run(["version"], {}, cwd)).resolves.not.toThrow();
+    });
+
+    it('should throw if `prettier: "string"` is configured', async () => {
+      const cwd = await testdir({
+        "package.json": JSON.stringify({
+          private: true,
+          workspaces: ["packages/*"],
+        }),
+        "packages/pkg-a/package.json": JSON.stringify({
+          name: "pkg-a",
+          version: "1.0.0",
+        }),
+        ".changeset/config.json": JSON.stringify({
+          prettier: "no thanks",
+        }),
+      });
+      await writeChangeset(
+        {
+          summary: "This is a summary",
+          releases: [{ name: "pkg-a", type: "minor" }],
+        },
+        cwd
+      );
+
+      await expect(run(["version"], {}, cwd)).rejects
+        .toThrowErrorMatchingInlineSnapshot(`
+        "Some errors occurred when validating the changesets config:
+        The \`prettier\` option is set as "no thanks" when the only valid values are undefined or a boolean"
+      `);
+    });
   });
 });
diff --git a/packages/config/src/index.ts b/packages/config/src/index.ts
@@ -331,7 +331,7 @@ export let parse = (json: WrittenConfig, packages: Packages): Config => {
     }
   }
 
-  if (json.prettier !== undefined) {
+  if (json.prettier !== undefined && typeof json.prettier !== "boolean") {
     messages.push(
       `The \`prettier\` option is set as ${JSON.stringify(
         json.prettier,

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@changesets/config": patch
 +---
++
 +Prevent fatal error when using the newly-introduced `prettier` option
Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@ export let parse = (json: WrittenConfig, packages: Packages): Config => {`
`331`	`331`	`}`
`332`	`332`	`}`
`333`	`333`
`334`		`- if (json.prettier !== undefined) {`
	`334`	`+ if (json.prettier !== undefined && typeof json.prettier !== "boolean") {`
`335`	`335`	`messages.push(`
`336`	`336`	`The \`prettier\` option is set as ${JSON.stringify(
`337`	`337`	`json.prettier,`