feat: add git top level option (#420)

* feat: add git top level option

Adds optional git root config locations. New option defaults to false.

* fix: remove cluttered log line

* docs: fix typo in description.

Author: MasonRhodesDev

package.json

@@ -55,6 +55,11 @@
           "default": false,
           "description": "Set to true to capitalize the Windows drive letter in Git's working directory path. Git treats paths as case sensitive and may ignore [includeIf] attributes in your .gitconfig if drive letters are the wrong case."
         },
+        "commitizen.useGitRoot": {
+            "type": "boolean",
+            "default": false,
+            "description": "Use git root to locate .cz-config.js file via `git rev-parse --show-toplevel`"
+        },
         "commitizen.shell": {
           "type": "boolean",
           "default": true,

src/extension.ts

@@ -1,3 +1,4 @@
+import { exec } from 'child_process';
 import execa from 'execa';
 import { join } from 'path';
 import * as sander from 'sander';
@@ -13,6 +14,7 @@ interface Configuration {
   showOutputChannel: 'off' | 'always' | 'onError';
   quoteMessageInGitCommit: boolean;
   capitalizeWindowsDriveLetter: boolean;
+  useGitRoot: boolean;
   shell: boolean;
 }
 
@@ -40,11 +42,9 @@ export async function activate(
       await ccm.getBody();
       await ccm.getBreaking();
       await ccm.getFooter();
-      if (ccm.complete && vscode.workspace.workspaceFolders) {
-        await commit(
-          vscode.workspace.workspaceFolders[0].uri.fsPath,
-          ccm.message.trim()
-        );
+      const lookupPath = await findLookupPath();
+      if (ccm.complete && lookupPath) {
+        await commit(lookupPath, ccm.message.trim());
       }
     })
   );
@@ -73,30 +73,55 @@ interface CzConfig {
   skipQuestions?: string[];
 }
 
+let gitRoot: string | undefined = undefined;
+async function findLookupPath(): Promise<string | undefined> {
+  if (getConfiguration().useGitRoot && gitRoot === undefined) {
+    gitRoot = await new Promise<string>((resolve, reject) =>
+      exec('git rev-parse --show-toplevel', (err, stdout, stderr) => {
+        if (err) {
+          reject({ err, stderr });
+        } else if (stdout) {
+          channel.appendLine(`Found git root at: ${stdout}`);
+          resolve(stdout.trim());
+        } else {
+          reject({ err: 'Unable to find git root' });
+        }
+      })
+    ).catch((e) => {
+      channel.appendLine(e.err.toString());
+      if (e.stderr) {
+        channel.appendLine(e.stderr.toString());
+      }
+      return undefined;
+    });
+  }
+
+  if (gitRoot) {
+    return gitRoot;
+  } else if (!vscode.workspace.workspaceFolders) {
+    return undefined;
+  } else {
+    return vscode.workspace.workspaceFolders[0].uri.fsPath;
+  }
+}
+
 async function readCzConfig(): Promise<CzConfig | undefined> {
-  if (!vscode.workspace.workspaceFolders) {
+  const lookupPath = await findLookupPath();
+  if (!lookupPath) {
     return undefined;
   }
-  let configPath = join(
-    vscode.workspace.workspaceFolders[0].uri.fsPath,
-    '.cz-config.js'
-  );
+  let configPath = join(lookupPath, '.cz-config.js');
+
   if (await sander.exists(configPath)) {
     return require(configPath) as CzConfig;
   }
   const pkg = await readPackageJson();
   if (!pkg) {
     return undefined;
   }
-  configPath = join(
-    vscode.workspace.workspaceFolders[0].uri.fsPath,
-    '.cz-config.js'
-  );
+  configPath = join(lookupPath, '.cz-config.js');
   if (hasCzConfig(pkg)) {
-    configPath = join(
-      vscode.workspace.workspaceFolders[0].uri.fsPath,
-      pkg.config['cz-customizable'].config
-    );
+    configPath = join(lookupPath, pkg.config['cz-customizable'].config);
   }
   if (!(await sander.exists(configPath))) {
     return undefined;
@@ -105,13 +130,11 @@ async function readCzConfig(): Promise<CzConfig | undefined> {
 }
 
 async function readPackageJson(): Promise<object | undefined> {
-  if (!vscode.workspace.workspaceFolders) {
+  const lookupPath = await findLookupPath();
+  if (!lookupPath) {
     return undefined;
   }
-  const pkgPath = join(
-    vscode.workspace.workspaceFolders[0].uri.fsPath,
-    'package.json'
-  );
+  const pkgPath = join(lookupPath, 'package.json');
   if (!(await sander.exists(pkgPath))) {
     return undefined;
   }