Merge pull request #126 from mghdotdev/feature/fragment-document-linking

Feature/fragment document linking

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Miva IDE CHANGELOG
 
-## v1.24.0 (latest)
+## v1.25.0 (latest)
+
+* Added document linking for `<mvt:fragment />` tags.
+
+## v1.24.0
 
 * Added `<mvt:fragment />` tag snippet and syntax support.
 * Added Miva Merchant 10.10.00 LSK data.

package.json

@@ -2,7 +2,7 @@
 	"name": "vscode-miva-ide",
 	"displayName": "Miva IDE",
 	"description": "Syntax highlighting, snippets and tools for building websites with Miva.",
-	"version": "1.24.0",
+	"version": "1.25.0",
 	"engines": {
 		"vscode": "^1.77.0",
 		"node": ">=16"

server/src/miva-features.ts

@@ -61,6 +61,7 @@ import {
 	ActivationProviders,
 	LanguageFeatures,
 	MivaScriptFunction,
+	MivaTemplateLanguageParsedFragment,
 	MivaTemplateLanguageParsedItem,
 	MvLanguageModel,
 	MvtLanguageModel,
@@ -191,6 +192,7 @@ export function activateFeatures({workspaceSymbolProvider, mivaScriptCompilerPro
 		const parseMvtDocument = ( document: TextDocument ) => {
 			const symbols: SymbolInformationWithDocumentation[] = [];
 			const parsedItems: MivaTemplateLanguageParsedItem[] = [];
+			const parsedFragments: MivaTemplateLanguageParsedFragment[] = [];
 
 			const scanner = htmlLanguageService.createScanner( document.getText(), 0 );
 			let token = scanner.scan();
@@ -282,6 +284,14 @@ export function activateFeatures({workspaceSymbolProvider, mivaScriptCompilerPro
 								});
 							}
 						}
+						else if ( lastTagName === 'mvt:fragment' ) {
+							if (lastAttributeName === 'code') {
+								parsedFragments.push({
+									code: attributeValue,
+									range: range
+								});
+							}
+						}
 						break;
 
 					case TokenType.StartTagSelfClose:
@@ -304,7 +314,8 @@ export function activateFeatures({workspaceSymbolProvider, mivaScriptCompilerPro
 
 			return {
 				symbols,
-				parsedItems
+				parsedItems,
+				parsedFragments
 			};
 		};
 
@@ -326,12 +337,13 @@ export function activateFeatures({workspaceSymbolProvider, mivaScriptCompilerPro
 		};
 
 		const mvtDocuments = getLanguageModelCache<MvtLanguageModel>( 10, 60, (document: TextDocument) => {
-			const {symbols, parsedItems} = parseMvtDocument( document );
+			const {symbols, parsedItems, parsedFragments} = parseMvtDocument( document );
 
 			return {
 				symbols,
 				document,
-				parsedItems
+				parsedItems,
+				parsedFragments
 			};
 		});
 
@@ -865,9 +877,9 @@ export function activateFeatures({workspaceSymbolProvider, mivaScriptCompilerPro
 					return [];
 				}
 
-				const {parsedItems} = mvtDocuments.get( document );
+				const {parsedItems, parsedFragments} = mvtDocuments.get( document );
 
-				const links = (await mivaManagedTemplatesProvider.provideLinks(parsedItems, document)) ?? [];
+				const links = (await mivaManagedTemplatesProvider.provideLinks(parsedItems, parsedFragments, document)) ?? [];
 
 				return links;
 			}

server/src/mvt/miva-managed-templates-provider/miva-managed-templates-provider.ts

@@ -4,7 +4,7 @@ import { TextDocument } from 'vscode-languageserver-textdocument';
 import { URI, Utils } from 'vscode-uri';
 import { uriToFsPath } from '../../util/functions';
 import { fileIsInFolder, walk } from '../../util/functions-node';
-import { MivaTemplateLanguageParsedItem, Workspace } from '../../util/interfaces';
+import { MivaTemplateLanguageParsedFragment, MivaTemplateLanguageParsedItem, Workspace } from '../../util/interfaces';
 
 export class MivaMangedTemplatesProvider {
 	private mmtPaths: Set<string> = new Set();
@@ -43,7 +43,7 @@ export class MivaMangedTemplatesProvider {
 		return relativePath?.split(new RegExp(sep, 'g'));
 	}
 
-	async provideLinks (parsedItems: MivaTemplateLanguageParsedItem[], document: TextDocument): Promise<DocumentLink[]> {
+	async provideLinks (parsedItems: MivaTemplateLanguageParsedItem[], parsedFragments: MivaTemplateLanguageParsedFragment[], document: TextDocument): Promise<DocumentLink[]> {
 		const documentPath = uriToFsPath(document.uri);
 		const mmtPath = this.getPath(documentPath);
 		if (!mmtPath) {
@@ -269,7 +269,19 @@ export class MivaMangedTemplatesProvider {
 					break;
 				}
 		}
-	}
+		}
+
+		for (let parsedFragment of parsedFragments) {
+			const codeLower = parsedFragment.code.toLowerCase();
+
+			const relativePath = `./templates/${codeLower}.mvt`;
+			const target = this.getTargetFromRelativePath(relativePath, mmtPath);
+
+			links.push({
+				range: parsedFragment.range,
+				target
+			});
+		}
 
 		return links;
 	}

server/src/util/interfaces.ts

@@ -81,6 +81,7 @@ export interface MvtLanguageModel {
 	symbols: SymbolInformationWithDocumentation[];
 	document: TextDocument;
 	parsedItems: MivaTemplateLanguageParsedItem[];
+	parsedFragments: MivaTemplateLanguageParsedFragment[];
 }
 
 
@@ -283,4 +284,9 @@ export interface MivaTemplateLanguageParsedItem {
 	param?: string;
 	expression?: MivaExpression;
 	range?: Range;
-};
+};
+
+export interface MivaTemplateLanguageParsedFragment {
+	code: string;
+	range: Range;
+}