fix: don't ignore file extensions defined in .prettierrc overrides (#111)

Adds a new setting `--no-resolve-config` to opt out.

Author: bob-laz

README.md

@@ -105,6 +105,27 @@ Prevent `git commit` if any files are fixed.
 
 Check that files are correctly formatted, but don't format them. This is useful on CI to verify that all changed files in the current branch were correctly formatted.
 
+### `--no-resolve-config`
+
+Do not resolve prettier config when determining which files to format, just use standard set of supported file types & extensions prettier supports. This may be useful if you do not need any customization and see performance issues.
+
+By default, pretty-quick will check your prettier configuration file for any overrides you define to support formatting of additional file extensions.
+
+Example `.prettierrc` file to support formatting files with `.cmp` or `.page` extensions as html.
+
+```
+{
+    "printWidth": 120,
+    "bracketSpacing": false,
+    "overrides": [
+        {
+            "files": "*.{cmp,page}",
+            "options": {"parser": "html"}
+        }
+    ],
+}
+```
+
 <!-- Undocumented = Unsupported :D
 
 ### `--config`

__mocks__/prettier.js

@@ -1,20 +1,20 @@
+const path = require('path');
+
 const prettierMock = {
   format: jest.fn().mockImplementation((input) => 'formatted:' + input),
   resolveConfig: {
     sync: jest.fn().mockImplementation((file) => ({ file })),
   },
-  getSupportInfo: jest.fn().mockReturnValue({
-    languages: [
-      {
-        name: 'JavaScript',
-        extensions: ['.js'],
-      },
-      {
-        name: 'Markdown',
-        extensions: ['.md'],
-      },
-    ],
-  }),
+  getFileInfo: {
+    sync: jest.fn().mockImplementation((file) => {
+      const ext = path.extname(file);
+      if (ext === '.js' || ext === '.md') {
+        return { ignored: false, inferredParser: 'babel' };
+      } else {
+        return { ignored: false, inferredParser: null };
+      }
+    }),
+  },
 };
 
 module.exports = prettierMock;

bin/pretty-quick.js

@@ -7,7 +7,11 @@ const mri = require('mri');
 
 const prettyQuick = require('..').default;
 
-const args = mri(process.argv.slice(2));
+const args = mri(process.argv.slice(2), {
+  alias: {
+    'resolve-config': 'resolveConfig',
+  },
+});
 
 const prettyQuickResult = prettyQuick(
   process.cwd(),

src/__tests__/isSupportedExtension.test.js

@@ -0,0 +1,25 @@
+import isSupportedExtension from '../isSupportedExtension';
+import prettier from 'prettier';
+
+afterEach(() => jest.clearAllMocks());
+
+test('return true when file with supported extension passed in', () => {
+  expect(isSupportedExtension(true)('banana.js')).toEqual(true);
+  expect(prettier.getFileInfo.sync).toHaveBeenCalledWith('banana.js', {
+    resolveConfig: true,
+  });
+});
+
+test('return false when file with not supported extension passed in', () => {
+  expect(isSupportedExtension(true)('banana.txt')).toEqual(false);
+  expect(prettier.getFileInfo.sync).toHaveBeenCalledWith('banana.txt', {
+    resolveConfig: true,
+  });
+});
+
+test('do not resolve config when false passed', () => {
+  expect(isSupportedExtension(false)('banana.txt')).toEqual(false);
+  expect(prettier.getFileInfo.sync).toHaveBeenCalledWith('banana.txt', {
+    resolveConfig: false,
+  });
+});

src/index.js

@@ -22,6 +22,7 @@ export default (
     onExamineFile,
     onCheckFile,
     onWriteFile,
+    resolveConfig = true,
   } = {},
 ) => {
   const scm = scms(currentDirectory);
@@ -42,7 +43,7 @@ export default (
 
   const changedFiles = scm
     .getChangedFiles(directory, revision, staged)
-    .filter(isSupportedExtension)
+    .filter(isSupportedExtension(resolveConfig))
     .filter(createMatcher(pattern))
     .filter(rootIgnorer)
     .filter(cwdIgnorer);

src/isSupportedExtension.js

@@ -1,8 +1,4 @@
-import { getSupportInfo } from 'prettier';
+import { getFileInfo } from 'prettier';
 
-const extensions = getSupportInfo().languages.reduce(
-  (prev, language) => prev.concat(language.extensions || []),
-  [],
-);
-
-export default (file) => extensions.some((ext) => file.endsWith(ext));
+export default (resolveConfig) => (file) =>
+  Boolean(getFileInfo.sync(file, { resolveConfig }).inferredParser);