Refactors autolinks configuration

 - Updates autolink interfaces for better type safety
 - Enhances autolink configuration with explicit boolean flags
 - Adjusts remote providers to use updated autolink structure

Author: eamodio

package.json

@@ -3410,7 +3410,7 @@
 							"properties": {
 								"prefix": {
 									"type": "string",
-									"description": "Specifies the short prefix to use to generate autolinks for the external resource"
+									"description": "Specifies the short prefix to match to generate autolinks for the external resource, e.g. `GH-` or `JIRA-`"
 								},
 								"title": {
 									"type": [

src/annotations/autolinks.ts renamed to src/autolinks.ts

@@ -1,40 +1,50 @@
 import type { ConfigurationChangeEvent } from 'vscode';
 import { Disposable } from 'vscode';
-import type { AutolinkReference, AutolinkType } from '../config';
-import { GlyphChars } from '../constants';
-import type { IntegrationId } from '../constants.integrations';
-import { IssueIntegrationId } from '../constants.integrations';
-import type { Container } from '../container';
-import type { IssueOrPullRequest } from '../git/models/issue';
-import { getIssueOrPullRequestHtmlIcon, getIssueOrPullRequestMarkdownIcon } from '../git/models/issue';
-import type { GitRemote } from '../git/models/remote';
-import type { ProviderReference } from '../git/models/remoteProvider';
-import type { ResourceDescriptor } from '../plus/integrations/integration';
-import { fromNow } from '../system/date';
-import { debug } from '../system/decorators/log';
-import { encodeUrl } from '../system/encoding';
-import { join, map } from '../system/iterable';
-import { Logger } from '../system/logger';
-import { escapeMarkdown } from '../system/markdown';
-import type { MaybePausedResult } from '../system/promise';
-import { capitalize, encodeHtmlWeak, escapeRegex, getSuperscript } from '../system/string';
-import { configuration } from '../system/vscode/configuration';
+import { GlyphChars } from './constants';
+import type { IntegrationId } from './constants.integrations';
+import { IssueIntegrationId } from './constants.integrations';
+import type { Container } from './container';
+import type { IssueOrPullRequest } from './git/models/issue';
+import { getIssueOrPullRequestHtmlIcon, getIssueOrPullRequestMarkdownIcon } from './git/models/issue';
+import type { GitRemote } from './git/models/remote';
+import type { ProviderReference } from './git/models/remoteProvider';
+import type { ResourceDescriptor } from './plus/integrations/integration';
+import { fromNow } from './system/date';
+import { debug } from './system/decorators/log';
+import { encodeUrl } from './system/encoding';
+import { join, map } from './system/iterable';
+import { Logger } from './system/logger';
+import { escapeMarkdown } from './system/markdown';
+import type { MaybePausedResult } from './system/promise';
+import { capitalize, encodeHtmlWeak, escapeRegex, getSuperscript } from './system/string';
+import { configuration } from './system/vscode/configuration';
 
 const emptyAutolinkMap = Object.freeze(new Map<string, Autolink>());
 
 const numRegex = /<num>/g;
 
-export interface Autolink {
+export type AutolinkType = 'issue' | 'pullrequest';
+
+export interface AutolinkReference {
+	/** Short prefix to match to generate autolinks for the external resource */
+	readonly prefix: string;
+	/** URL of the external resource to link to */
+	readonly url: string;
+	/** Whether alphanumeric characters should be allowed in `<num>` */
+	readonly alphanumeric: boolean;
+	/** Whether case should be ignored when matching the prefix */
+	readonly ignoreCase: boolean;
+	readonly title: string | undefined;
+
+	readonly type?: AutolinkType;
+	readonly description?: string;
+	readonly descriptor?: ResourceDescriptor;
+}
+
+export interface Autolink extends AutolinkReference {
 	provider?: ProviderReference;
 	id: string;
-	prefix: string;
-	title?: string;
-	url: string;
-	alphanumeric?: boolean
-	type?: AutolinkType;
-	description?: string;
-
-	descriptor?: ResourceDescriptor;
+
 	tokenize?:
 		| ((
 				text: string,
@@ -69,8 +79,10 @@ export function serializeAutolink(value: Autolink): Autolink {
 			: undefined,
 		id: value.id,
 		prefix: value.prefix,
-		title: value.title,
 		url: value.url,
+		alphanumeric: value.alphanumeric,
+		ignoreCase: value.ignoreCase,
+		title: value.title,
 		type: value.type,
 		description: value.description,
 		descriptor: value.descriptor,
@@ -140,18 +152,12 @@ export class Autolinks implements Disposable {
 			this._references =
 				autolinks
 					?.filter(a => a.prefix && a.url)
-					/**
-					 * Only allow properties defined by {@link AutolinkReference}
-					 */
 					?.map(a => ({
 						prefix: a.prefix,
 						url: a.url,
-						title: a.title,
-						alphanumeric: a.alphanumeric,
-						ignoreCase: a.ignoreCase,
-						type: a.type,
-						description: a.description,
-						descriptor: a.descriptor,
+						alphanumeric: a.alphanumeric ?? false,
+						ignoreCase: a.ignoreCase ?? false,
+						title: a.title ?? undefined,
 					})) ?? [];
 		}
 	}
@@ -237,8 +243,9 @@ export class Autolinks implements Disposable {
 						id: num,
 						prefix: ref.prefix,
 						url: ref.url?.replace(numRegex, num),
-						title: ref.title?.replace(numRegex, num),
 						alphanumeric: ref.alphanumeric,
+						ignoreCase: ref.ignoreCase,
+						title: ref.title?.replace(numRegex, num),
 						type: ref.type,
 						description: ref.description?.replace(numRegex, num),
 						descriptor: ref.descriptor,

src/config.ts

@@ -1,5 +1,4 @@
 import type { SupportedAIModels, VSCodeAIModels } from './constants.ai';
-import type { ResourceDescriptor } from './plus/integrations/integration';
 import type { DateTimeFormat } from './system/date';
 import type { LogLevel } from './system/logger.constants';
 
@@ -18,7 +17,7 @@ export interface Config {
 			};
 		};
 	};
-	readonly autolinks: AutolinkReference[] | null;
+	readonly autolinks: AutolinkConfig[] | null;
 	readonly blame: {
 		readonly avatars: boolean;
 		readonly compact: boolean;
@@ -251,18 +250,17 @@ export interface Config {
 }
 
 export type AnnotationsToggleMode = 'file' | 'window';
-export type AutolinkType = 'issue' | 'pullrequest';
 
-export interface AutolinkReference {
+export interface AutolinkConfig {
+	/** Short prefix to match to generate autolinks for the external resource */
 	readonly prefix: string;
+	/** URL of the external resource to link to */
 	readonly url: string;
-	readonly title?: string;
-	readonly alphanumeric?: boolean;
-	readonly ignoreCase?: boolean;
-
-	readonly type?: AutolinkType;
-	readonly description?: string;
-	readonly descriptor?: ResourceDescriptor;
+	/** Whether alphanumeric characters should be allowed in `<num>` */
+	readonly alphanumeric: boolean;
+	/** Whether case should be ignored when matching the prefix */
+	readonly ignoreCase: boolean;
+	readonly title: string | null;
 }
 
 export type BlameHighlightLocations = 'gutter' | 'line' | 'overview';

src/container.ts

@@ -2,10 +2,10 @@ import { getSupportedGitProviders, getSupportedRepositoryPathMappingProvider } f
 import type { ConfigurationChangeEvent, Disposable, Event, ExtensionContext } from 'vscode';
 import { EventEmitter, ExtensionMode, Uri } from 'vscode';
 import type { AIProviderService } from './ai/aiProviderService';
-import { Autolinks } from './annotations/autolinks';
 import { FileAnnotationController } from './annotations/fileAnnotationController';
 import { LineAnnotationController } from './annotations/lineAnnotationController';
 import { ActionRunners } from './api/actionRunners';
+import { Autolinks } from './autolinks';
 import { setDefaultGravatarsStyle } from './avatars';
 import { CacheProvider } from './cache';
 import { GitCodeLensController } from './codelens/codeLensController';

src/git/formatters/commitFormatter.ts

@@ -1,11 +1,11 @@
 import type { Uri } from 'vscode';
-import type { MaybeEnrichedAutolink } from '../../annotations/autolinks';
 import type {
 	Action,
 	ActionContext,
 	HoverCommandsActionContext,
 	OpenPullRequestActionContext,
 } from '../../api/gitlens';
+import type { MaybeEnrichedAutolink } from '../../autolinks';
 import { getPresenceDataUri } from '../../avatars';
 import { Command } from '../../commands/base';
 import { DiffWithCommand } from '../../commands/diffWith';

src/git/models/commit.ts

@@ -1,5 +1,5 @@
 import { Uri } from 'vscode';
-import type { EnrichedAutolink } from '../../annotations/autolinks';
+import type { EnrichedAutolink } from '../../autolinks';
 import { getAvatarUri, getCachedAvatarUri } from '../../avatars';
 import type { GravatarDefaultStyle } from '../../config';
 import { GlyphChars } from '../../constants';

src/git/remotes/azure-devops.ts

@@ -1,6 +1,5 @@
 import type { Range, Uri } from 'vscode';
-import type { DynamicAutolinkReference } from '../../annotations/autolinks';
-import type { AutolinkReference } from '../../config';
+import type { AutolinkReference, DynamicAutolinkReference } from '../../autolinks';
 import type { GkProviderId } from '../../gk/models/repositoryIdentities';
 import type { Brand, Unbrand } from '../../system/brand';
 import type { Repository } from '../models/repository';
@@ -65,6 +64,8 @@ export class AzureDevOpsRemote extends RemoteProvider {
 				{
 					prefix: '#',
 					url: `${workUrl}/_workitems/edit/<num>`,
+					alphanumeric: false,
+					ignoreCase: false,
 					title: `Open Work Item #<num> on ${this.name}`,
 
 					type: 'issue',
@@ -74,6 +75,8 @@ export class AzureDevOpsRemote extends RemoteProvider {
 					// Default Pull request message when merging a PR in ADO. Will not catch commits & pushes following a different pattern.
 					prefix: 'PR ',
 					url: `${this.baseUrl}/pullrequest/<num>`,
+					alphanumeric: false,
+					ignoreCase: false,
 					title: `Open Pull Request #<num> on ${this.name}`,
 
 					type: 'pullrequest',

src/git/remotes/bitbucket-server.ts

@@ -1,6 +1,5 @@
 import type { Range, Uri } from 'vscode';
-import type { DynamicAutolinkReference } from '../../annotations/autolinks';
-import type { AutolinkReference } from '../../config';
+import type { AutolinkReference, DynamicAutolinkReference } from '../../autolinks';
 import type { GkProviderId } from '../../gk/models/repositoryIdentities';
 import type { Brand, Unbrand } from '../../system/brand';
 import { isSha } from '../models/reference';
@@ -23,13 +22,16 @@ export class BitbucketServerRemote extends RemoteProvider {
 				{
 					prefix: 'issue #',
 					url: `${this.baseUrl}/issues/<num>`,
+					alphanumeric: false,
+					ignoreCase: true,
 					title: `Open Issue #<num> on ${this.name}`,
 
 					type: 'issue',
 					description: `${this.name} Issue #<num>`,
 				},
 				{
 					prefix: 'pull request #',
+					alphanumeric: false,
 					ignoreCase: true,
 					url: `${this.baseUrl}/pull-requests/<num>`,
 					title: `Open Pull Request #<num> on ${this.name}`,

src/git/remotes/bitbucket.ts

@@ -1,6 +1,5 @@
 import type { Range, Uri } from 'vscode';
-import type { DynamicAutolinkReference } from '../../annotations/autolinks';
-import type { AutolinkReference } from '../../config';
+import type { AutolinkReference, DynamicAutolinkReference } from '../../autolinks';
 import type { GkProviderId } from '../../gk/models/repositoryIdentities';
 import type { Brand, Unbrand } from '../../system/brand';
 import { isSha } from '../models/reference';
@@ -23,6 +22,8 @@ export class BitbucketRemote extends RemoteProvider {
 				{
 					prefix: 'issue #',
 					url: `${this.baseUrl}/issues/<num>`,
+					alphanumeric: false,
+					ignoreCase: true,
 					title: `Open Issue #<num> on ${this.name}`,
 
 					type: 'issue',
@@ -31,6 +32,8 @@ export class BitbucketRemote extends RemoteProvider {
 				{
 					prefix: 'pull request #',
 					url: `${this.baseUrl}/pull-requests/<num>`,
+					alphanumeric: false,
+					ignoreCase: true,
 					title: `Open Pull Request #<num> on ${this.name}`,
 
 					type: 'pullrequest',

src/git/remotes/gerrit.ts

@@ -1,6 +1,5 @@
 import type { Range, Uri } from 'vscode';
-import type { DynamicAutolinkReference } from '../../annotations/autolinks';
-import type { AutolinkReference } from '../../config';
+import type { AutolinkReference, DynamicAutolinkReference } from '../../autolinks';
 import type { GkProviderId } from '../../gk/models/repositoryIdentities';
 import { isSha } from '../models/reference';
 import type { Repository } from '../models/repository';
@@ -41,8 +40,9 @@ export class GerritRemote extends RemoteProvider {
 				{
 					prefix: 'Change-Id: ',
 					url: `${this.baseReviewUrl}/q/<num>`,
-					title: `Open Change #<num> on ${this.name}`,
 					alphanumeric: true,
+					ignoreCase: true,
+					title: `Open Change #<num> on ${this.name}`,
 
 					description: `${this.name} Change #<num>`,
 				},