.travis.yml

@@ -8,6 +8,7 @@ notifications:
 node_js:
   - 10.13
   - 12
+  - 14
   - node
 install:
   - yarn
@@ -22,7 +23,7 @@ deploy:
     - npx semantic-release@15
   on:
     branch: master
-    node_js: '12'
+    node_js: '14'
 branches:
   except:
     - /^v\d+\.\d+\.\d+$/

README.md

@@ -42,9 +42,11 @@ yarn pretty-quick
 With [`npx`](https://npm.im/npx):
 
 ```shellsession
-npx pretty-quick
+npx -p prettier@latest -p pretty-quick pretty-quick
 ```
 
+> Note: You can (_should_) change `latest` to a specific version of Prettier.
+
 With `npm`:
 
 1. Add `"pretty-quick": "pretty-quick"` to the `"scripts"` section of `package.json`.
@@ -62,7 +64,7 @@ yarn add --dev husky
 
 In `package.json`, add:
 
-```
+```json
 "husky": {
   "hooks": {
     "pre-commit": "pretty-quick --staged"
@@ -105,6 +107,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`
@@ -119,6 +142,11 @@ For example `pretty-quick --since HEAD` will format only staged files.
 
 -->
 
+### `--ignore-path`
+
+Check an alternative file for ignoring files with the same format as [`.prettierignore`](https://prettier.io/docs/en/ignore#ignoring-files).
+For example `pretty-quick --ignore-path=.gitignore`
+
 ## Configuration and Ignore Files
 
-`pretty-quick` will respect your [`.prettierrc`](https://prettier.io/docs/en/configuration), [`.prettierignore`](https://prettier.io/docs/en/ignore#ignoring-files), and [`.editorconfig`](http://editorconfig.org/) files, so there's no additional setup required. Configuration files will be found by searching up the file system. `.prettierignore` files are only found from the repository root and the working directory that the command was executed from.
+`pretty-quick` will respect your [`.prettierrc`](https://prettier.io/docs/en/configuration), [`.prettierignore`](https://prettier.io/docs/en/ignore#ignoring-files), and [`.editorconfig`](http://editorconfig.org/) files if you don't use `--ignore-path` . Configuration files will be found by searching up the file system. `.prettierignore` files are only found from the repository root and the working directory that the command was executed from.

__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,12 @@ 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',
+    'ignore-path': 'ignorePath',
+  },
+});
 
 const prettyQuickResult = prettyQuick(
   process.cwd(),

package.json

@@ -37,7 +37,7 @@
   "scripts": {
     "prepublishOnly": "yarn build",
     "pretty-quick": "./bin/pretty-quick.js",
-    "build": "babel src -d dist --copy-files --ignore __tests__",
+    "build": "babel src -d dist --copy-files --no-copy-ignored --ignore '**/__tests__/*.js'",
     "test": "jest",
     "lint": "eslint . --ignore-path=.gitignore",
     "semantic-release": "semantic-release"

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/__tests__/scm-git.test.js

@@ -332,4 +332,30 @@ describe('with git', () => {
     prettyQuick('/sub-directory/', { since: 'banana', onWriteFile });
     expect(onWriteFile.mock.calls).toEqual([['./foo.js']]);
   });
+
+  test('with --ignore-path to ignore files matching patterns from the repositories root .ignorePath', () => {
+    const onWriteFile = jest.fn();
+    mockGitFs('', {
+      '/.ignorePath': '*.md',
+    });
+    prettyQuick('/sub-directory/', {
+      since: 'banana',
+      onWriteFile,
+      ignorePath: '/.ignorePath',
+    });
+    expect(onWriteFile.mock.calls).toEqual([['./foo.js']]);
+  });
+
+  test('with --ignore-path to ignore files matching patterns from the working directories .ignorePath', () => {
+    const onWriteFile = jest.fn();
+    mockGitFs('', {
+      '/sub-directory/.ignorePath': '*.md',
+    });
+    prettyQuick('/sub-directory/', {
+      since: 'banana',
+      onWriteFile,
+      ignorePath: '/.ignorePath',
+    });
+    expect(onWriteFile.mock.calls).toEqual([['./foo.js']]);
+  });
 });

src/__tests__/scm-hg.test.js

@@ -231,4 +231,30 @@ describe('with hg', () => {
     prettyQuick('/sub-directory/', { since: 'banana', onWriteFile });
     expect(onWriteFile.mock.calls).toEqual([['./foo.js']]);
   });
+
+  test('with --ignore-path to ignore files matching patterns from the repositories root .ignorePath', () => {
+    const onWriteFile = jest.fn();
+    mockHgFs({
+      '/.ignorePath': '*.md',
+    });
+    prettyQuick('/sub-directory/', {
+      since: 'banana',
+      onWriteFile,
+      ignorePath: '/.ignorePath',
+    });
+    expect(onWriteFile.mock.calls).toEqual([['./foo.js']]);
+  });
+
+  test('with --ignore-path to ignore files matching patterns from the working directories .ignorePath', () => {
+    const onWriteFile = jest.fn();
+    mockHgFs({
+      '/.ignorePath': '*.md',
+    });
+    prettyQuick('/sub-directory/', {
+      since: 'banana',
+      onWriteFile,
+      ignorePath: '/.ignorePath',
+    });
+    expect(onWriteFile.mock.calls).toEqual([['./foo.js']]);
+  });
 });

src/index.js

@@ -15,13 +15,15 @@ export default (
     branch,
     bail,
     check,
+    ignorePath,
     verbose,
     onFoundSinceRevision,
     onFoundChangedFiles,
     onPartiallyStagedFile,
     onExamineFile,
     onCheckFile,
     onWriteFile,
+    resolveConfig = true,
   } = {},
 ) => {
   const scm = scms(currentDirectory);
@@ -34,15 +36,15 @@ export default (
 
   onFoundSinceRevision && onFoundSinceRevision(scm.name, revision);
 
-  const rootIgnorer = createIgnorer(directory);
+  const rootIgnorer = createIgnorer(directory, ignorePath);
   const cwdIgnorer =
     currentDirectory !== directory
-      ? createIgnorer(currentDirectory)
+      ? createIgnorer(currentDirectory, ignorePath)
       : () => true;
 
   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);