Integration test: Rename runPrettier to runCli (#14687)

prettier · Apr 11, 2023 · fb948bb · fb948bb
1 parent 578f093
commit fb948bb
Show file tree

Hide file tree

Showing 54 changed files with 359 additions and 433 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -311,7 +311,7 @@ module.exports = {
       },
       globals: {
         run_spec: "readonly",
-        runPrettier: "readonly",
+        runCli: "readonly",
       },
     },
     {

diff --git a/scripts/tools/eslint-plugin-prettier-internal-rules/await-cli-tests.js b/scripts/tools/eslint-plugin-prettier-internal-rules/await-cli-tests.js
@@ -3,7 +3,7 @@
 const selector = [
   "CallExpression",
   '[callee.type="Identifier"]',
-  '[callee.name="runPrettier"]',
+  '[callee.name="runCli"]',
 ].join("");
 
 const MESSAGE_ID_CALL = "await-cli-tests/call";
@@ -16,9 +16,8 @@ module.exports = {
       url: "https://github.com/prettier/prettier/blob/main/scripts/tools/eslint-plugin-prettier-internal-rules/await-cli-tests.js",
     },
     messages: {
-      [MESSAGE_ID_CALL]:
-        "'runPrettier()' should be awaited or calling `.test()`.",
-      [MESSAGE_ID_GETTER]: "'runPrettier().{{property}}' should be awaited.",
+      [MESSAGE_ID_CALL]: "'runCli()' should be awaited or calling `.test()`.",
+      [MESSAGE_ID_GETTER]: "'runCli().{{property}}' should be awaited.",
     },
   },
   create(context) {

diff --git a/scripts/tools/eslint-plugin-prettier-internal-rules/test.js b/scripts/tools/eslint-plugin-prettier-internal-rules/test.js
@@ -16,26 +16,26 @@ const test = (ruleId, tests) => {
 
 test("await-cli-tests", {
   valid: [
-    "async () => await runPrettier()",
-    "runPrettier().test()",
-    "notRunPrettier()",
-    "async () => await runPrettier().stderr",
+    "async () => await runCli()",
+    "runCli().test()",
+    "notRunCli()",
+    "async () => await runCli().stderr",
     outdent`
       async () => {
-        const originalStdout = await runPrettier("plugins/options", ["--help"]).stdout;
+        const originalStdout = await runCli("plugins/options", ["--help"]).stdout;
       }
     `,
   ],
   invalid: [
     {
-      code: "runPrettier()",
+      code: "runCli()",
       errors: [
-        { message: "'runPrettier()' should be awaited or calling `.test()`." },
+        { message: "'runCli()' should be awaited or calling `.test()`." },
       ],
     },
     {
-      code: "runPrettier().stderr",
-      errors: [{ message: "'runPrettier().stderr' should be awaited." }],
+      code: "runCli().stderr",
+      errors: [{ message: "'runCli().stderr' should be awaited." }],
     },
   ],
 });

diff --git a/tests/integration/__tests__/arg-parsing.js b/tests/integration/__tests__/arg-parsing.js
@@ -1,5 +1,5 @@
 describe("boolean flags do not swallow the next argument", () => {
-  runPrettier("cli/arg-parsing", [
+  runCli("cli/arg-parsing", [
     "--end-of-line",
     "lf",
     "--single-quote",
@@ -10,7 +10,7 @@ describe("boolean flags do not swallow the next argument", () => {
 });
 
 describe("negated options work", () => {
-  runPrettier("cli/arg-parsing", [
+  runCli("cli/arg-parsing", [
     "--end-of-line",
     "lf",
     "--no-semi",
@@ -21,7 +21,7 @@ describe("negated options work", () => {
 });
 
 describe("unknown options are warned", () => {
-  runPrettier("cli/arg-parsing", [
+  runCli("cli/arg-parsing", [
     "--end-of-line",
     "lf",
     "file.js",
@@ -32,7 +32,7 @@ describe("unknown options are warned", () => {
 });
 
 describe("unknown negated options are warned", () => {
-  runPrettier("cli/arg-parsing", [
+  runCli("cli/arg-parsing", [
     "--end-of-line",
     "lf",
     "file.js",
@@ -43,14 +43,14 @@ describe("unknown negated options are warned", () => {
 });
 
 describe("unknown options not suggestion `_`", () => {
-  runPrettier("cli/arg-parsing", ["file.js", "-a"]).test({
+  runCli("cli/arg-parsing", ["file.js", "-a"]).test({
     status: 0,
     write: [],
   });
 });
 
 describe("allow overriding flags", () => {
-  runPrettier(
+  runCli(
     "cli/arg-parsing",
     ["--tab-width=1", "--tab-width=3", "--parser=babel"],
     { input: "function a() { b }" }
@@ -63,7 +63,7 @@ describe("allow overriding flags", () => {
 describe("number file/dir", () => {
   const patterns = ["1", "2.2", "3", "4.44"];
   for (const pattern of patterns) {
-    runPrettier("cli/arg-parsing/number", [
+    runCli("cli/arg-parsing/number", [
       "--parser=babel",
       "--list-different",
       pattern,
@@ -73,7 +73,7 @@ describe("number file/dir", () => {
       write: [],
     });
   }
-  runPrettier("cli/arg-parsing/number", [
+  runCli("cli/arg-parsing/number", [
     "--parser=babel",
     "--list-different",
     ...patterns,
@@ -85,19 +85,19 @@ describe("number file/dir", () => {
 });
 
 describe("deprecated option values are warned", () => {
-  runPrettier("cli/arg-parsing", ["file.js", "--jsx-bracket-same-line"]).test({
+  runCli("cli/arg-parsing", ["file.js", "--jsx-bracket-same-line"]).test({
     status: 0,
   });
 });
 
 describe("options with `cliName` should not allow to pass directly", () => {
   // `filepath` can only pass through `--stdin-filepath`
   // `plugins` and `pluginSearchDirs` works the same
-  runPrettier("cli/arg-parsing", ["--stdin-filepath", "file.js"], {
+  runCli("cli/arg-parsing", ["--stdin-filepath", "file.js"], {
     isTTY: false,
     input: "prettier()",
   }).test({ status: 0, stderr: "", write: [] });
-  runPrettier("cli/arg-parsing", ["--filepath", "file.js"], {
+  runCli("cli/arg-parsing", ["--filepath", "file.js"], {
     isTTY: false,
     input: "prettier()",
   }).test({ status: 2, write: [] });