feat: audit --only-git tracked files (#37)

* feat: target node 8 (remove await boilerplate)

Maybe this makes it start faster? Maybe it's my imagination?

* chore: ignore junit.xml (generated by jest)

* feat: audit --only-git tracked files

This stops the auditing report from showing random files
people have lying around in their working directory, if
they happen to not care about those.

Author: FauxFaux

.gitignore

@@ -70,3 +70,4 @@ fabric.properties
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
+/junit.xml

src/cli.ts

@@ -17,6 +17,7 @@ commander.command('audit')
   .option('-c, --codeowners <filePath>', 'path to codeowners file (default: "<dir>/.github/CODEOWNERS")')
   .option('-o, --output <outputFormat>', `how to output format eg: ${Object.values(OUTPUT_FORMAT).join(', ')}`, OUTPUT_FORMAT.SIMPLE)
   .option('-u, --unloved', 'write unowned files only', false)
+  .option('-g, --only-git', 'consider only files tracked by git', false)
   .option('-s, --stats', 'write output stats', false)
   .option('-r, --root <rootPath>', 'the root path to filter files by', '')
   .action(async (options) => {

src/commands/audit.ts

@@ -7,6 +7,7 @@ interface AuditOptions {
   dir: string;
   unloved: boolean;
   output: OUTPUT_FORMAT;
+  onlyGit: boolean;
   stats: boolean;
   root: string;
 }

src/lib/ownership/file.ts

@@ -2,11 +2,17 @@ import { OwnedFile } from './lib/OwnedFile';
 import { OwnershipEngine } from './lib/OwnershipEngine';
 import { readDirRecursively } from './lib/readDirRecursively';
 import * as path from 'path';
+import { gitLsFiles } from './lib/gitLsFiles';
 
-export const getFileOwnership = async (options: { codeowners: string, dir: string, root?: string }): Promise<OwnedFile[]> => {
+export const getFileOwnership = async (options: { codeowners: string, dir: string, onlyGit: boolean, root?: string }): Promise<OwnedFile[]> => {
   const engine = OwnershipEngine.FromCodeownersFile(options.codeowners);
 
-  let filePaths = await readDirRecursively(options.dir, ['.git']);
+  let filePaths;
+  if (options.onlyGit) {
+    filePaths = await gitLsFiles(options.dir);
+  } else {
+    filePaths = await readDirRecursively(options.dir, ['.git']);
+  }
 
   if (options.root) { // We need to re-add the root so that later ops can find the file
     filePaths = filePaths.map(filePath => path.join(<string>options.root, filePath));

src/lib/ownership/lib/execFile.ts

@@ -0,0 +1,4 @@
+import { execFile as realExecFile } from 'child_process';
+import { promisify } from 'util';
+
+export const execFile = promisify(realExecFile);

src/lib/ownership/lib/gitLsFiles.test.ts

@@ -0,0 +1,21 @@
+import { execFile } from './execFile';
+import { mocked } from 'ts-jest';
+import { gitLsFiles } from './gitLsFiles';
+jest.mock('./execFile');
+
+describe('git ls-files', () => {
+  it('splits the input', async () => {
+    mocked(execFile).mockResolvedValue({ stdout: 'foo\nbar\n', stderr: '' });
+
+    const result = await gitLsFiles('some/dir');
+
+    expect(result).toStrictEqual(['foo', 'bar']);
+    expect(execFile).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.anything(),
+      expect.objectContaining({
+        cwd: 'some/dir',
+      }),
+    );
+  });
+});

src/lib/ownership/lib/gitLsFiles.ts

@@ -0,0 +1,6 @@
+import { execFile } from './execFile';
+
+export const gitLsFiles = async (dir: string): Promise<string[]> => {
+  const { stdout } = await execFile('git', ['ls-files'], { cwd: dir });
+  return stdout.split('\n').filter(x => !!x);
+};

tsconfig.json

@@ -2,11 +2,11 @@
   "compilerOptions": {
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",
+    "target": "es2017",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    "lib": ["es2017"],                        /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */