feat: add --verbose flag (#46)

* added verbose flag functionality

* documentation for verbose flag

* remove onUnchangedFile, it seems redundant

* added tests for verbose flag

Author: flurmbo

README.md

@@ -88,6 +88,10 @@ Use with the `--staged` flag to skip re-staging files after formatting.
 
 When not in `staged` pre-commit mode, use this flag to compare changes with the specified branch. Defaults to `master` (git) / `default` (hg) branch.
 
+### `--verbose`
+
+Outputs the name of each file right before it is proccessed. This can be useful if Prettier throws an error and you can't identify which file is causing the problem.
+
 <!-- Undocumented = Unsupported :D
 
 ### `--config`

bin/pretty-quick.js

@@ -37,6 +37,10 @@ prettyQuick(
     onWriteFile: file => {
       console.log(`✍️  Fixing up ${chalk.bold(file)}.`);
     },
+
+    onExamineFile: file => {
+      console.log(`🔍  Examining ${chalk.bold(file)}.`);
+    },
   })
 );
 

src/__tests__/scm-git.test.js

@@ -221,4 +221,24 @@ describe('with git', () => {
       cwd: '/',
     });
   });
+
+  test('with --verbose calls onExamineFile', () => {
+    const onExamineFile = jest.fn();
+    mockGitFs();
+
+    prettyQuick('root', { since: 'banana', verbose: true, onExamineFile });
+
+    expect(onExamineFile).toHaveBeenCalledWith('./foo.js');
+    expect(onExamineFile).toHaveBeenCalledWith('./bar.md');
+  });
+
+  test('without --verbose does NOT call onExamineFile', () => {
+    const onExamineFile = jest.fn();
+    mockGitFs();
+
+    prettyQuick('root', { since: 'banana', onExamineFile });
+
+    expect(onExamineFile).not.toHaveBeenCalledWith('./foo.js');
+    expect(onExamineFile).not.toHaveBeenCalledWith('./bar.md');
+  });
 });

src/__tests__/scm-hg.test.js

@@ -134,4 +134,22 @@ describe('with hg', () => {
       cwd: '/',
     });
   });
+
+  test('with --verbose calls onExamineFile', () => {
+    const onExamineFile = jest.fn();
+    mockHgFs();
+    prettyQuick('root', { since: 'banana', verbose: true, onExamineFile });
+
+    expect(onExamineFile).toHaveBeenCalledWith('./foo.js');
+    expect(onExamineFile).toHaveBeenCalledWith('./bar.md');
+  });
+
+  test('without --verbose does NOT call onExamineFile', () => {
+    const onExamineFile = jest.fn();
+    mockHgFs();
+    prettyQuick('root', { since: 'banana', onExamineFile });
+
+    expect(onExamineFile).not.toHaveBeenCalledWith('./foo.js');
+    expect(onExamineFile).not.toHaveBeenCalledWith('./bar.md');
+  });
 });

src/formatFiles.js

@@ -2,8 +2,13 @@ import { readFileSync, writeFileSync } from 'fs';
 import { resolveConfig, format } from 'prettier';
 import { join } from 'path';
 
-export default (directory, files, { config, onWriteFile } = {}) => {
+export default (
+  directory,
+  files,
+  { config, onWriteFile, onExamineFile } = {}
+) => {
   for (const relative of files) {
+    onExamineFile && onExamineFile(relative);
     const file = join(directory, relative);
     const options = resolveConfig.sync(file, { config, editorconfig: true });
     const input = readFileSync(file, 'utf8');

src/index.js

@@ -11,10 +11,12 @@ export default (
     staged,
     restage = true,
     branch,
+    verbose,
     onFoundSinceRevision,
     onFoundChangedFiles,
     onPartiallyStagedFile,
     onWriteFile,
+    onExamineFile,
   } = {}
 ) => {
   const scm = scms(currentDirectory);
@@ -55,5 +57,6 @@ export default (
         }
       }
     },
+    onExamineFile: verbose && onExamineFile,
   });
 };