prettier/tests_integration/__tests__/file-info.js

"use strict";

const path = require("path");
const tempy = require("tempy");
const fs = require("fs");

const runPrettier = require("../runPrettier");
const prettier = require("prettier/local");

expect.addSnapshotSerializer(require("../path-serializer"));

describe("extracts file-info for a js file", () => {
  runPrettier("cli/", ["--file-info", "something.js"]).test({
    status: 0
  });
});

describe("extracts file-info for a markdown file", () => {
  runPrettier("cli/", ["--file-info", "README.md"]).test({
    status: 0
  });
});

describe("extracts file-info for a known markdown file with no extension", () => {
  runPrettier("cli/", ["--file-info", "README"]).test({
    status: 0
  });
});

describe("extracts file-info with ignored=true for a file in .prettierignore", () => {
  runPrettier("cli/ignore-path/", ["--file-info", "regular-module.js"]).test({
    status: 0
  });
});

describe("extracts file-info with ignored=true for a file in a hand-picked .prettierignore", () => {
  runPrettier("cli/", [
    "--file-info",
    "regular-module.js",
    "--ignore-path=ignore-path/.prettierignore"
  ]).test({
    status: 0
  });
});

describe("extracts file-info for a file in not_node_modules", () => {
  runPrettier("cli/with-node-modules/", [
    "--file-info",
    "not_node_modules/file.js"
  ]).test({
    status: 0
  });
});

describe("extracts file-info with with ignored=true for a file in node_modules", () => {
  runPrettier("cli/with-node-modules/", [
    "--file-info",
    "node_modules/file.js"
  ]).test({
    status: 0
  });
});

describe("extracts file-info with ignored=false for a file in node_modules when --with-node-modules provided", () => {
  runPrettier("cli/with-node-modules/", [
    "--file-info",
    "node_modules/file.js",
    "--with-node-modules"
  ]).test({
    status: 0
  });
});

describe("extracts file-info with inferredParser=null for file.foo", () => {
  runPrettier("cli/", ["--file-info", "file.foo"]).test({
    status: 0
  });
});

describe("extracts file-info with inferredParser=foo when plugins are autoloaded", () => {
  runPrettier("plugins/automatic/", ["--file-info", "file.foo"]).test({
    status: 0
  });
});

describe("extracts file-info with inferredParser=foo when plugins are loaded with --plugin-search-dir", () => {
  runPrettier("cli/", [
    "--file-info",
    "file.foo",
    "--plugin-search-dir",
    "../plugins/automatic"
  ]).test({
    status: 0
  });
});

describe("extracts file-info with inferredParser=foo when a plugin is hand-picked", () => {
  runPrettier("cli/", [
    "--file-info",
    "file.foo",
    "--plugin",
    "../plugins/automatic/node_modules/@prettier/plugin-foo"
  ]).test({
    status: 0
  });
});

test("API getFileInfo with no args", () => {
  return expect(prettier.getFileInfo()).rejects.toThrow(
    new TypeError("expect `filePath` to be a string, got `undefined`")
  );
});

test("API getFileInfo.sync with no args", () => {
  expect(() => prettier.getFileInfo.sync()).toThrow(
    new TypeError("expect `filePath` to be a string, got `undefined`")
  );
});

test("API getFileInfo with filepath only", () => {
  expect(prettier.getFileInfo("README")).resolves.toMatchObject({
    ignored: false,
    inferredParser: "markdown"
  });
});

test("API getFileInfo.sync with filepath only", () => {
  expect(prettier.getFileInfo.sync("README")).toMatchObject({
    ignored: false,
    inferredParser: "markdown"
  });
});

test("API getFileInfo with resolveConfig", () => {
  const file1 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config/file.foo")
  );
  const file2 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config/file.bar")
  );

  expect(prettier.getFileInfo(file1)).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(prettier.getFileInfo(file2)).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo(file1, {
      resolveConfig: true
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: "json"
  });
  expect(
    prettier.getFileInfo(file2, {
      resolveConfig: true
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });
});

test("API getFileInfo with resolveConfig when no config is present", () => {
  const file1 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config-no-config/file.foo")
  );
  const file2 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config-no-config/file.bar")
  );

  expect(prettier.getFileInfo(file1)).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(prettier.getFileInfo(file2)).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo(file1, {
      resolveConfig: true
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo(file2, {
      resolveConfig: true
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
});

test("API getFileInfo.sync with resolveConfig", () => {
  const file1 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config/file.foo")
  );
  const file2 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config/file.bar")
  );

  expect(prettier.getFileInfo.sync(file1)).toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(prettier.getFileInfo.sync(file2)).toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo.sync(file1, {
      resolveConfig: true
    })
  ).toMatchObject({
    ignored: false,
    inferredParser: "json"
  });
  expect(
    prettier.getFileInfo.sync(file2, {
      resolveConfig: true
    })
  ).toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });
});

test("API getFileInfo.sync with resolveConfig when no config is present", () => {
  const file1 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config-no-config/file.foo")
  );
  const file2 = path.resolve(
    path.join(__dirname, "../cli/with-resolve-config-no-config/file.bar")
  );

  expect(prettier.getFileInfo.sync(file1)).toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(prettier.getFileInfo.sync(file2)).toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo.sync(file1, {
      resolveConfig: true
    })
  ).toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo.sync(file2, {
      resolveConfig: true
    })
  ).toMatchObject({
    ignored: false,
    inferredParser: null
  });
});

test("API getFileInfo with ignorePath", () => {
  const file = path.resolve(
    path.join(__dirname, "../cli/ignore-path/regular-module.js")
  );
  const ignorePath = path.resolve(
    path.join(__dirname, "../cli/ignore-path/.prettierignore")
  );

  expect(prettier.getFileInfo(file)).resolves.toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });

  expect(
    prettier.getFileInfo(file, {
      ignorePath
    })
  ).resolves.toMatchObject({
    ignored: true,
    inferredParser: "babel"
  });
});

test("API getFileInfo.sync with ignorePath", () => {
  const file = path.resolve(
    path.join(__dirname, "../cli/ignore-path/regular-module.js")
  );
  const ignorePath = path.resolve(
    path.join(__dirname, "../cli/ignore-path/.prettierignore")
  );

  expect(prettier.getFileInfo.sync(file)).toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });

  expect(
    prettier.getFileInfo.sync(file, {
      ignorePath
    })
  ).toMatchObject({
    ignored: true,
    inferredParser: "babel"
  });
});

describe("API getFileInfo.sync with ignorePath", () => {
  let cwd;
  let filePath;
  let options;
  beforeAll(() => {
    cwd = process.cwd();
    const tempDir = tempy.directory();
    process.chdir(tempDir);
    const fileDir = "src";
    filePath = `${fileDir}/should-be-ignored.js`;
    const ignorePath = path.join(tempDir, ".prettierignore");
    fs.writeFileSync(ignorePath, filePath, "utf8");
    options = { ignorePath };
  });
  afterAll(() => {
    process.chdir(cwd);
  });
  test("with relative filePath", () => {
    expect(
      prettier.getFileInfo.sync(filePath, options).ignored
    ).toMatchInlineSnapshot(`true`);
  });
  test("with relative filePath starts with dot", () => {
    expect(
      prettier.getFileInfo.sync(`./${filePath}`, options).ignored
    ).toMatchInlineSnapshot(`true`);
  });
  test("with absolute filePath", () => {
    expect(
      prettier.getFileInfo.sync(path.resolve(filePath), options).ignored
    ).toMatchInlineSnapshot(`true`);
  });
});

test("API getFileInfo with withNodeModules", () => {
  const file = path.resolve(
    path.join(__dirname, "../cli/with-node-modules/node_modules/file.js")
  );
  expect(prettier.getFileInfo(file)).resolves.toMatchObject({
    ignored: true,
    inferredParser: "babel"
  });
  expect(
    prettier.getFileInfo(file, {
      withNodeModules: true
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });
});

describe("extracts file-info for a JS file with no extension but a standard shebang", () => {
  expect(
    prettier.getFileInfo.sync("tests_integration/cli/shebang/node-shebang")
  ).toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });
});

describe("extracts file-info for a JS file with no extension but an env-based shebang", () => {
  expect(
    prettier.getFileInfo.sync("tests_integration/cli/shebang/env-node-shebang")
  ).toMatchObject({
    ignored: false,
    inferredParser: "babel"
  });
});

describe("returns null parser for unknown shebang", () => {
  expect(
    prettier.getFileInfo.sync("tests_integration/cli/shebang/nonsense-shebang")
  ).toMatchObject({
    ignored: false,
    inferredParser: null
  });
});

test("API getFileInfo with plugins loaded using pluginSearchDir", () => {
  const file = "file.foo";
  const pluginsPath = path.resolve(
    path.join(__dirname, "../plugins/automatic")
  );
  expect(prettier.getFileInfo(file)).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo(file, {
      pluginSearchDirs: [pluginsPath]
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: "foo"
  });
});

test("API getFileInfo with hand-picked plugins", () => {
  const file = "file.foo";
  const pluginPath = path.resolve(
    path.join(
      __dirname,
      "../plugins/automatic/node_modules/@prettier/plugin-foo"
    )
  );
  expect(prettier.getFileInfo(file)).resolves.toMatchObject({
    ignored: false,
    inferredParser: null
  });
  expect(
    prettier.getFileInfo(file, {
      plugins: [pluginPath]
    })
  ).resolves.toMatchObject({
    ignored: false,
    inferredParser: "foo"
  });
});