Remove cache entry that not set

prettier · Jun 20, 2022 · d22b1fa · d22b1fa
1 parent 183cc7c
commit d22b1fa
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 0 deletions.
diff --git a/src/cli/format-results-cache.js b/src/cli/format-results-cache.js
@@ -88,6 +88,13 @@ class FormatResultsCache {
     }
   }
 
+  /**
+   * @param {string} filePath
+   */
+  removeFormatResultsCache(filePath) {
+    this.fileEntryCache.removeEntry(filePath);
+  }
+
   reconcile() {
     this.fileEntryCache.reconcile();
   }

diff --git a/src/cli/format.js b/src/cli/format.js
@@ -466,6 +466,8 @@ async function formatFiles(context) {
 
     if (isCacheSet) {
       formatResultsCache?.setFormatResultsCache(filename, options);
+    } else {
+      formatResultsCache?.removeFormatResultsCache(filename);
     }
 
     if (isDifferent) {

diff --git a/tests/integration/__tests__/cache.js b/tests/integration/__tests__/cache.js
@@ -227,6 +227,47 @@ describe("--cache option", () => {
       );
     });
 
+    it("don't set cache that file is already cached and has different.", async () => {
+      const { stdout: firstStdout } = await runPrettier(dir, [
+        "--write",
+        "--cache",
+        "--cache-strategy",
+        "metadata",
+        ".",
+      ]);
+      expect(stripAnsi(firstStdout).split("\n").filter(Boolean)).toEqual(
+        expect.arrayContaining([
+          expect.stringMatching(/^a\.js .+ms$/),
+          expect.stringMatching(/^b\.js .+ms$/),
+        ])
+      );
+
+      // Update `a.js`
+      await fs.writeFile(path.join(dir, "a.js"), "const a = `a`;");
+
+      const { stdout: secondStdout } = await runPrettier(dir, [
+        "--list-different",
+        "--cache",
+        "--cache-strategy",
+        "metadata",
+        ".",
+      ]);
+      expect(stripAnsi(secondStdout).split("\n").filter(Boolean)).toEqual([
+        "a.js",
+      ]);
+
+      const { stdout: thirdStdout } = await runPrettier(dir, [
+        "--list-different",
+        "--cache",
+        "--cache-strategy",
+        "metadata",
+        ".",
+      ]);
+      expect(stripAnsi(thirdStdout).split("\n").filter(Boolean)).toEqual([
+        "a.js",
+      ]);
+    });
+
     it("removes cache file when run Prettier without `--cache` option", async () => {
       await runPrettier(dir, [
         "--cache",
@@ -399,6 +440,47 @@ describe("--cache option", () => {
       );
     });
 
+    it("don't set cache that file is already cached and has different.", async () => {
+      const { stdout: firstStdout } = await runPrettier(dir, [
+        "--write",
+        "--cache",
+        "--cache-strategy",
+        "content",
+        ".",
+      ]);
+      expect(stripAnsi(firstStdout).split("\n").filter(Boolean)).toEqual(
+        expect.arrayContaining([
+          expect.stringMatching(/^a\.js .+ms$/),
+          expect.stringMatching(/^b\.js .+ms$/),
+        ])
+      );
+
+      // Update `a.js`
+      await fs.writeFile(path.join(dir, "a.js"), "const a = `a`;");
+
+      const { stdout: secondStdout } = await runPrettier(dir, [
+        "--list-different",
+        "--cache",
+        "--cache-strategy",
+        "content",
+        ".",
+      ]);
+      expect(stripAnsi(secondStdout).split("\n").filter(Boolean)).toEqual([
+        "a.js",
+      ]);
+
+      const { stdout: thirdStdout } = await runPrettier(dir, [
+        "--list-different",
+        "--cache",
+        "--cache-strategy",
+        "content",
+        ".",
+      ]);
+      expect(stripAnsi(thirdStdout).split("\n").filter(Boolean)).toEqual([
+        "a.js",
+      ]);
+    });
+
     it("removes cache file when run Prettier without `--cache` option", async () => {
       await runPrettier(dir, ["--cache", "--write", "."]);
       await expect(fs.stat(defaultCacheFile)).resolves.not.toThrowError();