feat(IntelliSense): Add a new scope suggestion feature

The scope suggestions include the parsed scopes from existing commit history.

Author: phoihos

README.md

@@ -12,7 +12,8 @@ Edit commit messages via VS Code's editor and Autocomplete for Conventional Comm
     - Auto Completions
         - [Commit Types completion](#commit-types-completion)
         - [Scopes completion](#scopes-completion)
-            - Includes Workspace level scopes management
+            - Includes Workspace level user scopes management
+            - Supports auto grepping the scopes from existing commit history
         - [Gitmojis completion](#gitmojis-completion)
         - [Footer Types completion](#footer-types-completion)
         - [Issues completion](#issues-completion) for the Footer Type `Closes`
@@ -82,6 +83,7 @@ List of available conventional commit types:
 #### Scopes completion
 
 You can type a scope manually, select one that is saved, or create a new scope by selecting the `Create New Scope` item in the suggestion list.
+> **Note:** If `gitCommitMessageEditor.intelliSense.completion.logScopes.enabled` option is `true`, the scope suggestion list also includes the parsed scopes from existing commit history.
 
 ![Demo IntelliSense Summary 2](./images/readme/demo_intellisense_summary_2.gif)
 
@@ -148,15 +150,16 @@ The CodeLens link will appear only when no commit message is typed.
 
 Table of contributed settings (prefix "gitCommitMessageEditor."):
 
-| Name                                    | Default | Description                                                                            |
-| --------------------------------------- | ------- | -------------------------------------------------------------------------------------- |
-| editor.keepAfterSave                    | `false` | Controls whether the commit message editor tab keep or close, after saving             |
-| codeLens.recentCommits.enabled          | `true`  | Controls whether the `Recent commits...` code lens feature is enabled or not           |
-| codeLens.recentCommits.maxItems         | `32`    | Specifies the maximum number of commits to show in the quick pick UI                   |
-| intelliSense.completion.enabled         | `true`  | Controls whether the \"Quick suggestions\" feature is enabled or not                   |
-| intelliSense.completion.scopes          | `[]`    | Scopes that user created (Scopes will be saved into `workspace/.vscode/settings.json`) |
-| intelliSense.completion.issues.pageSize | `20`    | Specifies the maximum number of issues per page to show in the suggestions widget      |
-| intelliSense.hover.enabled              | `true`  | Controls whether the \"Hover\" feature is enabled or not                               |
+| Name                                      | Default | Description                                                                                          |
+| ----------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------- |
+| editor.keepAfterSave                      | `false` | Controls whether the commit message editor tab keep or close, after saving                           |
+| codeLens.recentCommits.enabled            | `true`  | Controls whether the `Recent commits...` code lens feature is enabled or not                         |
+| codeLens.recentCommits.maxItems           | `32`    | Specifies the maximum number of commits to show in the quick pick UI                                 |
+| intelliSense.completion.enabled           | `true`  | Controls whether the \"Quick suggestions\" feature is enabled or not                                 |
+| intelliSense.completion.scopes            | `[]`    | Scopes that user created (Scopes will be saved into `workspace/.vscode/settings.json`)               |
+| intelliSense.completion.logScopes.enabled | `false` | Controls whether the scope suggestions include or not the parsed scopes from existing commit history |
+| intelliSense.completion.issues.pageSize   | `20`    | Specifies the maximum number of issues per page to show in the suggestions widget                    |
+| intelliSense.hover.enabled                | `true`  | Controls whether the \"Hover\" feature is enabled or not                                             |
 
 And recommends adding a setting below into your Global or Workspace `settings.json`, if you want to follow the **Git 50/72 rule**.
 

package-lock.json

@@ -110,6 +110,11 @@
           "default": [],
           "description": "Scopes that user created (Scopes will be saved into `workspace/.vscode/settings.json`)"
         },
+        "gitCommitMessageEditor.intelliSense.completion.logScopes.enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Controls whether the scope suggestions include or not the parsed scopes from existing commit history"
+        },
         "gitCommitMessageEditor.intelliSense.completion.issues.pageSize": {
           "type": "number",
           "default": 20,
@@ -149,30 +154,30 @@
   "devDependencies": {
     "@octokit/openapi-types": "^10.1.1",
     "@octokit/request-error": "^2.1.0",
-    "@types/glob": "^7.1.4",
+    "@types/glob": "^7.2.0",
     "@types/marked": "^0.7.4",
     "@types/mocha": "^8.2.3",
-    "@types/node": "^14.17.15",
-    "@types/papaparse": "^5.2.6",
+    "@types/node": "^14.18.0",
+    "@types/papaparse": "^5.3.1",
     "@types/vscode": "^1.49.0",
-    "@typescript-eslint/eslint-plugin": "^4.31.0",
-    "@typescript-eslint/parser": "^4.31.0",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "eslint": "^7.32.0",
-    "glob": "^7.1.7",
+    "glob": "^7.2.0",
     "mocha": "^8.4.0",
     "replace": "^1.2.1",
-    "standard-version": "^9.3.1",
+    "standard-version": "^9.3.2",
     "ts-loader": "^8.3.0",
     "typescript": "^4.0.2",
     "vscode-test": "^1.4.0",
-    "webpack": "^5.52.0",
-    "webpack-cli": "^4.8.0"
+    "webpack": "^5.65.0",
+    "webpack-cli": "^4.9.1"
   },
   "dependencies": {
     "@octokit/rest": "^18.10.0",
     "@phoihos/vsce-util": "https://github.com./phoihos/vsce-util.git#v0.0.1",
     "conventional-commit-types": "^3.0.0",
-    "gitmojis": "^3.5.0",
+    "gitmojis": "^3.8.0",
     "marked": "^0.8.0"
   }
 }

package.json

@@ -13,6 +13,7 @@ export interface IConfiguration extends vsceUtil.IDisposable {
   readonly recentCommitsMaxItems: number;
   readonly completionEnabled: boolean;
   readonly userScopes: ISummaryScope[];
+  readonly logScopesEnabled: boolean;
   readonly issuesPageSize: number;
   readonly hoverEnabled: boolean;
 
@@ -54,6 +55,10 @@ class Configuration extends vsceUtil.Disposable implements IConfiguration {
     return this._getConfigValue<ISummaryScope[]>('intelliSense.completion.scopes', []);
   }
 
+  get logScopesEnabled(): boolean {
+    return this._getConfigValue<boolean>('intelliSense.completion.logScopes.enabled', false);
+  }
+
   get issuesPageSize(): number {
     return this._getConfigValue<number>('intelliSense.completion.issues.pageSize', 20);
   }

src/configuration.ts

@@ -3,7 +3,9 @@ import * as vscode from 'vscode';
 import { IGitService } from '../../gitService';
 import { IGitCommit } from '../../gitService/interface';
 import { IConfiguration } from '../../configuration';
+
 import { findSummaryLine } from '../parser/textDocumentParser';
+import { EOL_REGEX } from '../parser/syntaxRegex';
 import { makeCommitDescription } from '../helper/commitHelper';
 
 export interface ICommitPickItem extends vscode.QuickPickItem {
@@ -15,8 +17,6 @@ export interface IRecentCommits {
   readonly insertRange: vscode.Range;
 }
 
-const _EOL_REGEX = /\r?\n/;
-
 export class RecentCommitsResolver {
   private readonly _git: IGitService;
   private readonly _config: IConfiguration;
@@ -49,7 +49,7 @@ export class RecentCommitsResolver {
   }
 
   private _makePickItem(commit: IGitCommit): ICommitPickItem {
-    const lines = commit.message.split(_EOL_REGEX);
+    const lines = commit.message.split(EOL_REGEX);
 
     return {
       label: lines[0] + (lines.length > 1 ? ` $(more)(+${lines.length - 1})` : ''),

src/features/codeLens/recentCommitsResolver.ts

@@ -2,6 +2,8 @@ import * as vscode from 'vscode';
 
 import { ISummaryScope, IConfiguration } from '../../configuration';
 
+import { SUMMARY_TOKEN_SCOPE_REGEX } from '../parser/syntaxRegex';
+
 import { ICommand } from '@phoihos/vsce-util';
 
 export class CreateNewScopeCommand implements ICommand {
@@ -56,7 +58,7 @@ export class CreateNewScopeCommand implements ICommand {
         if (lowerScope === '$') return 'Not allow only $';
         if (lowerScopes.includes(lowerScope)) return 'Already exists';
 
-        return /^\$?[\w\-\.]+$/.test(lowerScope)
+        return SUMMARY_TOKEN_SCOPE_REGEX.test(lowerScope)
           ? ''
           : 'Allow only words, underscores, hyphens and dots (can optionally begin with $)';
       }

src/features/intelliSense/createNewScopeCommand.ts

@@ -3,6 +3,7 @@ import * as vscode from 'vscode';
 import { IGitService } from '../../gitService';
 import { IGitIssue } from '../../gitService/interface';
 import { IConfiguration } from '../../configuration';
+
 import { makeCommitDescription, makeCommitMarkdown } from '../helper/commitHelper';
 
 import { TokenCompletionItem, IrregularCompletionItem } from './tokenCompletionItem';

src/features/intelliSense/footerCompletionItemManager.ts

@@ -2,6 +2,7 @@ import * as vscode from 'vscode';
 
 import { IGitService } from '../../gitService';
 import { IConfiguration } from '../../configuration';
+
 import { makeIssueMarkdown } from '../helper/issueHelper';
 import { makeCommitMarkdown } from '../helper/commitHelper';
 

src/features/intelliSense/gitCommitHoverProvider.ts

@@ -29,6 +29,7 @@ export class GitCommitIntelliSenseProvider extends vsceUtil.Disposable {
 
     const summaryCompletionItemManager = new SummaryCompletionItemManager(
       createNewScopeCommand.id,
+      git,
       config
     );
     const footerCompletionItemManager = new FooterCompletionItemManager(

src/features/intelliSense/gitCommitIntelliSenseProvider.ts

@@ -1,37 +1,38 @@
 import * as vscode from 'vscode';
 
-import { IConfiguration } from '../../configuration';
+import { IGitService } from '../../gitService';
+import { IGitCommit } from '../../gitService/interface';
+import { IConfiguration, ISummaryScope } from '../../configuration';
 
-import {
-  TokenCompletionItem,
-  IrregularCompletionItem,
-  EmojiCompletionItem
-} from './tokenCompletionItem';
+import { SUMMARY_SYNTAX_REGEX, SUMMARY_TOKEN_SCOPE_REGEX, EOL_REGEX } from '../parser/syntaxRegex';
+
+import { TokenCompletionItem, EmojiCompletionItem } from './tokenCompletionItem';
 import constants from './constants';
 
 export const SCOPE_RANGE_REGEX = /\(\$?[\w\-\.]*[\(\) ]*/;
 export const EMOJI_RANGE_REGEX = /:[-+_a-z0-9]*(((?<=[-+_a-z0-9]):)? *)/;
 
 export class SummaryCompletionItemManager {
   public readonly typeItems: TokenCompletionItem[];
-  public get scopeItems(): IrregularCompletionItem[] {
-    return this._makeScopeItems();
-  }
-  public readonly emojiItems: EmojiCompletionItem[];
 
-  private readonly _defaultScopeItems: IrregularCompletionItem[];
+  private readonly _emojiItems: EmojiCompletionItem[];
+  private readonly _defaultScopeItems: TokenCompletionItem[];
 
+  private readonly _git: IGitService;
   private readonly _config: IConfiguration;
 
-  constructor(createNewScopeCommandId: string, config: IConfiguration) {
+  constructor(createNewScopeCommandId: string, git: IGitService, config: IConfiguration) {
+    //#region Type completion items
     this.typeItems = constants.summaryTypes.map((e) => {
       const item = new TokenCompletionItem(e.type);
       item.detail = e.title;
       item.documentation = new vscode.MarkdownString(e.emojis[0] + ' ' + e.description);
       item.sortText = e.sort.toString().padStart(2, '0');
       return item;
     });
+    //#endregion
 
+    //#region Emoji completion items
     const getEmojiFilter = (emoji: string): { token: string; sortText: string } => {
       // reserved emoji for BREAKING CHANGE
       if (emoji === '💥') return { token: '!', sortText: '1000' };
@@ -50,28 +51,64 @@ export class SummaryCompletionItemManager {
     };
     const emojiIndexPadding = (constants.summaryEmojis.length - 1).toString().length;
 
-    this.emojiItems = constants.summaryEmojis.map((e, i) => {
+    this._emojiItems = constants.summaryEmojis.map((e, i) => {
       const filter = getEmojiFilter(e.emoji);
 
       const item = new EmojiCompletionItem(e.code, filter.token);
       item.detail = e.emoji;
       item.sortText = filter.sortText + i.toString().padStart(emojiIndexPadding, '0');
       item.insertText = e.emoji + ' ';
       item.filterDoc = new vscode.MarkdownString(
-        e.description + `  \n$(pinned)Suggested by **${filter.token}**`,
+        e.description + `\n\n$(pinned)Suggested by *${filter.token}*`,
         true
       );
       item.nonFilterDoc = new vscode.MarkdownString(e.description);
       return item;
     });
+    //#endregion
 
     this._defaultScopeItems = this._createDefaultScopeItems(createNewScopeCommandId);
 
+    this._git = git;
     this._config = config;
   }
 
-  private _createDefaultScopeItems(createNewScopeCommandId: string): IrregularCompletionItem[] {
-    const item = new IrregularCompletionItem('Create New Scope', vscode.CompletionItemKind.Event);
+  public getScopeItems(
+    uri: vscode.Uri,
+    scopeRange: vscode.Range | undefined
+  ): Thenable<TokenCompletionItem[]> {
+    const logScopesLoading = this._config.logScopesEnabled
+      ? this._git
+          .getCommits(uri, this._config.recentCommitsMaxItems)
+          .then((commits): ISummaryScope[] => {
+            return this._grepLogScopes(commits);
+          })
+      : Promise.resolve<ISummaryScope[]>([]);
+
+    return logScopesLoading.then((logScopes): TokenCompletionItem[] => {
+      return this._makeScopeItems(logScopes, scopeRange);
+    });
+  }
+
+  public getEmojiItems(emojiRange: vscode.Range, filterToken: string): EmojiCompletionItem[] {
+    const fallbackItems: EmojiCompletionItem[] = [];
+
+    const items = this._emojiItems.filter((e) => {
+      e.range = emojiRange;
+      if (e.filterToken === filterToken) {
+        e.documentation = e.filterDoc;
+        return true;
+      }
+      e.documentation = e.nonFilterDoc;
+      fallbackItems.push(e);
+      return false;
+    });
+
+    return items.length > 0 ? items : fallbackItems;
+  }
+
+  private _createDefaultScopeItems(createNewScopeCommandId: string): TokenCompletionItem[] {
+    const item = new TokenCompletionItem('Create New Scope', vscode.CompletionItemKind.Event);
     item.documentation = new vscode.MarkdownString(
       'New scope created will be saved into `.vscode/settings.json`'
     );
@@ -83,18 +120,53 @@ export class SummaryCompletionItemManager {
     return [item];
   }
 
-  private _makeScopeItems(): IrregularCompletionItem[] {
+  private _grepLogScopes(commits: IGitCommit[]): ISummaryScope[] {
+    const logScopes: ISummaryScope[] = [];
+
+    commits.forEach((e) => {
+      const lines = e.message.split(EOL_REGEX);
+      const match = lines[0].match(SUMMARY_SYNTAX_REGEX);
+      const scope = match?.[3] ?? ''; // (\$?[\w\-\.]*)
+
+      if (SUMMARY_TOKEN_SCOPE_REGEX.test(scope)) {
+        const isExist = logScopes.some((ee) => ee.scope === scope);
+        if (isExist === false) {
+          let description = lines[0].replace(`(${scope})`, `(**${scope}**)`);
+          description += lines.length > 1 ? ` $(more)(+${lines.length - 1})` : '';
+          description += `\n\n$(pinned)Suggested from$(git-commit)*${e.hashShort}*`;
+          logScopes.push({ scope, description });
+        }
+      }
+    });
+
+    return logScopes;
+  }
+
+  private _makeScopeItems(
+    logScopes: ISummaryScope[],
+    scopeRange: vscode.Range | undefined
+  ): TokenCompletionItem[] {
     const items = this._defaultScopeItems.slice(0);
 
-    this._config.userScopes.forEach((e) => {
-      const item = new IrregularCompletionItem(e.scope, vscode.CompletionItemKind.Text);
+    const scopes = logScopes.reduce(
+      (acc, e) => {
+        if (acc.some((ee) => ee.scope === e.scope) === false) {
+          acc.push(e);
+        }
+        return acc;
+      },
+      [...this._config.userScopes]
+    );
+
+    scopes.forEach((e) => {
+      const item = new TokenCompletionItem(e.scope, vscode.CompletionItemKind.Text);
       if (e.description !== undefined) {
-        item.documentation = new vscode.MarkdownString(e.description);
+        item.documentation = new vscode.MarkdownString(e.description, true);
       }
       item.sortText = (items.length % 1000).toString().padStart(3, '0');
       item.filterText = '(' + e.scope;
       item.insertText = '(' + e.scope + ')';
-      item.rangeRegex = SCOPE_RANGE_REGEX;
+      item.range = scopeRange;
 
       items.push(item);
     });