test: migrate stdin-filepath tests

43081j · 43081j · commit 585f1be4de38 · 2025-03-04T14:44:17.000+01:00
Copies the stdin-filepath tests from prettier. Notable differences: - Blocked by #21 - Syntax errors output the `stdin-filepath` basename in prettier but not in this CLI (e.g. `[Error] foo.js SyntaxError blah`)
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -65,6 +65,7 @@
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^20.12.7",
     "cross-env": "^7.0.3",
+    "dedent": "^1.5.3",
     "jest": "^29.7.0",
     "jest-snapshot-serializer-ansi": "^2.1.0",
     "jest-snapshot-serializer-raw": "^2.0.0",
diff --git a/src/index.ts b/src/index.ts
@@ -16,7 +16,7 @@ import { fastRelativePath, isNull, isString, isUndefined, negate, pluralize, tri
 import type { FormatOptions, Options, PluginsOptions } from "./types.js";
 
 async function run(options: Options, pluginsDefaultOptions: PluginsOptions, pluginsCustomOptions: PluginsOptions): Promise<void> {
-  if (options.globs.length || !isString(await getStdin())) {
+  if (options.globs.length || (!isString(await getStdin()) && !("stdinFilepath" in options))) {
     return runGlobs(options, pluginsDefaultOptions, pluginsCustomOptions);
   } else {
     return runStdin(options, pluginsDefaultOptions, pluginsCustomOptions);
diff --git a/src/utils.ts b/src/utils.ts
@@ -330,7 +330,9 @@ async function normalizeOptions(options: unknown, targets: unknown[]): Promise<O
 
   const stdin = await getStdin();
 
-  if (!isString(stdin) && !globs.length) exit("Expected at least one target file/dir/glob");
+  if (!isString(stdin) && !globs.length && !("stdinFilepath" in options)) {
+    exit("Expected at least one target file/dir/glob");
+  }
 
   const check = "check" in options && !!options.check;
   const list = "listDifferent" in options && !!options.listDifferent;
diff --git a/test/__fixtures__/editorconfig/.editorconfig b/test/__fixtures__/editorconfig/.editorconfig
@@ -0,0 +1,18 @@
+root = true
+
+[*.js]
+indent_style = tab
+tab_width = 8
+indent_size = 2 # overridden by tab_width since indent_style = tab
+max_line_length = 100
+
+# Indentation override for all JS under lib directory
+[lib/**.js]
+indent_style = space
+indent_size = 2
+
+[lib/indent_size=tab.js]
+indent_size = tab
+
+[tab_width=unset.js]
+tab_width = unset
diff --git a/test/__fixtures__/editorconfig/file.js b/test/__fixtures__/editorconfig/file.js
@@ -0,0 +1,3 @@
+function f() {
+  console.log("should have tab width 8");
+}
diff --git a/test/__fixtures__/editorconfig/lib/file.js b/test/__fixtures__/editorconfig/lib/file.js
@@ -0,0 +1,3 @@
+function f() {
+  console.log("should have space width 2");
+}
diff --git a/test/__fixtures__/editorconfig/lib/indent_size=tab.js b/test/__fixtures__/editorconfig/lib/indent_size=tab.js
@@ -0,0 +1,3 @@
+function f() {
+  console.log("should have space width 8");
+}
diff --git a/test/__fixtures__/editorconfig/repo-root/.hg/.gitkeep b/test/__fixtures__/editorconfig/repo-root/.hg/.gitkeep
@@ -0,0 +1,2 @@
+This isn't really a Mercurial repo, but we want to pretend it is for testing purposes.
+See https://github.com/prettier/prettier/pull/3559#issuecomment-353857109
diff --git a/test/__fixtures__/editorconfig/repo-root/file.js b/test/__fixtures__/editorconfig/repo-root/file.js
@@ -0,0 +1,3 @@
+function f() {
+  console.log("should have space width 2 despite ../.editorconfig specifying 8, because ./.hg is present");
+}
diff --git a/test/__fixtures__/stdin-ignore/.prettierignore b/test/__fixtures__/stdin-ignore/.prettierignore
@@ -0,0 +1 @@
+ignore/
diff --git a/test/__tests__/__snapshots__/stdin-filepath.js.snap b/test/__tests__/__snapshots__/stdin-filepath.js.snap
@@ -0,0 +1,85 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`apply editorconfig for stdin-filepath with a deep path (stderr) 1`] = `""`;
+
+exports[`apply editorconfig for stdin-filepath with a deep path (stderr) 2`] = `""`;
+
+exports[`apply editorconfig for stdin-filepath with a deep path (stdout) 1`] = `
+"function f() {
+	console.log("should be indented with a tab")
+}"
+`;
+
+exports[`apply editorconfig for stdin-filepath with a deep path (stdout) 2`] = `
+"function f() {
+	console.log("should be indented with a tab")
+}"
+`;
+
+exports[`apply editorconfig for stdin-filepath with a deep path (write) 1`] = `[]`;
+
+exports[`apply editorconfig for stdin-filepath with a deep path (write) 2`] = `[]`;
+
+exports[`apply editorconfig for stdin-filepath with nonexistent directory (stderr) 1`] = `""`;
+
+exports[`apply editorconfig for stdin-filepath with nonexistent directory (stdout) 1`] = `
+"function f() {
+	console.log("should be indented with a tab")
+}"
+`;
+
+exports[`apply editorconfig for stdin-filepath with nonexistent directory (write) 1`] = `[]`;
+
+exports[`apply editorconfig for stdin-filepath with nonexistent file (stderr) 1`] = `""`;
+
+exports[`apply editorconfig for stdin-filepath with nonexistent file (stdout) 1`] = `
+"function f() {
+	console.log("should be indented with a tab")
+}"
+`;
+
+exports[`apply editorconfig for stdin-filepath with nonexistent file (write) 1`] = `[]`;
+
+exports[`don’t apply editorconfig outside project for stdin-filepath with nonexistent directory (stderr) 1`] = `""`;
+
+exports[`don’t apply editorconfig outside project for stdin-filepath with nonexistent directory (stdout) 1`] = `
+"function f() {
+  console.log("should be indented with 2 spaces")
+}"
+`;
+
+exports[`don’t apply editorconfig outside project for stdin-filepath with nonexistent directory (write) 1`] = `[]`;
+
+exports[`format correctly if stdin content compatible with stdin-filepath (stderr) 1`] = `""`;
+
+exports[`format correctly if stdin content compatible with stdin-filepath (stdout) 1`] = `
+".name {
+  display: none;
+}"
+`;
+
+exports[`format correctly if stdin content compatible with stdin-filepath (write) 1`] = `[]`;
+
+exports[`gracefully handle stdin-filepath with nonexistent directory (stderr) 1`] = `""`;
+
+exports[`gracefully handle stdin-filepath with nonexistent directory (stdout) 1`] = `
+".name {
+  display: none;
+}"
+`;
+
+exports[`gracefully handle stdin-filepath with nonexistent directory (write) 1`] = `[]`;
+
+exports[`output file as-is if stdin-filepath matched patterns in ignore-path (stderr) 1`] = `""`;
+
+exports[`output file as-is if stdin-filepath matched patterns in ignore-path (write) 1`] = `[]`;
+
+exports[`throw error if stdin content incompatible with stdin-filepath (stderr) 1`] = `
+"[error] SyntaxError: Unexpected token (1:1)
+[error] > 1 | .name { display: none; }
+[error]     | ^"
+`;
+
+exports[`throw error if stdin content incompatible with stdin-filepath (stdout) 1`] = `""`;
+
+exports[`throw error if stdin content incompatible with stdin-filepath (write) 1`] = `[]`;
diff --git a/test/__tests__/stdin-filepath.js b/test/__tests__/stdin-filepath.js
@@ -0,0 +1,147 @@
+import { runCli } from "../utils";
+import dedent from "dedent";
+
+describe("format correctly if stdin content compatible with stdin-filepath", () => {
+  runCli(
+    "",
+    ["--stdin-filepath", "abc.css"],
+    { input: ".name { display: none; }" }, // css
+  ).test({
+    status: 0,
+  });
+});
+
+describe("throw error if stdin content incompatible with stdin-filepath", () => {
+  runCli(
+    "",
+    ["--stdin-filepath", "abc.js"],
+    { input: ".name { display: none; }" }, // css
+  ).test({
+    status: "non-zero",
+  });
+});
+
+describe("gracefully handle stdin-filepath with nonexistent directory", () => {
+  runCli(
+    "",
+    ["--stdin-filepath", "definitely/nonexistent/path.css"],
+    { input: ".name { display: none; }" }, // css
+  ).test({
+    status: 0,
+  });
+});
+
+describe("apply editorconfig for stdin-filepath with nonexistent file", () => {
+  runCli("", ["--stdin-filepath", "editorconfig/nonexistent.js"], {
+    input: dedent`
+      function f() {
+        console.log("should be indented with a tab");
+      }
+    `, // js
+  }).test({
+    status: 0,
+  });
+});
+
+describe("apply editorconfig for stdin-filepath with nonexistent directory", () => {
+  runCli(
+    "",
+    ["--stdin-filepath", "editorconfig/nonexistent/one/two/three.js"],
+    {
+      input: dedent`
+        function f() {
+          console.log("should be indented with a tab");
+        }
+      `, // js
+    },
+  ).test({
+    status: 0,
+  });
+});
+
+describe("apply editorconfig for stdin-filepath with a deep path", () => {
+  runCli(
+    "",
+    ["--stdin-filepath", "editorconfig/" + "a/".repeat(30) + "three.js"],
+    {
+      input: dedent`
+        function f() {
+          console.log("should be indented with a tab");
+        }
+      `, // js
+    },
+  ).test({
+    status: 0,
+  });
+});
+
+describe("apply editorconfig for stdin-filepath in root", () => {
+  const code = dedent`
+    function f() {
+      console.log("should be indented with a tab");
+    }
+  `;
+  runCli("", ["--stdin-filepath", "/foo.js"], {
+    input: code, // js
+  }).test({
+    status: 0,
+    stdout: code,
+    stderr: "",
+    write: [],
+  });
+});
+
+describe("apply editorconfig for stdin-filepath with a deep path", () => {
+  runCli(
+    "",
+    ["--stdin-filepath", "editorconfig/" + "a/".repeat(30) + "three.js"],
+    {
+      input: dedent`
+        function f() {
+          console.log("should be indented with a tab");
+        }
+      `, // js
+    },
+  ).test({
+    status: 0,
+  });
+});
+
+describe("don’t apply editorconfig outside project for stdin-filepath with nonexistent directory", () => {
+  runCli(
+    "",
+    [
+      "--stdin-filepath",
+      "editorconfig/repo-root/nonexistent/one/two/three.js",
+    ],
+    {
+      input: dedent`
+        function f() {
+          console.log("should be indented with 2 spaces");
+        }
+      `, // js
+    },
+  ).test({
+    status: 0,
+  });
+});
+
+describe("output file as-is if stdin-filepath matched patterns in ignore-path", () => {
+  runCli("stdin-ignore", ["--stdin-filepath", "ignore/example.js"], {
+    input: "hello_world( );",
+  }).test({
+    stdout: "hello_world( );",
+    status: 0,
+  });
+});
+
+describe("Should format stdin even if it's empty", () => {
+  runCli("", ["--stdin-filepath", "example.js"], {
+    isTTY: true,
+  }).test({
+    stdout: "",
+    status: 0,
+    stderr: "",
+    write: [],
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+function f() {`
	`2`	`+ console.log("should have tab width 8");`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+function f() {`
	`2`	`+ console.log("should have space width 2");`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+This isn't really a Mercurial repo, but we want to pretend it is for testing purposes.`
	`2`	`+See https://github.com/prettier/prettier/pull/3559#issuecomment-353857109`