refactor: rename textDocument/decoration{s => } (singular not plural)

This is for consistency with other CXP methods (most of which are singular). The textDocument/publishDecorations notification should remain plural for consistency with textDocument/publishDiagnostics.

BREAKING CHANGE: The CXP method textDocument/decorations was renamed to textDocument/decoration. This package's API types related to the method also changed names.

Author: sqs

examples/client/example-client-simple.ts

@@ -2,7 +2,7 @@ import * as NodeWebSocket from 'ws'
 import { createMessageConnection } from '../../src/jsonrpc2/connection'
 import { createWebSocketMessageTransports } from '../../src/jsonrpc2/transports/nodeWebSocket'
 import { InitializeParams, InitializeRequest, InitializeResult } from '../../src/protocol'
-import { TextDocumentDecorationsParams, TextDocumentDecorationsRequest } from '../../src/protocol/decoration'
+import { TextDocumentDecorationParams, TextDocumentDecorationRequest } from '../../src/protocol/decoration'
 import config from './config'
 
 async function run(): Promise<void> {
@@ -22,7 +22,7 @@ async function run(): Promise<void> {
         const initResult: InitializeResult = await connection.sendRequest(InitializeRequest.type, {
             root: config.root,
             initializationOptions: config.initializationOptions,
-            capabilities: { decorations: { static: true } },
+            capabilities: { decoration: { static: true } },
         } as InitializeParams)
         console.log('Initialized:', initResult)
     } catch (err) {
@@ -43,9 +43,9 @@ async function run(): Promise<void> {
 
     console.log('textDocument/decorations...')
     try {
-        const result = await connection.sendRequest(TextDocumentDecorationsRequest.type, {
+        const result = await connection.sendRequest(TextDocumentDecorationRequest.type, {
             textDocument: { uri: `${config.root}#mux.go` },
-        } as TextDocumentDecorationsParams)
+        } as TextDocumentDecorationParams)
         console.log('textDocument/decorations result:', result)
     } catch (err) {
         console.error('textDocument/decorations failed:', err.message)

examples/client/example-client.ts

@@ -2,13 +2,13 @@ import { BehaviorSubject } from 'rxjs'
 import { filter } from 'rxjs/operators'
 import * as WebSocket from 'ws'
 import { Client, ClientState } from '../../src/client/client'
-import { TextDocumentStaticDecorationsFeature } from '../../src/client/features/decoration'
+import { TextDocumentStaticDecorationFeature } from '../../src/client/features/decoration'
 import { TextDocumentHoverFeature } from '../../src/client/features/hover'
 import { TextDocumentDidOpenFeature } from '../../src/client/features/textDocument'
 import { createObservableEnvironment, EMPTY_ENVIRONMENT, Environment } from '../../src/environment/environment'
 import { NoopProviderRegistry } from '../../src/environment/providers/textDocument'
 import { createWebSocketMessageTransports } from '../../src/jsonrpc2/transports/nodeWebSocket'
-import { TextDocumentDecorationsParams, TextDocumentDecorationsRequest } from '../../src/protocol/decoration'
+import { TextDocumentDecorationParams, TextDocumentDecorationRequest } from '../../src/protocol/decoration'
 import config from './config'
 
 const environment = new BehaviorSubject<Environment>(EMPTY_ENVIRONMENT)
@@ -27,7 +27,7 @@ const client = new Client('', '', {
 })
 client.registerFeature(new TextDocumentDidOpenFeature(client))
 client.registerFeature(new TextDocumentHoverFeature(client, new NoopProviderRegistry()))
-client.registerFeature(new TextDocumentStaticDecorationsFeature(client, new NoopProviderRegistry()))
+client.registerFeature(new TextDocumentStaticDecorationFeature(client, new NoopProviderRegistry()))
 client.state.subscribe(state => console.log('Client state:', ClientState[state]))
 client.start()
 const onReady = client.state.pipe(filter(state => state === ClientState.Running))
@@ -46,9 +46,9 @@ async function run(): Promise<void> {
 
     console.log('textDocument/decorations...')
     try {
-        const result = await client.sendRequest(TextDocumentDecorationsRequest.type, {
+        const result = await client.sendRequest(TextDocumentDecorationRequest.type, {
             textDocument: { uri: `${config.root}#mux.go` },
-        } as TextDocumentDecorationsParams)
+        } as TextDocumentDecorationParams)
         console.log('textDocument/decorations result:', result)
     } catch (err) {
         console.error('textDocument/decorations failed:', err.message)

examples/server/example-server-node.ts

@@ -4,7 +4,7 @@ import * as WebSocket from 'ws'
 import { createWebSocketMessageTransports } from '../../src/jsonrpc2/transports/nodeWebSocket'
 import { StreamMessageReader, StreamMessageWriter } from '../../src/jsonrpc2/transports/stream'
 import { InitializeResult } from '../../src/protocol'
-import { TextDocumentDecoration, TextDocumentDecorationsParams } from '../../src/protocol/decoration'
+import { TextDocumentDecoration, TextDocumentDecorationParams } from '../../src/protocol/decoration'
 import { Connection, createConnection } from '../../src/server/server'
 
 function register(connection: Connection): void {
@@ -16,8 +16,8 @@ function register(connection: Connection): void {
     )
 
     connection.onRequest(
-        'textDocument/decorations',
-        (params: TextDocumentDecorationsParams): TextDocumentDecoration[] =>
+        'textDocument/decoration',
+        (params: TextDocumentDecorationParams): TextDocumentDecoration[] =>
             ['cyan', 'magenta', 'yellow', 'black'].map(
                 (color, i) =>
                     ({

examples/server/example-server-webworker.ts

@@ -1,6 +1,6 @@
 import { createWebWorkerMessageTransports, Worker } from '../../src/jsonrpc2/transports/webWorker'
 import { InitializeResult } from '../../src/protocol'
-import { TextDocumentDecoration, TextDocumentDecorationsParams } from '../../src/protocol/decoration'
+import { TextDocumentDecoration, TextDocumentDecorationParams } from '../../src/protocol/decoration'
 import { Connection, createConnection } from '../../src/server/server'
 
 declare var self: Worker
@@ -9,13 +9,13 @@ function register(connection: Connection): void {
     connection.onInitialize(
         params =>
             ({
-                capabilities: { decorationsProvider: { static: true } },
+                capabilities: { decorationProvider: { static: true } },
             } as InitializeResult)
     )
 
     connection.onRequest(
-        'textDocument/decorations',
-        (params: TextDocumentDecorationsParams): TextDocumentDecoration[] =>
+        'textDocument/decoration',
+        (params: TextDocumentDecorationParams): TextDocumentDecoration[] =>
             ['cyan', 'magenta', 'yellow', 'black', 'cyan', 'magenta', 'yellow', 'black'].map(
                 (color, i) =>
                     ({

src/client/features/decoration.ts

@@ -1,13 +1,13 @@
 import { BehaviorSubject, from, Observable, TeardownLogic } from 'rxjs'
 import * as uuidv4 from 'uuid/v4'
 import { TextDocumentIdentifier } from 'vscode-languageserver-types'
-import { ProvideTextDocumentDecorationsSignature } from '../../environment/providers/decoration'
+import { ProvideTextDocumentDecorationSignature } from '../../environment/providers/decoration'
 import { TextDocumentFeatureProviderRegistry } from '../../environment/providers/textDocument'
 import { ClientCapabilities, ServerCapabilities, TextDocumentRegistrationOptions } from '../../protocol'
 import {
     TextDocumentDecoration,
-    TextDocumentDecorationsParams,
-    TextDocumentDecorationsRequest,
+    TextDocumentDecorationParams,
+    TextDocumentDecorationRequest,
     TextDocumentPublishDecorationsNotification,
     TextDocumentPublishDecorationsParams,
 } from '../../protocol/decoration'
@@ -16,32 +16,32 @@ import { NextSignature } from '../../types/middleware'
 import { Client } from '../client'
 import { ensure, TextDocumentFeature } from './common'
 
-export type ProvideTextDocumentDecorationsMiddleware = NextSignature<
-    TextDocumentDecorationsParams,
+export type ProvideTextDocumentDecorationMiddleware = NextSignature<
+    TextDocumentDecorationParams,
     Observable<TextDocumentDecoration[] | null>
 >
 
 /**
- * Support for static text document decorations requested by the client (textDocument/decorations requests to the
+ * Support for static text document decorations requested by the client (textDocument/decoration requests to the
  * server).
  */
-export class TextDocumentStaticDecorationsFeature extends TextDocumentFeature<TextDocumentRegistrationOptions> {
+export class TextDocumentStaticDecorationFeature extends TextDocumentFeature<TextDocumentRegistrationOptions> {
     constructor(
         client: Client,
         private registry: TextDocumentFeatureProviderRegistry<
             TextDocumentRegistrationOptions,
-            ProvideTextDocumentDecorationsSignature
+            ProvideTextDocumentDecorationSignature
         >
     ) {
-        super(client, TextDocumentDecorationsRequest.type)
+        super(client, TextDocumentDecorationRequest.type)
     }
 
     public fillClientCapabilities(capabilities: ClientCapabilities): void {
-        ensure(capabilities, 'decorations')!.static = true
+        ensure(capabilities, 'decoration')!.static = true
     }
 
     public initialize(capabilities: ServerCapabilities, documentSelector: DocumentSelector): void {
-        if (!capabilities.decorationsProvider || !capabilities.decorationsProvider.static || !documentSelector) {
+        if (!capabilities.decorationProvider || !capabilities.decorationProvider.static || !documentSelector) {
             return
         }
         this.register(this.messages, {
@@ -52,20 +52,20 @@ export class TextDocumentStaticDecorationsFeature extends TextDocumentFeature<Te
 
     protected registerProvider(options: TextDocumentRegistrationOptions): TeardownLogic {
         const client = this.client
-        const provideTextDocumentDecorations: ProvideTextDocumentDecorationsSignature = params =>
-            from(client.sendRequest(TextDocumentDecorationsRequest.type, params))
+        const provideTextDocumentDecoration: ProvideTextDocumentDecorationSignature = params =>
+            from(client.sendRequest(TextDocumentDecorationRequest.type, params))
         const middleware = client.clientOptions.middleware!
         return this.registry.registerProvider(
             options,
-            (params: TextDocumentDecorationsParams): Observable<TextDocumentDecoration[] | null> =>
-                middleware.provideTextDocumentDecorations
-                    ? middleware.provideTextDocumentDecorations(params, provideTextDocumentDecorations)
-                    : provideTextDocumentDecorations(params)
+            (params: TextDocumentDecorationParams): Observable<TextDocumentDecoration[] | null> =>
+                middleware.provideTextDocumentDecoration
+                    ? middleware.provideTextDocumentDecoration(params, provideTextDocumentDecoration)
+                    : provideTextDocumentDecoration(params)
         )
     }
 }
 
-export type HandleTextDocumentDecorationsMiddleware = NextSignature<
+export type HandleTextDocumentDecorationMiddleware = NextSignature<
     TextDocumentPublishDecorationsParams,
     Observable<TextDocumentDecoration[] | null>
 >
@@ -74,26 +74,26 @@ export type HandleTextDocumentDecorationsMiddleware = NextSignature<
  * Support for dynamic text document decorations published by the server (textDocument/publishDecorations
  * notifications from the server).
  */
-export class TextDocumentDynamicDecorationsFeature extends TextDocumentFeature<TextDocumentRegistrationOptions> {
+export class TextDocumentDynamicDecorationFeature extends TextDocumentFeature<TextDocumentRegistrationOptions> {
     /** Map of document URI to its decorations (last published by the server). */
     private decorations = new Map<string, BehaviorSubject<TextDocumentDecoration[] | null>>()
 
     constructor(
         client: Client,
         private registry: TextDocumentFeatureProviderRegistry<
             TextDocumentRegistrationOptions,
-            ProvideTextDocumentDecorationsSignature
+            ProvideTextDocumentDecorationSignature
         >
     ) {
         super(client, TextDocumentPublishDecorationsNotification.type)
     }
 
     public fillClientCapabilities(capabilities: ClientCapabilities): void {
-        ensure(capabilities, 'decorations')!.dynamic = true
+        ensure(capabilities, 'decoration')!.dynamic = true
     }
 
     public initialize(capabilities: ServerCapabilities, documentSelector: DocumentSelector): void {
-        if (!capabilities.decorationsProvider || !capabilities.decorationsProvider.dynamic || !documentSelector) {
+        if (!capabilities.decorationProvider || !capabilities.decorationProvider.dynamic || !documentSelector) {
             return
         }
         this.register(this.messages, {
@@ -108,15 +108,15 @@ export class TextDocumentDynamicDecorationsFeature extends TextDocumentFeature<T
 
     protected registerProvider(options: TextDocumentRegistrationOptions): TeardownLogic {
         const client = this.client
-        const provideTextDocumentDecorations: ProvideTextDocumentDecorationsSignature = params =>
+        const provideTextDocumentDecoration: ProvideTextDocumentDecorationSignature = params =>
             this.getDecorationsSubject(params.textDocument)
         const middleware = client.clientOptions.middleware!
         return this.registry.registerProvider(
             options,
-            (params: TextDocumentDecorationsParams): Observable<TextDocumentDecoration[] | null> =>
-                middleware.provideTextDocumentDecorations
-                    ? middleware.provideTextDocumentDecorations(params, provideTextDocumentDecorations)
-                    : provideTextDocumentDecorations(params)
+            (params: TextDocumentDecorationParams): Observable<TextDocumentDecoration[] | null> =>
+                middleware.provideTextDocumentDecoration
+                    ? middleware.provideTextDocumentDecoration(params, provideTextDocumentDecoration)
+                    : provideTextDocumentDecoration(params)
         )
     }
 

src/client/middleware.ts

@@ -1,14 +1,11 @@
 import { TextDocument } from 'vscode-languageserver-types'
 import { NextSignature } from '../types/middleware'
-import {
-    HandleTextDocumentDecorationsMiddleware,
-    ProvideTextDocumentDecorationsMiddleware,
-} from './features/decoration'
+import { HandleTextDocumentDecorationMiddleware, ProvideTextDocumentDecorationMiddleware } from './features/decoration'
 import { ProvideTextDocumentHoverMiddleware } from './features/hover'
 
 export interface Middleware {
     didOpen?: NextSignature<TextDocument, void>
     provideTextDocumentHover?: ProvideTextDocumentHoverMiddleware
-    provideTextDocumentDecorations?: ProvideTextDocumentDecorationsMiddleware
-    handleTextDocumentDecorations?: HandleTextDocumentDecorationsMiddleware
+    provideTextDocumentDecoration?: ProvideTextDocumentDecorationMiddleware
+    handleTextDocumentDecoration?: HandleTextDocumentDecorationMiddleware
 }

src/environment/controller.ts

@@ -8,8 +8,8 @@ import {
     ConfigurationUpdateFeature,
 } from '../client/features/configuration'
 import {
-    TextDocumentDynamicDecorationsFeature,
-    TextDocumentStaticDecorationsFeature,
+    TextDocumentDynamicDecorationFeature,
+    TextDocumentStaticDecorationFeature,
 } from '../client/features/decoration'
 import { TextDocumentHoverFeature } from '../client/features/hover'
 import { WindowLogMessageFeature } from '../client/features/logMessage'
@@ -178,12 +178,8 @@ export class Controller<X extends Extension = Extension> implements Unsubscribab
         client.registerFeature(new ExecuteCommandFeature(client, this.registries.commands))
         client.registerFeature(new TextDocumentDidOpenFeature(client))
         client.registerFeature(new TextDocumentHoverFeature(client, this.registries.textDocumentHover))
-        client.registerFeature(
-            new TextDocumentStaticDecorationsFeature(client, this.registries.textDocumentDecorations)
-        )
-        client.registerFeature(
-            new TextDocumentDynamicDecorationsFeature(client, this.registries.textDocumentDecorations)
-        )
+        client.registerFeature(new TextDocumentStaticDecorationFeature(client, this.registries.textDocumentDecoration))
+        client.registerFeature(new TextDocumentDynamicDecorationFeature(client, this.registries.textDocumentDecoration))
         client.registerFeature(
             new WindowLogMessageFeature(client, (params: LogMessageParams) =>
                 this._logMessages.next({ ...params, extension: client.id })

src/environment/providers/decoration.ts

@@ -1,20 +1,20 @@
 import { combineLatest, Observable } from 'rxjs'
 import { catchError, map, switchMap } from 'rxjs/operators'
 import { TextDocumentRegistrationOptions } from '../../protocol'
-import { TextDocumentDecoration, TextDocumentDecorationsParams } from '../../protocol/decoration'
+import { TextDocumentDecoration, TextDocumentDecorationParams } from '../../protocol/decoration'
 import { compact, flatten } from '../../util'
 import { TextDocumentFeatureProviderRegistry } from './textDocument'
 
-export type ProvideTextDocumentDecorationsSignature = (
-    params: TextDocumentDecorationsParams
+export type ProvideTextDocumentDecorationSignature = (
+    params: TextDocumentDecorationParams
 ) => Observable<TextDocumentDecoration[] | null>
 
 /** Provides text document decorations from all extensions. */
-export class TextDocumentDecorationsProviderRegistry extends TextDocumentFeatureProviderRegistry<
+export class TextDocumentDecorationProviderRegistry extends TextDocumentFeatureProviderRegistry<
     TextDocumentRegistrationOptions,
-    ProvideTextDocumentDecorationsSignature
+    ProvideTextDocumentDecorationSignature
 > {
-    public getDecorations(params: TextDocumentDecorationsParams): Observable<TextDocumentDecoration[] | null> {
+    public getDecorations(params: TextDocumentDecorationParams): Observable<TextDocumentDecoration[] | null> {
         return this.providers
             .pipe(
                 switchMap(providers =>

src/environment/registries.ts

@@ -1,10 +1,10 @@
 import { CommandRegistry } from '../client/features/command'
-import { TextDocumentDecorationsProviderRegistry } from './providers/decoration'
+import { TextDocumentDecorationProviderRegistry } from './providers/decoration'
 import { TextDocumentHoverProviderRegistry } from './providers/hover'
 
 /** Registries is a container for all provider registries. */
 export class Registries {
     public readonly commands = new CommandRegistry()
     public readonly textDocumentHover = new TextDocumentHoverProviderRegistry()
-    public readonly textDocumentDecorations = new TextDocumentDecorationsProviderRegistry()
+    public readonly textDocumentDecoration = new TextDocumentDecorationProviderRegistry()
 }

src/protocol/capabilities.ts

@@ -4,7 +4,7 @@ import { ExecuteCommandOptions } from './command'
 import { CompletionOptions } from './completion'
 import { ConfigurationClientCapabilities } from './configuration'
 import { ContributionsClientCapabilities, ContributionsServerCapabilities } from './contribution'
-import { DecorationsClientCapabilities, DecorationsServerCapabilities } from './decoration'
+import { DecorationClientCapabilities, DecorationServerCapabilities } from './decoration'
 import { DocumentLinkOptions } from './documentLink'
 import { ImplementationClientCapabilities, ImplementationServerCapabilities } from './implementation'
 import { SignatureHelpOptions } from './signatureHelp'
@@ -41,7 +41,7 @@ export type ClientCapabilities = _ClientCapabilities &
     ConfigurationClientCapabilities &
     ColorClientCapabilities &
     ContributionsClientCapabilities &
-    DecorationsClientCapabilities
+    DecorationClientCapabilities
 
 /**
  * Defines the capabilities provided by a language
@@ -139,4 +139,4 @@ export type ServerCapabilities = _ServerCapabilities &
     WorkspaceFoldersServerCapabilities &
     ColorServerCapabilities &
     ContributionsServerCapabilities &
-    DecorationsServerCapabilities
+    DecorationServerCapabilities