feat: add reference and definition provider (#145)

Cythia828 · web-flow · commit 4b9aa93ace7c · 2025-02-13T17:57:01.000+08:00
* feat: add get references and definitions ability for entity

* ci(format): format code

* feat(optimize reference and definition feat): optimize reference and definition feat

* ci(format): format prettier

* feat(add comment for DefinitionAdapter and ReferenceAdapter): add comment

---------

Co-authored-by: zhaoge &lt;&gt;
diff --git a/src/languageFeatures.ts b/src/languageFeatures.ts
@@ -1,16 +1,20 @@
+import type { ParseError } from 'dt-sql-parser';
+import { EntityContext } from 'dt-sql-parser/dist/parser/common/entityCollector';
+import { WordPosition } from 'dt-sql-parser/dist/parser/common/textAndWord';
+import * as monaco from 'monaco-editor';
+
+import { BaseSQLWorker } from './baseSQLWorker';
+import { debounce } from './common/utils';
 import {
+	CancellationToken,
 	editor,
-	Uri,
 	IDisposable,
-	MarkerSeverity,
-	Range,
 	languages,
+	MarkerSeverity,
 	Position,
-	CancellationToken
+	Range,
+	Uri
 } from './fillers/monaco-editor-core';
-import { debounce } from './common/utils';
-import { BaseSQLWorker } from './baseSQLWorker';
-import type { ParseError } from 'dt-sql-parser';
 import type { LanguageServiceDefaults } from './monaco.contribution';
 
 export interface WorkerAccessor<T extends BaseSQLWorker> {
@@ -197,3 +201,145 @@ export class CompletionAdapter<T extends BaseSQLWorker>
 			});
 	}
 }
+/**
+ * The adapter is for the definition of the symbol at the given position and document.
+ **/
+export class DefinitionAdapter<T extends BaseSQLWorker> implements languages.DefinitionProvider {
+	constructor(
+		private readonly _worker: WorkerAccessor<T>,
+		private readonly _defaults: LanguageServiceDefaults
+	) {}
+	/**
+	 * Provide the definition of the symbol at the given position and document.
+	 **/
+	provideDefinition(
+		model: editor.IReadOnlyModel,
+		position: Position,
+		_token: CancellationToken
+	): languages.ProviderResult<languages.Definition | languages.LocationLink[]> {
+		const resource = model.uri;
+		const lineContent = model.getLineContent(position.lineNumber);
+		if (lineContent.startsWith('--')) return null;
+		return this._worker(resource)
+			.then((worker) => {
+				let code = model?.getValue() || '';
+				if (typeof this._defaults.preprocessCode === 'function') {
+					code = this._defaults.preprocessCode(code);
+				}
+				return worker.getAllEntities(code);
+			})
+			.then((entities) => {
+				const word = model.getWordAtPosition(position);
+				let pos: WordPosition = {
+					line: -1,
+					startIndex: -1,
+					endIndex: -1,
+					startColumn: -1,
+					endColumn: -1
+				};
+				const curEntity = entities?.find((entity: EntityContext) => {
+					const entityPosition = entity.position;
+					if (
+						entityPosition.startColumn === word?.startColumn &&
+						entityPosition.endColumn === word?.endColumn &&
+						entityPosition.line === position.lineNumber
+					) {
+						return entity;
+					}
+					return null;
+				});
+				if (curEntity) {
+					for (let k in entities) {
+						const entity = entities[Number(k)];
+						if (
+							entity.entityContextType.includes('Create') &&
+							word?.word &&
+							entity.text === word?.word &&
+							entity.entityContextType.includes(curEntity.entityContextType)
+						) {
+							pos = entity.position;
+							break;
+						}
+					}
+				}
+				if (pos && pos.line !== -1) {
+					return {
+						uri: model.uri,
+						range: new monaco.Range(
+							pos?.line,
+							pos?.startColumn,
+							pos?.line,
+							pos?.endColumn
+						)
+					};
+				}
+			});
+	}
+}
+/**
+ * The adapter is for the references of the symbol at the given position and document.
+ **/
+export class ReferenceAdapter<T extends BaseSQLWorker> implements languages.ReferenceProvider {
+	constructor(
+		private readonly _worker: WorkerAccessor<T>,
+		private readonly _defaults: LanguageServiceDefaults
+	) {}
+	/**
+	 * Provide a set of project-wide references for the given position and document.
+	 **/
+	provideReferences(
+		model: editor.IReadOnlyModel,
+		position: Position,
+		_context: languages.ReferenceContext,
+		_token: CancellationToken
+	): languages.ProviderResult<languages.Location[]> {
+		const resource = model.uri;
+		const lineContent = model.getLineContent(position.lineNumber);
+		if (!lineContent.startsWith('CREATE')) return;
+		return this._worker(resource)
+			.then((worker) => {
+				let code = model?.getValue() || '';
+				if (typeof this._defaults.preprocessCode === 'function') {
+					code = this._defaults.preprocessCode(code);
+				}
+				return worker.getAllEntities(model?.getValue());
+			})
+			.then((entities) => {
+				const word = model.getWordAtPosition(position);
+				const arr: languages.Location[] = [];
+				const curEntity = entities?.find((entity: EntityContext) => {
+					const entityPosition = entity.position;
+					if (
+						entityPosition.startColumn === word?.startColumn &&
+						entityPosition.endColumn === word?.endColumn &&
+						entityPosition.line === position.lineNumber
+					) {
+						return entity;
+					}
+					return null;
+				});
+				if (curEntity) {
+					entities?.forEach((entity) => {
+						if (
+							word?.word &&
+							entity.text === word?.word &&
+							curEntity.entityContextType.includes(entity.entityContextType)
+						) {
+							let pos: WordPosition | null = null;
+							pos = entity.position;
+							arr.push({
+								uri: model.uri,
+								range: new monaco.Range(
+									pos?.line,
+									pos?.startColumn,
+									pos?.line,
+									pos?.endColumn
+								)
+							});
+						}
+					});
+				}
+				return arr;
+			});
+	}
+}
diff --git a/src/languages/flink/flink.contribution.ts b/src/languages/flink/flink.contribution.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.FLINK,
@@ -16,5 +16,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.FLINK, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/languages/hive/hive.contribution.ts b/src/languages/hive/hive.contribution.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.HIVE,
@@ -16,5 +16,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.HIVE, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/languages/impala/impala.contribution.ts b/src/languages/impala/impala.contribution.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.IMPALA,
@@ -16,5 +16,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.IMPALA, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/languages/mysql/mysql.contribution.ts b/src/languages/mysql/mysql.contribution.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.MYSQL,
@@ -16,5 +16,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.MYSQL, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/languages/pgsql/pgsql.contribution.ts b/src/languages/pgsql/pgsql.contribution.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.PG,
@@ -16,5 +16,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.PG, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/languages/spark/spark.contribution.ts b/src/languages/spark/spark.contribution.ts
@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.SPARK,
@@ -16,5 +16,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.SPARK, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/languages/trino/trino.contribution.ts b/src/languages/trino/trino.contribution.ts
@@ -1,6 +1,6 @@
 import { registerLanguage } from '../../_.contribution';
-import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 import { LanguageIdEnum } from '../../common/constants';
+import { setupLanguageFeatures } from '../../setupLanguageFeatures';
 
 registerLanguage({
 	id: LanguageIdEnum.TRINO,
@@ -11,5 +11,7 @@ registerLanguage({
 
 setupLanguageFeatures(LanguageIdEnum.TRINO, {
 	completionItems: true,
-	diagnostics: true
+	diagnostics: true,
+	references: true,
+	definitions: true
 });
diff --git a/src/monaco.contribution.ts b/src/monaco.contribution.ts
@@ -1,6 +1,7 @@
-import { languages, Emitter, IEvent, editor, Position, IRange } from './fillers/monaco-editor-core';
 import { EntityContext, Suggestions } from 'dt-sql-parser';
 
+import { editor, Emitter, IEvent, IRange, languages, Position } from './fillers/monaco-editor-core';
+
 /**
  * A completion item.
  * ICompletionItem is pretty much the same as {@link languages.CompletionItem},
@@ -65,7 +66,7 @@ export interface ModeConfiguration {
 	/**
 	 * Defines whether the built-in definitions provider is enabled.
 	 */
-	// readonly definitions?: boolean;
+	readonly definitions?: boolean;
 
 	/**
 	 * Defines whether the built-in rename provider is enabled.
@@ -75,7 +76,7 @@ export interface ModeConfiguration {
 	/**
 	 * Defines whether the built-in references provider is enabled.
 	 */
-	// readonly references?: boolean;
+	readonly references?: boolean;
 }
 
 /**
@@ -171,5 +172,7 @@ export const modeConfigurationDefault: Required<ModeConfiguration> = {
 		completionService: defaultCompletionService,
 		triggerCharacters: ['.', ' ']
 	},
-	diagnostics: true
+	diagnostics: true,
+	definitions: true,
+	references: true
 };
diff --git a/src/setupLanguageFeatures.ts b/src/setupLanguageFeatures.ts
@@ -1,13 +1,13 @@
+import { LanguageIdEnum } from './common/constants';
+import { IDisposable, languages } from './fillers/monaco-editor-core';
 import {
-	PreprocessCode,
+	CompletionOptions,
 	LanguageServiceDefaults,
 	LanguageServiceDefaultsImpl,
-	modeConfigurationDefault,
 	ModeConfiguration,
-	CompletionOptions
+	modeConfigurationDefault,
+	PreprocessCode
 } from './monaco.contribution';
-import { languages, IDisposable } from './fillers/monaco-editor-core';
-import { LanguageIdEnum } from './common/constants';
 
 export interface FeatureConfiguration {
 	/**
@@ -20,6 +20,14 @@ export interface FeatureConfiguration {
 	 * Defaults to true.
 	 */
 	diagnostics?: boolean;
+	/**
+	 * Defines whether the built-in definitions provider is enabled.
+	 */
+	definitions?: boolean;
+	/**
+	 * Defines whether the built-in references provider is enabled.
+	 */
+	references?: boolean;
 	/**
 	 * Define a function to preprocess code.
 	 * By default, do not something.
@@ -110,13 +118,23 @@ function processConfiguration(
 			? configuration.completionItems!.triggerCharacters
 			: (defaults?.modeConfiguration.completionItems.triggerCharacters ??
 				modeConfigurationDefault.completionItems.triggerCharacters);
+	const references =
+		typeof configuration.references === 'boolean'
+			? configuration.references
+			: (defaults?.modeConfiguration.references ?? modeConfigurationDefault.references);
+	const definitions =
+		typeof configuration.definitions === 'boolean'
+			? configuration.definitions
+			: (defaults?.modeConfiguration.definitions ?? modeConfigurationDefault.definitions);
 
 	return {
 		diagnostics,
 		completionItems: {
 			enable: completionEnable,
 			completionService,
 			triggerCharacters
-		}
+		},
+		references,
+		definitions
 	};
 }
diff --git a/src/setupLanguageMode.ts b/src/setupLanguageMode.ts
