shuffling deck chairs to allow solution to grow nicely (#30)

Author: jjmschofield

src/cli.ts

@@ -8,7 +8,7 @@ import { who } from './commands/who';
 import { git } from './commands/git';
 import { log } from './lib/logger';
 
-import { OUTPUT_FORMAT } from './lib/types';
+import { OUTPUT_FORMAT } from './lib/writers/types';
 
 commander.command('audit')
   .description('list the owners for all files')

src/commands/audit.ts

@@ -1,10 +1,6 @@
-import * as path from 'path';
-import { OwnershipEngine } from '../lib/OwnershipEngine';
-import { OwnedFile } from '../lib/OwnedFile';
-import { OUTPUT_FORMAT } from '../lib/types';
+import { OUTPUT_FORMAT, writeOwnedFile, writeStats } from '../lib/writers';
 import { calcFileStats } from '../lib/stats';
-import { writeOwnedFile, writeStats } from '../lib/writers';
-import { readDirRecursively } from '../lib/dir';
+import { getFileOwnership } from '../lib/ownership';
 
 interface AuditOptions {
   codeowners: string;
@@ -16,7 +12,7 @@ interface AuditOptions {
 }
 
 export const audit = async (options: AuditOptions) => {
-  const files = await getFilesWithOwnership(options);
+  const files = await getFileOwnership(options);
 
   if (options.stats) {
     const stats = calcFileStats(files);
@@ -34,23 +30,3 @@ export const audit = async (options: AuditOptions) => {
     }
   }
 };
-
-const getFilesWithOwnership = async (options: AuditOptions): Promise<OwnedFile[]> => {
-  const engine = OwnershipEngine.FromCodeownersFile(options.codeowners);
-
-  let 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(options.root, filePath));
-  }
-
-  filePaths.sort();
-
-  const files: OwnedFile[] = [];
-
-  for (const filePath of filePaths) {
-    files.push(await OwnedFile.FromPath(filePath, engine));
-  }
-
-  return files;
-};

src/commands/git.ts

@@ -1,10 +1,7 @@
 import { execSync } from 'child_process';
-
-import { OwnedFile } from '../lib/OwnedFile';
-import { OwnershipEngine } from '../lib/OwnershipEngine';
-import { OUTPUT_FORMAT, Stats } from '../lib/types';
+import { OwnedFile, OwnershipEngine } from '../lib/ownership';
+import { OUTPUT_FORMAT, writeOwnedFile, writeStats } from '../lib/writers';
 import { calcFileStats } from '../lib/stats';
-import { writeOwnedFile, writeStats } from '../lib/writers';
 
 interface GitOptions {
   dir: string;

src/commands/who.ts

@@ -1,7 +1,5 @@
-import { OwnershipEngine } from '../lib/OwnershipEngine';
-import { OwnedFile } from '../lib/OwnedFile';
-import { OUTPUT_FORMAT } from '../lib/types';
-import { writeOwnedFile } from '../lib/writers';
+import { OwnershipEngine, OwnedFile } from '../lib/ownership';
+import { writeOwnedFile, OUTPUT_FORMAT } from '../lib/writers';
 
 interface WhoOptions {
   file: string;

src/lib/dir.test.ts

@@ -0,0 +1 @@
+export { log } from './logger';

src/lib/logger/index.ts

@@ -3,6 +3,11 @@ class Logger {
     // tslint:disable-next-line:no-console
     console.error(msg, error);
   }
+
+  public warn(msg: string, error?: Error): void {
+    // tslint:disable-next-line:no-console
+    console.warn(msg, error);
+  }
 }
 
 export const log = new Logger();

src/lib/logger.ts src/lib/logger/logger.tssrc/lib/logger.ts renamed to src/lib/logger/logger.ts

@@ -0,0 +1,24 @@
+import { OwnedFile } from './lib/OwnedFile';
+import { OwnershipEngine } from './lib/OwnershipEngine';
+import { readDirRecursively } from './lib/readDirRecursively';
+import * as path from 'path';
+
+export const getFileOwnership = async (options: { codeowners: string, dir: string, root?: string }): Promise<OwnedFile[]> => {
+  const engine = OwnershipEngine.FromCodeownersFile(options.codeowners);
+
+  let 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));
+  }
+
+  filePaths.sort();
+
+  const files: OwnedFile[] = [];
+
+  for (const filePath of filePaths) {
+    files.push(await OwnedFile.FromPath(filePath, engine));
+  }
+
+  return files;
+};

src/lib/ownership/file.ts

@@ -0,0 +1,4 @@
+export { OwnedFile } from './lib/OwnedFile';
+export { OwnershipEngine } from './lib/OwnershipEngine';
+export { getFileOwnership } from './file';
+export { Matcher, FileOwnershipMatcher } from './types';

src/lib/ownership/index.ts

@@ -1,6 +1,6 @@
 import { OwnershipEngine } from './OwnershipEngine';
 import * as fs from 'fs';
-import { log } from './logger';
+import { log } from '../../logger';
 
 export class OwnedFile {
   // tslint:disable-next-line:variable-name