Support .lintstagedrc (#13081)

OrRosenblatt · web-flow · commit a00d31e1a4f6 · 2022-07-09T13:30:26.000+09:00
* Test `.lintstagedrc` JSON and YML formatting (TDD)

* Support `.lintstagedrc` formatting

* Update spell checking for `.lintstagedrc`

* Update changelog

* Update changelog
diff --git a/changelog_unreleased/cli/13081.md b/changelog_unreleased/cli/13081.md
@@ -0,0 +1,3 @@
+#### Infer parser for `.lintstagedrc` (#13081 by @OrRosenblatt)
+
+A `.lintstagedrc` file (without extension) is handled using `json` and `yaml` parsers.
diff --git a/cspell.json b/cspell.json
@@ -184,6 +184,8 @@
         "linearize",
         "linebreak",
         "linebreaks",
+        "lintstaged",
+        "lintstagedrc",
         "literalline",
         "loglevel",
         "lowercased",
diff --git a/src/language-yaml/embed.js b/src/language-yaml/embed.js
@@ -3,11 +3,11 @@
 function embed(path, print, textToDoc, options) {
   const node = path.getValue();
 
-  // Try to format `.prettierrc` and `.stylelintrc` as `json` first
+  // Try to format `.prettierrc`, `.stylelintrc`, and `.lintstagedrc` as `json` first
   if (
     node.type === "root" &&
     options.filepath &&
-    /(?:[/\\]|^)\.(?:prettier|stylelint)rc$/.test(options.filepath)
+    /(?:[/\\]|^)\.(?:prettier|stylelint|lintstaged)rc$/.test(options.filepath)
   ) {
     return textToDoc(options.originalText, { ...options, parser: "json" });
   }
diff --git a/src/language-yaml/index.js b/src/language-yaml/index.js
@@ -15,6 +15,7 @@ const languages = [
       ...data.filenames.filter((filename) => filename !== "yarn.lock"),
       ".prettierrc",
       ".stylelintrc",
+      ".lintstagedrc",
     ],
   })),
 ];
diff --git a/tests/integration/__tests__/__snapshots__/support-info.js.snap b/tests/integration/__tests__/__snapshots__/support-info.js.snap
@@ -774,7 +774,8 @@ exports[`CLI --support-info (stdout) 1`] = `
         "CITATION.cff",
         "glide.lock",
         ".prettierrc",
-        ".stylelintrc"
+        ".stylelintrc",
+        ".lintstagedrc"
       ],
       "linguistLanguageId": 407,
       "name": "YAML",
diff --git a/tests/integration/__tests__/with-parser-inference.js b/tests/integration/__tests__/with-parser-inference.js
@@ -70,4 +70,29 @@ describe("infers parser from filename", () => {
       ` + "\n"
     );
   });
+
+  test("json from .lintstagedrc", () => {
+    expect(
+      prettier.format("  {  '*':   'your-cmd'  }  ", {
+        filepath: "/path/to/.lintstagedrc",
+      })
+    ).toBe('{ "*": "your-cmd" }\n');
+  });
+
+  test("yaml from .lintstagedrc", () => {
+    expect(
+      prettier.format(
+        /* indent */ `
+          '*':
+                 - your-cmd
+        `,
+        { filepath: "/path/to/.lintstagedrc" }
+      )
+    ).toBe(
+      outdent`
+        "*":
+          - your-cmd
+      ` + "\n"
+    );
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+#### Infer parser for `.lintstagedrc` (#13081 by @OrRosenblatt)
	`2`	`+`
	`3`	+A `.lintstagedrc` file (without extension) is handled using `json` and `yaml` parsers.