cache-location.js

"use strict";

const path = require("path");
const { promises: fs } = require("fs");
const rimraf = require("rimraf");

const { default: stripAnsi } = require("../../../vendors/strip-ansi.js");

const runPrettier = require("../run-prettier.js");

function resolveDir(dir) {
  return path.join(__dirname, "..", dir);
}

function isJson(str) {
  try {
    JSON.parse(str);
    return true;
  } catch {
    return false;
  }
}

describe("--cache-location option", () => {
  const dir = resolveDir("cli/cache-location");
  const defaultCacheFile = path.join(dir, ".prettiercache");
  const newCacheFile = path.join(dir, ".new_prettiercache");
  const newCacheDir = path.join(dir, "cache-dir");

  afterEach(() => {
    rimraf.sync(newCacheFile);
    rimraf.sync(newCacheDir);
  });

  it("doesn't create `.prettiercache` file when `--cache-location` is used.", async () => {
    await runPrettier(dir, [
      "--cache",
      "--cache-location=.new_prettiercache",
      ".",
    ]);
    await expect(fs.stat(defaultCacheFile)).rejects.toHaveProperty(
      "code",
      "ENOENT"
    );
  });

  describe("specify file name", () => {
    it("creates cache file at the specified file", async () => {
      await runPrettier(dir, [
        "--cache",
        "--cache-location=.new_prettiercache",
        ".",
      ]);
      const cacheFileData = await fs.readFile(newCacheFile, "utf8");
      await expect(isJson(cacheFileData)).toBe(true);
    });

    it("skips formatting when cache is available", async () => {
      await runPrettier(dir, [
        "--cache",
        "--cache-location=.new_prettiercache",
        "--write",
        ".",
      ]);
      const { stdout } = await runPrettier(dir, [
        "--cache",
        "--cache-location=.new_prettiercache",
        "--write",
        ".",
      ]);
      expect(stripAnsi(stdout).split("\n").filter(Boolean)).toEqual(
        expect.arrayContaining([
          expect.stringMatching(/^a\.js .+ms \(cached\)$/),
          expect.stringMatching(/^b\.js .+ms \(cached\)$/),
        ])
      );
    });
  });

  describe("specify director name", () => {
    it("creates cache file into the specified directory", async () => {
      await runPrettier(dir, ["--cache", "--cache-location=cache-dir/", "."]);
      const fileNames = await fs.readdir(newCacheDir);
      expect(fileNames.length).toBe(1);
      const cacheFileName = fileNames[0];
      const filePath = path.join(newCacheDir, cacheFileName);
      const cacheFileData = await fs.readFile(filePath, "utf8");
      await expect(isJson(cacheFileData)).toBe(true);
    });

    it("skips formatting when cache is available", async () => {
      await runPrettier(dir, [
        "--cache",
        "--cache-location=cache-dir/",
        "--write",
        ".",
      ]);
      const { stdout } = await runPrettier(dir, [
        "--cache",
        "--cache-location=cache-dir/",
        "--write",
        ".",
      ]);
      expect(stripAnsi(stdout).split("\n").filter(Boolean)).toEqual(
        expect.arrayContaining([
          expect.stringMatching(/^a\.js .+ms \(cached\)$/),
          expect.stringMatching(/^b\.js .+ms \(cached\)$/),
        ])
      );
    });
  });
});