test-repo/tests/integration/__tests__/plugin-resolution.js

import runPrettier from "../run-prettier.js";
const EOL = "\n";

describe("automatically loads 'prettier-plugin-*'", () => {
  runPrettier("plugins/automatic", ["file.txt", "--parser=bar"]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads '@prettier/plugin-*'", () => {
  runPrettier("plugins/automatic", ["file.txt", "--parser=foo"]).test({
    stdout: "foo+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads '@<name>/prettier-plugin-*'", () => {
  runPrettier("plugins/automatic", ["file.txt", "--parser=foobar"]).test({
    stdout: "foobar+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads 'prettier-plugin-*' from --plugin-search-dir (same as autoload dir)", () => {
  runPrettier("plugins/automatic", [
    "file.txt",
    "--parser=foo",
    "--plugin-search-dir=.",
  ]).test({
    stdout: "foo+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads '@prettier/plugin-*' from --plugin-search-dir (same as autoload dir)", () => {
  runPrettier("plugins/automatic", [
    "file.txt",
    "--parser=bar",
    "--plugin-search-dir=.",
  ]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads '@<name>/prettier-plugin-*' from --plugin-search-dir (same as autoload dir)", () => {
  runPrettier("plugins/automatic", [
    "file.txt",
    "--parser=foobar",
    "--plugin-search-dir=.",
  ]).test({
    stdout: "foobar+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads 'prettier-plugin-*' from --plugin-search-dir (different to autoload dir)", () => {
  runPrettier("plugins", [
    "automatic/file.txt",
    "--parser=foo",
    "--plugin-search-dir=automatic",
  ]).test({
    stdout: "foo+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("automatically loads '@prettier/plugin-*' from --plugin-search-dir (different to autoload dir)", () => {
  runPrettier("plugins", [
    "automatic/file.txt",
    "--parser=bar",
    "--plugin-search-dir=automatic",
  ]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("does not crash when --plugin-search-dir does not contain node_modules", () => {
  runPrettier(
    "plugins/extensions",
    [
      "file.foo",
      "--end-of-line",
      "lf",
      "--plugin=./plugin.cjs",
      "--plugin-search-dir=.",
    ],
    { ignoreLineEndings: true }
  ).test({
    stdout: "!contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("crashes when one of --plugin-search-dir does not exist", () => {
  runPrettier("plugins/automatic", [
    "file.txt",
    "--parser=foo",
    "--plugin-search-dir=non-existing-dir",
    "--plugin-search-dir=.",
  ]).test({
    stdout: "",
    stderr: "[error] non-existing-dir does not exist or is not a directory\n",
    status: 1,
    write: [],
  });
});

describe("loads --plugin by its relative path", () => {
  runPrettier("plugins", [
    "automatic/file.txt",
    "--parser=bar",
    "--plugin=./automatic/node_modules/prettier-plugin-bar/index.js",
  ]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("loads --plugin by its relative path without leading ./", () => {
  runPrettier("plugins", [
    "automatic/file.txt",
    "--parser=bar",
    "--plugin=automatic/node_modules/prettier-plugin-bar/index.js",
  ]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("loads --plugin by relative path to its directory (assuming index.js)", () => {
  runPrettier("plugins", [
    "automatic/file.txt",
    "--parser=bar",
    "--plugin=./automatic/node_modules/prettier-plugin-bar",
  ]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("loads --plugin by relative path to its directory without leading ./ (assuming index.js)", () => {
  runPrettier("plugins", [
    "automatic/file.txt",
    "--parser=bar",
    "--plugin=automatic/node_modules/prettier-plugin-bar",
  ]).test({
    stdout: "content from `prettier-plugin-bar` package + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("loads --plugin by package name", () => {
  runPrettier("plugins/automatic", [
    "file.txt",
    "--parser=foobar",
    "--plugin=@user/prettier-plugin-foobar",
  ]).test({
    stdout: "foobar+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("loads --plugin by filename without leading ./ and ext, should resolve to file, not package", () => {
  runPrettier("plugins/automatic", [
    "file.txt",
    "--parser=bar",
    "--plugin=prettier-plugin-bar",
  ]).test({
    stdout: "content from `prettier-plugin-bar.js` file + contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

describe("loads --plugin by bespoke plugin name (assuming it is installed in cwd)", () => {
  runPrettier("plugins/bespoke", [
    "../automatic/file.txt",
    "--parser=bespoke",
    "--plugin=@company/prettier-plugin-bespoke",
  ]).test({
    stdout: "bespoke+contents" + EOL,
    stderr: "",
    status: 0,
    write: [],
  });
});

test("--no-plugin-search", async () => {
  async function getParser(args = []) {
    const { stdout } = await runPrettier("plugins/automatic", [
      "--file-info=file.foo",
      ...args,
    ]);
    return JSON.parse(stdout).inferredParser;
  }

  expect(await getParser()).toBe("foo");
  expect(await getParser(["--plugin-search-dir=."])).toBe("foo");
  expect(await getParser(["--no-plugin-search"])).toBeNull();
});

test("--no-plugin-search still allow use --plugin", async () => {
  const args = ["file.txt", "--parser=bar"];
  const { stdout: stdoutWithoutPlugin } = await runPrettier(
    "plugins/automatic",
    args
  );
  const argsWithPlugin = [...args, "--plugin=./prettier-plugin-bar.js"];
  const { stdout: stdoutWithPlugin } = await runPrettier(
    "plugins/automatic",
    argsWithPlugin
  );
  const { stdout: stdoutWithoutPluginAndNoPluginSearch } = await runPrettier(
    "plugins/automatic",
    [...args, "--no-plugin-search"]
  );
  const { stdout: stdoutWithPluginButNoPluginSearch } = await runPrettier(
    "plugins/automatic",
    [...argsWithPlugin, "--no-plugin-search"]
  );

  expect(stdoutWithoutPlugin).not.toBe(stdoutWithPlugin);
  expect(stdoutWithoutPluginAndNoPluginSearch).toBe("");
  expect(stdoutWithPlugin).toBe(stdoutWithPluginButNoPluginSearch);
});

test("--no-plugin-search together with --plugin-search-dir", async () => {
  const result1 = await runPrettier("plugins/automatic", [
    "--no-plugin-search",
    "--plugin-search-dir",
  ]);
  const result2 = await runPrettier("plugins/automatic", [
    "--no-plugin-search",
    "--plugin-search-dir=foo",
  ]);
  const result3 = await runPrettier("plugins/automatic", [
    "--no-plugin-search",
    "--plugin-search-dir=foo",
    "--plugin-search-dir=bar",
  ]);

  expect(result1).toMatchInlineSnapshot(`
    {
      "status": 1,
      "stderr": "[error] Cannot use --no-plugin-search and --plugin-search-dir together.
    ",
      "stdout": "",
      "write": [],
    }
  `);
  expect(result2).toEqual(result1);
  expect(result3).toEqual(result1);
});