ace-linters 1.8.0 → 1.8.3

package/README.md

@@ -28,6 +28,41 @@ languageProvider.registerEditor(editor);
 
 [Example webworker.js with all services](https://github.com/mkslanc/ace-linters/blob/main/packages/demo/webworker-lsp/webworker.ts)
 
+## New features in 1.8.1
+- add `manualSessionControl` provider option to disable automatic session registration. When enabled, you must manually handle session changes:
+```javascript
+// Create provider with manual session control
+let languageProvider = LanguageProvider.create(worker, {
+  manualSessionControl: true
+});
+
+// Register sessions manually
+languageProvider.registerSession(editor.session, editor, {
+  filePath: 'path/to/file.ts',
+  joinWorkspaceURI: true
+});
+
+// Handle session changes manually
+editor.on("changeSession", ({session}) => {
+  languageProvider.registerSession(session, editor, session.lspConfig);
+});
+```
+- add `setSessionLspConfig` method to set LSP configuration on Ace sessions:
+```javascript
+// Set LSP configuration on session
+languageProvider.setSessionLspConfig(editor.session, {
+    filePath: 'src/components/MyComponent.tsx',
+    joinWorkspaceURI: true
+});
+```
+- add `setDocumentOptions` method to replace deprecated `setSessionOptions`:
+```javascript
+// Configure document-specific options (replaces setSessionOptions)
+languageProvider.setDocumentOptions(editor.session, {
+    // service-specific options here
+});
+```
+
 ## New Features in 1.2.0
 - add `setProviderOptions` method to `LanguageProvider` to set options for client.
 - add experimental semantic tokens support (turned off by default). To turn on semantic tokens, set `semanticTokens` to

package/build/ace-language-client.d.ts

@@ -596,14 +596,22 @@ export interface ProviderOptions {
 		"CommandBarTooltip"?: typeof CommandBarTooltip;
 		"CompletionProvider"?: typeof CompletionProvider;
 	};
+	/**
+	 * When true, disables automatic session registration on editor session changes.
+	 * Users must manually call registerSession() and handle session change events themselves.
+	 * @default false
+	 */
+	manualSessionControl?: boolean;
 }
-export interface SessionInitialConfig {
+export interface SessionLspConfig {
 	/**
-	 * The associated file path for the session
+	 * Absolute or relative path of the file for the session
 	 */
 	filePath: string;
 	/**
-	 * Determines if the editor should join the workspace URI
+	 * When `true` the given path is treated as relative and will be joined with
+	 * the workspace’s root URI to form the final canonical URI. When false (or omitted) filePath is just transformed to
+	 * URI.
 	 * @default `false`
 	 */
 	joinWorkspaceURI?: boolean;
@@ -758,7 +766,7 @@ declare class SessionLanguageProvider {
 	 * @param messageController - The `IMessageController` instance for handling messages.
 	 * @param config
 	 */
-	constructor(provider: LanguageProvider, session: Ace.EditSession, editor: Ace.Editor, messageController: IMessageController, config?: SessionInitialConfig);
+	constructor(provider: LanguageProvider, session: Ace.EditSession, editor: Ace.Editor, messageController: IMessageController, config?: SessionLspConfig);
 	enqueueIfNotConnected(callback: () => void): void;
 	get comboDocumentIdentifier(): ComboDocumentIdentifier;
 	/**
@@ -766,7 +774,9 @@ declare class SessionLanguageProvider {
 	 * Increments the document version and updates the internal document URI and identifier.
 	 *
 	 * @param {string} filePath - The new file path for the document.
-	 * @param {boolean} [joinWorkspaceURI] - Optional flag to indicate whether to join the file path with the workspace URI.
+	 * @param {boolean} [joinWorkspaceURI] - when true the given path is treated as relative and will be joined with
+	 * the workspace’s root URI to form the final canonical URI. When false (or omitted) filePath is just transformed to
+	 * URI.
 	 */
 	setFilePath(filePath: string, joinWorkspaceURI?: boolean): void;
 	private $init;
@@ -845,8 +855,25 @@ declare class LanguageProvider {
 	 * @param session The Ace edit session to update with the file path.
 	 * @param config config to set
 	 */
-	setSessionFilePath(session: Ace.EditSession, config: SessionInitialConfig): void;
-	private $registerSession;
+	setSessionFilePath(session: Ace.EditSession, config: SessionLspConfig): void;
+	/**
+	 * Registers a new editing session with the editor and associates it with a language provider.
+	 * If a language provider for the specified editing session does not already exist, it initializes
+	 * and stores a new session-specific language provider.
+	 *
+	 * @param session - The Ace EditSession object to be registered, representing a specific editing session.
+	 * @param editor - The Ace Editor instance associated with the editing session.
+	 * @param [config] - An optional configuration object for initializing the session.
+	 */
+	registerSession: (session: Ace.EditSession, editor: Ace.Editor, config?: SessionLspConfig) => void;
+	/**
+	 * Sets the Language Server Protocol (LSP) configuration for the given session.
+	 *
+	 * @param session - The editor session to which the LSP configuration will be applied.
+	 * @param config - The LSP configuration to set for the session.
+	 * @return The updated editor session with the applied LSP configuration.
+	 */
+	setSessionLspConfig(session: Ace.EditSession, config: SessionLspConfig): import("ace-code").EditSession;
 	private $getSessionLanguageProvider;
 	private $getFileName;
 	/**
@@ -855,7 +882,7 @@ declare class LanguageProvider {
 	 * @param editor - The Ace editor instance to be registered.
 	 * @param [config] - Configuration options for the session.
 	 */
-	registerEditor(editor: Ace.Editor, config?: SessionInitialConfig): void;
+	registerEditor(editor: Ace.Editor, config?: SessionLspConfig): void;
 	codeActionCallback: (codeActions: CodeActionsByService[]) => void;
 	/**
 	 * Sets a callback function that will be triggered with an array of code actions grouped by service.
@@ -872,11 +899,19 @@ declare class LanguageProvider {
 	private createErrorNode;
 	private setStyles;
 	/**
-	 * Sets global options for the specified service.
+	 * Configures global options that apply to all documents handled by the specified language service.
+	 *
+	 * Global options serve as default settings for all documents processed by a service when no
+	 * document-specific options are provided. These options affect language service behavior across
+	 * the entire workspace, including validation rules, formatting preferences, completion settings,
+	 * and service-specific configurations.
 	 *
-	 * @param serviceName - The name of the service for which to set global options.
-	 * @param options - The options to set for the specified service.
-	 * @param {boolean} [merge=false] - Indicates whether to merge the provided options with the existing options. Defaults to false.
+	 * @param serviceName - The identifier of the language service to configure. Must be a valid
+	 *                      service name from the supported services (e.g., 'typescript', 'json', 'html').
+	 * @param options - The global configuration options specific to the language service. The structure
+	 *                  varies by service type.
+	 * @param {boolean} [merge=false] - Indicates whether to merge the provided options with the existing options.
+	 *                  Defaults to false.
 	 */
 	setGlobalOptions<T extends keyof ServiceOptionsMap>(serviceName: T & string, options: ServiceOptionsMap[T], merge?: boolean): void;
 	/**
@@ -895,8 +930,17 @@ declare class LanguageProvider {
 	 *
 	 * @param session - The Ace editor session to configure.
 	 * @param options - The configuration options to be applied to the session.
+	 * @deprecated Use `setDocumentOptions` instead. This method will be removed in the future.
 	 */
 	setSessionOptions<OptionsType extends ServiceOptions>(session: Ace.EditSession, options: OptionsType): void;
+	/**
+	 * Sets configuration options for a document associated with the specified editor session.
+	 *
+	 * @param session - The Ace editor session representing the document to configure.
+	 * @param options - The service options to apply. The exact shape depends on the language services
+	 *                  active for this session (e.g. JSON schema settings).
+	 */
+	setDocumentOptions<OptionsType extends ServiceOptions>(session: Ace.EditSession, options: OptionsType): void;
 	/**
 	 * Configures the specified features for a given service.
 	 *