Use a popup to suggest verbose Git commits

Author: walles

README.md

@@ -39,8 +39,6 @@ messages](https://cbea.ms/git-commit).
 
 ### TODO
 
-- When a user opens a `COMMIT_EDITMESSAGE` file and verbose commits are not
-  enabled, open a popup in the bottom right corner offering a fix-it button
 - Consider the tests for no-diffs for both diagnostics and quick fixes. Are we
   really testing for comment-line followed by an empty line at the end?
 - Disable `@typescript-eslint/no-non-null-assertion` in `*.test.*` files, or in

src/extension.ts

@@ -2,8 +2,9 @@ import * as vscode from "vscode";
 import GitCommitCodeActionProvider from "./quickfix";
 import GitCommitCompletionsProvider from "./completions";
 import getCurrentGitBranch from "./getgitbranch";
-import { setVerboseCommitCommand } from "./setverbosecommits";
+import * as verbosecommits from "./verbosecommits";
 import { getDiagnostics } from "./diagnostics";
+import { displayVerboseDiffMessage } from "./messages";
 
 export const setVerboseCommitCommandId =
   "git-commit-message-plus.setVerboseGitCommits";
@@ -41,7 +42,7 @@ export async function activate(context: vscode.ExtensionContext) {
   context.subscriptions.push(
     vscode.commands.registerCommand(
       setVerboseCommitCommandId,
-      setVerboseCommitCommand
+      verbosecommits.enable
     )
   );
 
@@ -55,6 +56,13 @@ export async function activate(context: vscode.ExtensionContext) {
     )
   );
 
+  // Show informational toast about doing verbose Git commits
+  vscode.workspace.onDidOpenTextDocument(
+    displayVerboseDiffMessage,
+    null,
+    context.subscriptions
+  );
+
   // Call the listeners on initilization for current active text editor
   //
   // Inspiration from here:
@@ -64,6 +72,7 @@ export async function activate(context: vscode.ExtensionContext) {
     if (editor && editor.document.languageId === "git-commit") {
       gitBranch = await getCurrentGitBranch(editor.document.uri);
       doLinting(editor.document);
+      displayVerboseDiffMessage(editor.document);
     }
   }
   vscode.window.onDidChangeActiveTextEditor(

src/messages.ts

@@ -0,0 +1,27 @@
+import * as vscode from "vscode";
+import * as path from "path";
+import * as verbosecommits from "./verbosecommits";
+
+/** Show informational toast about doing verbose Git commits */
+export async function displayVerboseDiffMessage(doc: vscode.TextDocument) {
+  if (path.basename(doc.fileName) !== "COMMIT_EDITMSG") {
+    // We only like one kind of files
+    return;
+  }
+
+  if (await verbosecommits.isEnabled()) {
+    // Already done
+    return;
+  }
+
+  const decision = await vscode.window.showInformationMessage(
+    "Use verbose Git commits to see diffs while typing your commit message",
+    "Enable verbose commits"
+  );
+  if (decision === undefined) {
+    return;
+  }
+
+  // User picked the only option, let's do it!
+  await verbosecommits.enable();
+}

src/quickfix.ts

@@ -3,7 +3,7 @@ import * as path from "path";
 import * as utils from "./utils";
 import { gitBranch, setVerboseCommitCommandId } from "./extension";
 import { createBranchIssueIdFix, createUpcaseJiraIdFix } from "./jira";
-import { isVerboseCommitsEnabled } from "./setverbosecommits";
+import * as verbosecommits from "./verbosecommits";
 
 // Inspired by:
 // https://github.com/microsoft/vscode-extension-samples/blob/main/code-actions-sample/src/extension.ts
@@ -141,7 +141,7 @@ async function createEnableGitVerboseCommitFix(
     return [];
   }
 
-  if (await isVerboseCommitsEnabled()) {
+  if (await verbosecommits.isEnabled()) {
     // Already enabled, we can't do anything
     return [];
   }

src/test/suite/quickfix.test.ts

@@ -6,11 +6,7 @@ import * as utils from "../../utils";
 import * as vscode from "vscode";
 import { ConfigurationTarget, workspace } from "vscode";
 import { setVerboseCommitCommandId } from "../../extension";
-import {
-  doesGitDoVerboseCommits,
-  doesVsCodeDoVerboseCommits,
-  isVerboseCommitsEnabled,
-} from "../../setverbosecommits";
+import * as verbosecommits from "../../verbosecommits";
 
 import * as child_process from "child_process";
 import * as util from "util";
@@ -218,18 +214,18 @@ suite("Quick Fix", () => {
           // Verify VSCode verbose commits are now enabled
 
           assert.equal(
-            doesVsCodeDoVerboseCommits(),
+            verbosecommits.doesVsCodeDoVerboseCommits(),
             true,
             "Verbose Git commits in VSCode"
           );
 
           assert.equal(
-            await doesGitDoVerboseCommits(),
+            await verbosecommits.doesGitDoVerboseCommits(),
             true,
             "Verbose Git commits in Git"
           );
 
-          assert.equal(await isVerboseCommitsEnabled(), true);
+          assert.equal(await verbosecommits.isEnabled(), true);
         });
       }
     }

src/setverbosecommits.ts src/verbosecommits.tssrc/setverbosecommits.ts renamed to src/verbosecommits.ts

@@ -5,7 +5,7 @@ import * as util from "util";
 const execFile = util.promisify(child_process.execFile);
 
 /** Tell both Git and VSCode that commit messages should contain diffs */
-export async function setVerboseCommitCommand() {
+export async function enable() {
   return Promise.all([
     // Set command line verbose-commits-by-default
     execFile("git", ["config", "--global", "commit.verbose", "true"]),
@@ -21,10 +21,9 @@ export async function setVerboseCommitCommand() {
  * Check whether there's something we can change to make verbose commits more
  * likely.
  *
- * Basically, if this function returns true then setVerboseCommitCommand() won't
- * have any effect.
+ * Basically, if this function returns true then enable() won't have any effect.
  */
-export async function isVerboseCommitsEnabled(): Promise<boolean> {
+export async function isEnabled(): Promise<boolean> {
   if (!doesVsCodeDoVerboseCommits()) {
     // VSCode setting can be updated
     return false;