Merge pull request #40 from agencia-e-plus/feat/completion

Feat: block completion inside `children`, `blocks` or capitalized prop

Author: Vavarine

server/src/BlocksHashMap.ts

@@ -1,86 +1,89 @@
-import { readFileSync } from "fs";
-import { glob } from "glob";
-import * as JSONC from "jsonc-parser";
+import { readFileSync } from 'fs';
+import { glob } from 'glob';
+import * as JSONC from 'jsonc-parser';
 
 export class BlocksHashMap {
-  private rootPath: string;
-  private blocksMap = new Map<string, string>();
-  private fileMap = new Map<string, string | Buffer>();
-  private fileUsagesMap = new Map<string, string[]>();
-
-  constructor(rootPath: string) {
-    this.rootPath = rootPath.replace(/\\/g, "/");
-    this.fillHashMap();
-  }
-
-  fillHashMap() {
-    const filesPaths = glob.sync(`${this.rootPath}/**/*.{json,jsonc}`);
-    const blocksFilesPaths = filesPaths.filter((filePath) =>
-      filePath.includes("blocks")
-    );
-
-    blocksFilesPaths.forEach((filePath) => this.mapBlocksOnFile(filePath));
-  }
-
-  mapBlocksOnFile(filePath: string, customText?: string) {
-    const fileContent = customText || readFileSync(filePath);
-
-    if (fileContent === "") return;
-
-    try {
-      const blocks: Record<string, BlockFormat> = JSONC.parse(
-        fileContent.toString()
-      );
-
-      Object.keys(blocks).forEach((blockName) => {
-        this.blocksMap.set(blockName, filePath);
-      });
-
-      this.fileMap.set(filePath, fileContent);
-      this.mapBlocksUsages(filePath, blocks);
-    } catch (error) {
-      console.log(`unable to parse file ${filePath}`);
-    }
-  }
-
-  mapBlocksUsages(filePath: string, blocks: Record<string, BlockFormat>) {
-    const usagesList = Object.values(blocks)
-      .map((value) => {
-        const { children = [], blocks = [] } = value;
-
-        const propsBlocks = Object.entries(value?.props ?? {}).reduce(
-          (acc, [propKey, propValue]) => {
-            if (propKey.match(/^[A-Z]/)) return [...acc, propValue];
-            return acc;
-          },
-          [] as string[]
-        );
-
-        return [...children, ...blocks, ...propsBlocks];
-      })
-      .flat();
-
-    this.fileUsagesMap.set(filePath, usagesList);
-  }
-
-  getBlockFilePath(blockName: string) {
-    return this.blocksMap.get(blockName) as string;
-  }
-
-  getFileContent(filePath: string) {
-    return this.fileMap.get(filePath) as string;
-  }
-
-  listBlocks() {
-    return this.blocksMap.entries();
-  }
-
-  getBlockUsage(blockName: string) {
-    const allUsedBlocks = Array.from(this.fileUsagesMap.values()).flat();
-    return allUsedBlocks.some((blockUsage) => blockUsage === blockName);
-  }
-
-  getFileUsage(filePath: string) {
-    return this.fileUsagesMap.get(filePath);
-  }
+	private rootPath: string;
+	private blocksMap = new Map<string, string>();
+	private fileMap = new Map<string, string | Buffer>();
+	private fileUsagesMap = new Map<string, string[]>();
+
+	constructor(rootPath: string) {
+		this.rootPath = rootPath.replace(/\\/g, '/');
+		this.fillHashMap();
+	}
+
+	fillHashMap() {
+		const filesPaths = glob.sync(`${this.rootPath}/**/*.{json,jsonc}`);
+		const blocksFilesPaths = filesPaths.filter((filePath) => filePath.includes('blocks'));
+
+		blocksFilesPaths.forEach((filePath) => this.mapBlocksOnFile(filePath));
+	}
+
+	mapBlocksOnFile(filePath: string, customText?: string) {
+		const fileContent = customText || readFileSync(filePath);
+
+		if (fileContent === '') return;
+
+		try {
+			const blocks: Record<string, BlockFormat> = JSONC.parse(fileContent.toString());
+
+			Object.keys(blocks).forEach((blockName) => {
+				this.blocksMap.set(blockName, filePath);
+			});
+
+			this.fileMap.set(filePath, fileContent);
+			this.mapBlocksUsages(filePath, blocks);
+		} catch (error) {
+			console.log(`unable to parse file ${filePath}`);
+		}
+	}
+
+	mapBlocksUsages(filePath: string, blocks: Record<string, BlockFormat>) {
+		const usagesList = Object.values(blocks)
+			.map((value) => {
+				const { children = [], blocks = [] } = value;
+
+				const propsBlocks = Object.entries(value?.props ?? {}).reduce(
+					(acc, [propKey, propValue]) => {
+						if (propKey.match(/^[A-Z]/)) return [...acc, propValue];
+						return acc;
+					},
+					[] as string[]
+				);
+
+				return [...children, ...blocks, ...propsBlocks];
+			})
+			.flat();
+
+		this.fileUsagesMap.set(filePath, usagesList);
+	}
+
+	getBlockFilePath(blockName: string) {
+		return this.blocksMap.get(blockName) as string;
+	}
+
+	getFileContent(filePath: string) {
+		return this.fileMap.get(filePath) as string;
+	}
+
+	listBlocks() {
+		return this.blocksMap.entries();
+	}
+
+	getBlockUsage(blockName: string) {
+		const allUsedBlocks = Array.from(this.fileUsagesMap.values()).flat();
+		return allUsedBlocks.some((blockUsage) => blockUsage === blockName);
+	}
+
+	getBlockContent(blockName: string) {
+		const filePath = this.getBlockFilePath(blockName);
+		const fileContent = this.getFileContent(filePath);
+		const blocks = JSONC.parse(fileContent.toString());
+		return blocks[blockName];
+	}
+
+	getFileUsage(filePath: string) {
+		return this.fileUsagesMap.get(filePath);
+	}
 }

server/src/handleCompletionResolve.ts

@@ -0,0 +1,25 @@
+import { CompletionItem, MarkupKind } from 'vscode-languageserver';
+import { BlocksHashMap } from './BlocksHashMap';
+
+/**
+ * Resolves additional information for a completion item when it's focused
+ */
+export function handleCompletionResolve(
+	item: CompletionItem,
+	blocksHashMap: BlocksHashMap
+): CompletionItem {
+	// Check if this is a block suggestion that needs documentation
+	if (item.data && typeof item.data === 'string') {
+		const blockKey = item.data;
+		// Only fetch and add documentation when resolving
+		item.documentation = {
+			kind: MarkupKind.Markdown,
+			value: `\`\`\`json\n// ${blockKey}\n${JSON.stringify(
+				blocksHashMap.getBlockContent(blockKey),
+				null,
+				2
+			)}\n\`\`\``
+		};
+	}
+	return item;
+}