refactor: Rename dir to dirPath

Author: MichaelCurrin

src/generate/action.ts

@@ -41,14 +41,14 @@ export function moveRenamePath(oldPath: string, newPath: string): string {
     newP = splitPath(newPath);
 
   if (oldP.name === newP.name) {
-    const target = newP.dir;
+    const target = newP.dirPath;
     return `Move ${oldP.name} to ${target}`;
   }
-  if (oldP.dir === newP.dir) {
+  if (oldP.dirPath === newP.dirPath) {
     const target = newP.name;
     return `Rename ${oldP.name} to ${target}`;
   }
 
-  const target = newP.dir === ROOT ? `${newP.name} at ${ROOT}` : newPath;
+  const target = newP.dirPath === ROOT ? `${newP.name} at ${ROOT}` : newPath;
   return `Move and rename ${oldP.name} to ${target}`;
 }

src/generate/paths.ts

@@ -9,7 +9,7 @@ import { ROOT } from './constants';
 
 interface SplitPathResult {
   atRoot: boolean;
-  dir: string;
+  dirPath: string;
   name: string;
   extension: string;
 }
@@ -30,7 +30,7 @@ export function splitPath(filePath: string): SplitPathResult {
 
   return {
     atRoot: isAtRepoRoot,
-    dir: isAtRepoRoot ? ROOT : dir,
+    dirPath: isAtRepoRoot ? ROOT : dir,
     name: path.basename(filePath),
     extension: path.extname(filePath)
   };

src/generate/semantic.ts

@@ -43,7 +43,7 @@ const PACKAGE_NAMES = [
  */
 export class Semantic {
   atRoot: boolean;
-  dir: string;
+  dirPath: string;
   name: string;
   extension: string;
 
@@ -55,9 +55,9 @@ export class Semantic {
     // Maybe a class is overkill as it is just a container of data.
     // Maybe the {} can be stored an object here. Or maybe combine that and this at the risk
     // of doing too much. But still easy to test attributes vs methods.
-    const { atRoot, dir, name, extension } = splitPath(filePath);
+    const { atRoot, dirPath, name, extension } = splitPath(filePath);
     this.atRoot = atRoot;
-    this.dir = dir;
+    this.dirPath = dirPath;
     this.name = name;
     this.extension = extension;
   }
@@ -69,12 +69,12 @@ export class Semantic {
    * except perhaps for config files.
    */
   isDocRelated(): boolean {
-    return this.name === 'README.md' || this.dir.startsWith('docs');
+    return this.name === 'README.md' || this.dirPath.startsWith('docs');
   }
 
   isTestRelated(): boolean {
     return (
-      this.dir.includes('test/') ||
+      this.dirPath.includes('test/') ||
       this.name.includes('.test.') ||
       this.name.includes('.spec.') ||
       this.name.startsWith('test_') ||
@@ -83,15 +83,15 @@ export class Semantic {
   }
 
   isCIRelated(): boolean {
-    return this.dir in CI_DIRS || this.name in CI_NAMES;
+    return this.dirPath in CI_DIRS || this.name in CI_NAMES;
   }
 
   // Broadly match eslint configs https://eslint.org/docs/user-guide/configuring
   // And prettier configs https://prettier.io/docs/en/configuration.html
   isConfigRelated(): boolean {
     if (
       this.extension in CONFIG_EXTENSIONS ||
-      this.dir in CONFIG_DIRS ||
+      this.dirPath in CONFIG_DIRS ||
       this.name in CONFIG_NAMES ||
       this.name.includes('.eslintrc') ||
       this.name.includes('.prettier')

src/test/paths.test.ts

@@ -7,14 +7,14 @@ describe('Path handling', function() {
     it('splits a path correctly', function() {
       assert.deepEqual(splitPath('baz.txt'), {
         atRoot: true,
-        dir: 'repo root',
+        dirPath: 'repo root',
         name: 'baz.txt',
         extension: '.txt'
       });
 
       assert.deepEqual(splitPath('foo/bar/baz.txt'), {
         atRoot: false,
-        dir: 'foo/bar',
+        dirPath: 'foo/bar',
         name: 'baz.txt',
         extension: '.txt'
       });