Try support vim (#46)

* wip: try support vim

* refactor: enhance document handling in lsp-server

- Removed middleware from client options in lsp-client for cleaner code.
- Introduced DocumentStore class in lsp-server to manage document operations, including fallback methods for file reading and bean file listing.
- Updated startServer function to utilize the new DocumentStore, improving document management in both browser and node environments.
- Added support for reading files and listing bean files in the Node environment using fast-glob and fs/promises.

* fix: custom capabilities

* feat: trigger index without QueueInit message

* fix: correct configuration property name in DocumentStore

- Updated references from 'manBeanFile' to 'mainBeanFile' in the DocumentStore class to ensure proper configuration handling.
- Adjusted warning message to reflect the correct property name for user guidance.

* chore: bump lsp-client version to 0.0.62

* chore: update changelog

Author: fengkx

packages/lsp-client/src/browser/extension.ts

@@ -32,11 +32,6 @@ export function activate(context: vscode.ExtensionContext): void {
 	statusBarItem.show();
 	context.subscriptions.push(statusBarItem);
 
-	// Show notification that this is experimental
-	vscode.window.showInformationMessage(
-		'Beancount LSP browser extension is experimental and might have limited functionality compared to the desktop version.',
-	);
-
 	try {
 		// Resolve the web-tree-sitter.wasm path
 		const webTreeSitterWasmPath = resolveWebTreeSitterWasmPath(context);

packages/lsp-client/src/common/client.ts

@@ -1,7 +1,8 @@
 import { CustomMessages, Logger, logLevelToString, mapTraceServerToLogLevel } from '@bean-lsp/shared';
 import * as vscode from 'vscode';
 // Import from base package for shared types between node and browser
-import { LanguageClientOptions, State } from 'vscode-languageclient';
+import type { InitializeParams, LanguageClientOptions, ProtocolConnection } from 'vscode-languageclient';
+import { State } from 'vscode-languageclient';
 import { Utils as UriUtils } from 'vscode-uri';
 import { tools } from './llm/tools';
 import { ClientOptions, ExtensionContext } from './types';
@@ -223,6 +224,17 @@ export function setupStatusBar(ctx: ExtensionContext<'browser' | 'node'>): void
  * Sets up custom message handlers for the client
  */
 export function setupCustomMessageHandlers(ctx: ExtensionContext<'browser' | 'node'>): void {
+	const originalInitialize = ctx.client['doInitialize'].bind(ctx.client);
+	ctx.client['doInitialize'] = async (connection: ProtocolConnection, params: InitializeParams) => {
+		console.log('===== doInitialize', params);
+		// @ts-expect-error customMessage is not part of the protocol
+		params.capabilities['customMessage'] = {
+			[CustomMessages.ListBeanFile]: true,
+			[CustomMessages.FileRead]: true,
+		};
+		return originalInitialize(connection, params);
+	};
+
 	ctx.client.onRequest(CustomMessages.ListBeanFile, async () => {
 		const exclude = await generateExcludePattern();
 		const files = await vscode.workspace.findFiles('**/*.{bean,beancount}', exclude);

packages/lsp-server/src/browser/server.ts

@@ -5,6 +5,7 @@ import {
 	ProposedFeatures,
 } from 'vscode-languageserver/browser';
 
+import { DocumentStore } from 'src/common/document-store';
 import { ServerOptions, startServer } from '../common/startServer';
 import { factory } from './storage';
 
@@ -16,10 +17,13 @@ const messageWriter = new BrowserMessageWriter(self);
 const connection = createConnection(ProposedFeatures.all, messageReader, messageWriter);
 
 // Server options - will be populated by the initialization options in startServer
-const serverOptions: ServerOptions = {};
+const serverOptions: ServerOptions = {
+	isBrowser: true,
+};
 
+const documents = new DocumentStore(connection);
 // Start the server with the options
-startServer(connection, factory, undefined, serverOptions);
+startServer(connection, factory, documents, undefined, serverOptions);
 
 // Listen on the connection
 connection.listen();

packages/lsp-server/src/common/document-store.ts

@@ -4,9 +4,11 @@ import {
 	Connection,
 	Emitter,
 	Event,
+	InitializeParams,
 	Range,
 	TextDocumentContentChangeEvent,
 	TextDocuments,
+	WorkspaceFolder,
 } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { URI, Utils as UriUtils } from 'vscode-uri';
@@ -29,10 +31,13 @@ export class DocumentStore extends TextDocuments<TextDocument> {
 	readonly onDidChangeContent2: Event<TextDocumentChange2> = this._onDidChangeContent2.event;
 
 	private _beanFiles: string[] = [];
+	private _initializeParams: InitializeParams | undefined;
 
 	private logger = new Logger('DocumentStore');
 
-	constructor(private readonly _connection: Connection) {
+	constructor(
+		private readonly _connection: Connection,
+	) {
 		super({
 			create: TextDocument.create,
 			update: (doc, changes, version) => {
@@ -61,13 +66,34 @@ export class DocumentStore extends TextDocuments<TextDocument> {
 		});
 		this.listen(_connection);
 	}
+
+	public setInitializeParams(initializeParams: InitializeParams) {
+		this._initializeParams = initializeParams;
+	}
+
 	private readonly _documentsCache = new LRUMap<string, TextDocument>(200);
 
 	async refetchBeanFiles(): Promise<void> {
+		// Check if client supports ListBeanFile capability
+		// @ts-expect-error customMessage is not part of the protocol
+		if (!this._initializeParams?.capabilities?.customMessage?.[CustomMessages.ListBeanFile]) {
+			if (!this._initializeParams?.workspaceFolders?.[0]) {
+				this._beanFiles = [];
+				return;
+			}
+			this._beanFiles = await this.fallbackListBeanFiles(this._initializeParams.workspaceFolders[0]);
+			return;
+		}
+
 		const files = await this._connection.sendRequest<string[]>(CustomMessages.ListBeanFile);
 		this._beanFiles = files;
 	}
 
+	protected async fallbackListBeanFiles(_workspaceFolder: WorkspaceFolder): Promise<string[]> {
+		this.logger.warn('Client does not support ListBeanFile capability');
+		return this.all().map(doc => doc.uri);
+	}
+
 	get beanFiles(): string[] {
 		return this._beanFiles;
 	}
@@ -92,11 +118,25 @@ export class DocumentStore extends TextDocuments<TextDocument> {
 	}
 
 	private async _requestDocument(uri: string): Promise<TextDocument> {
-		const reply = await this._connection.sendRequest<number[]>(CustomMessages.FileRead, uri);
+		const reply = await this.fileRead(uri);
 		const bytes = new Uint8Array(reply);
 		return TextDocument.create(uri, LANGUAGE_ID, 1, this._decoder.decode(bytes));
 	}
 
+	private async fileRead(uri: string): Promise<ArrayBuffer> {
+		// Check if client supports FileRead capability
+		// @ts-expect-error customMessage is not part of the protocol
+		if (!this._initializeParams?.capabilities?.customMessage?.[CustomMessages.FileRead]) {
+			return this.fallbackFileRead(uri);
+		}
+		return this._connection.sendRequest<ArrayBuffer>(CustomMessages.FileRead, uri);
+	}
+
+	protected async fallbackFileRead(_uri: string): Promise<ArrayBuffer> {
+		this.logger.warn('Client does not support FileRead capability');
+		return new ArrayBuffer(0);
+	}
+
 	removeFile(uri: string): boolean {
 		return this._documentsCache.delete(uri);
 	}

packages/lsp-server/src/common/features/types.ts

@@ -35,3 +35,8 @@ export interface RealBeancountManager {
 }
 
 export type BeancountManagerFactory = (connection: Connection, extensionUri: string) => RealBeancountManager;
+
+export interface PlatformMethods {
+	findBeanFiles: () => Promise<string[]>;
+	readFile: (uri: string) => Promise<string>;
+}

packages/lsp-server/src/common/startServer.ts

@@ -43,6 +43,8 @@ export interface IStorageFactory<T> {
 export interface ServerOptions {
 	webTreeSitterWasmPath?: string;
 	logLevel?: LogLevel;
+
+	isBrowser: boolean;
 }
 
 // Create a server logger
@@ -51,8 +53,9 @@ const serverLogger = new Logger('Server');
 export function startServer(
 	connection: Connection,
 	factory: IStorageFactory<unknown>,
+	documents: DocumentStore,
 	beanMgrFactory: BeancountManagerFactory | undefined,
-	options: ServerOptions = {},
+	options: ServerOptions,
 ): void {
 	// Set initial log level from options
 	if (options.logLevel !== undefined) {
@@ -72,11 +75,11 @@ export function startServer(
 
 	const features: Feature[] = [];
 
-	let documents: DocumentStore;
 	let symbolIndex: SymbolIndex;
 	let beanMgr: RealBeancountManager | undefined;
 
 	connection.onInitialize(async (params: InitializeParams): Promise<InitializeResult> => {
+		documents.setInitializeParams(params);
 		const result: InitializeResult = {
 			capabilities: {
 				textDocumentSync: TextDocumentSyncKind.Incremental,
@@ -130,7 +133,6 @@ export function startServer(
 		await symbolStorage.autoloadPromise;
 		connection.onExit(() => factory.destroy(symbolStorage));
 
-		documents = new DocumentStore(connection);
 		const trees = new Trees(documents, options.webTreeSitterWasmPath!);
 		const optionsManager = BeancountOptionsManager.getInstance();
 		const historyContext = new HistoryContext(trees);
@@ -204,6 +206,8 @@ export function startServer(
 		const mainBeanFile = await documents.getMainBeanFileUri();
 		serverLogger.info(`mainBeanFile ${mainBeanFile}`);
 		await documents.refetchBeanFiles();
+		await symbolIndex.initFiles(documents.beanFiles);
+		await symbolIndex.unleashFiles([]);
 
 		if (mainBeanFile) {
 			await symbolIndex.initFiles([mainBeanFile]);

packages/lsp-server/src/node/beancount-manager.ts

@@ -1,14 +1,14 @@
 import { Logger } from '@bean-lsp/shared';
 import { $, execa } from 'execa';
+import { Connection, DidSaveTextDocumentParams } from 'vscode-languageserver';
+import { URI } from 'vscode-uri';
 import {
 	Amount,
 	BeancountError,
 	BeancountFlag,
 	BeancountManagerFactory,
 	RealBeancountManager,
-} from 'src/common/features/types';
-import { Connection, DidSaveTextDocumentParams } from 'vscode-languageserver';
-import { URI } from 'vscode-uri';
+} from '../common/features/types';
 import { globalEventBus, GlobalEvents } from '../common/utils/event-bus';
 
 interface AccountDetails {

packages/lsp-server/src/node/server.ts

@@ -1,18 +1,42 @@
+import { glob } from 'fast-glob';
+import { readFile } from 'fs/promises';
+import { DocumentStore } from 'src/common/document-store';
+import { pathToFileURL } from 'url';
 import { createConnection, ProposedFeatures } from 'vscode-languageserver/node';
-
+import { URI } from 'vscode-uri';
 import { ServerOptions, startServer } from '../common/startServer';
 import { beananagerFactory } from './beancount-manager';
 import { factory } from './storage';
 
+class DocumentStoreInNode extends DocumentStore {
+	protected override async fallbackListBeanFiles(workspaceFolder: { uri: string }): Promise<string[]> {
+		const workspacePath = URI.parse(workspaceFolder.uri).fsPath;
+		const files = await glob('**/*.{bean,beancount}', {
+			cwd: workspacePath,
+			ignore: ['.venv/**', '**/*.log', '**/*.tmp', '**/*.tmp.*', '**/*.tmp.*.*', '**/*.pyc'],
+			absolute: true,
+		});
+		return files.map((p) => pathToFileURL(p).toString());
+	}
+
+	protected override async fallbackFileRead(uri: string): Promise<ArrayBuffer> {
+		const buffer = await readFile(new URL(uri));
+		return new Uint8Array(buffer);
+	}
+}
+
 // Create a connection for the server, using Node's IPC as a transport.
 // Also include all preview / proposed LSP features.
 const connection = createConnection(ProposedFeatures.all);
 
 // Server options - will be populated by the initialization options in startServer
-const serverOptions: ServerOptions = {};
+const serverOptions: ServerOptions = {
+	isBrowser: false,
+};
 
+const documents = new DocumentStoreInNode(connection);
 // Start the server with the options
-startServer(connection, factory, beananagerFactory, serverOptions);
+startServer(connection, factory, documents, beananagerFactory, serverOptions);
 
 // Listen on the connection
 connection.listen();

packages/lsp-server/tsup.config.ts

@@ -35,6 +35,7 @@ const nodeConfig = defineConfig({
 	noExternal: [
 		...commonConfig.noExternal,
 		'execa',
+		'fast-glob',
 	],
 });