Emit code lenses from the language service

Author: thecrypticace

packages/tailwindcss-language-server/src/config.ts

@@ -16,6 +16,7 @@ function getDefaultSettings(): Settings {
       emmetCompletions: false,
       classAttributes: ['class', 'className', 'ngClass', 'class:list'],
       codeActions: true,
+      codeLens: true,
       hovers: true,
       suggestions: true,
       validate: true,

packages/tailwindcss-language-server/src/projects.ts

@@ -15,6 +15,8 @@ import type {
   Disposable,
   DocumentLinkParams,
   DocumentLink,
+  CodeLensParams,
+  CodeLens,
 } from 'vscode-languageserver/node'
 import { FileChangeType } from 'vscode-languageserver/node'
 import type { TextDocument } from 'vscode-languageserver-textdocument'
@@ -35,6 +37,7 @@ import stackTrace from 'stack-trace'
 import extractClassNames from './lib/extractClassNames'
 import { klona } from 'klona/full'
 import { doHover } from '@tailwindcss/language-service/src/hoverProvider'
+import { getCodeLens } from '@tailwindcss/language-service/src/codeLensProvider'
 import { Resolver } from './resolver'
 import {
   doComplete,
@@ -110,6 +113,7 @@ export interface ProjectService {
   onColorPresentation(params: ColorPresentationParams): Promise<ColorPresentation[]>
   onCodeAction(params: CodeActionParams): Promise<CodeAction[]>
   onDocumentLinks(params: DocumentLinkParams): Promise<DocumentLink[]>
+  onCodeLens(params: CodeLensParams): Promise<CodeLens[]>
   sortClassLists(classLists: string[]): string[]
 
   dependencies(): Iterable<string>
@@ -1177,6 +1181,17 @@ export async function createProjectService(
         return doHover(state, document, params.position)
       }, null)
     },
+    async onCodeLens(params: CodeLensParams): Promise<CodeLens[]> {
+      return withFallback(async () => {
+        if (!state.enabled) return null
+        let document = documentService.getDocument(params.textDocument.uri)
+        if (!document) return null
+        let settings = await state.editor.getConfiguration(document.uri)
+        if (!settings.tailwindCSS.codeLens) return null
+        if (await isExcluded(state, document)) return null
+        return getCodeLens(state, document)
+      }, null)
+    },
     async onCompletion(params: CompletionParams): Promise<CompletionList> {
       return withFallback(async () => {
         if (!state.enabled) return null

packages/tailwindcss-language-server/src/tw.ts

@@ -19,6 +19,8 @@ import type {
   DocumentLink,
   InitializeResult,
   WorkspaceFolder,
+  CodeLensParams,
+  CodeLens,
 } from 'vscode-languageserver/node'
 import {
   CompletionRequest,
@@ -30,6 +32,7 @@ import {
   FileChangeType,
   DocumentLinkRequest,
   TextDocumentSyncKind,
+  CodeLensRequest,
 } from 'vscode-languageserver/node'
 import { URI } from 'vscode-uri'
 import normalizePath from 'normalize-path'
@@ -757,6 +760,7 @@ export class TW {
     this.connection.onDocumentColor(this.onDocumentColor.bind(this))
     this.connection.onColorPresentation(this.onColorPresentation.bind(this))
     this.connection.onCodeAction(this.onCodeAction.bind(this))
+    this.connection.onCodeLens(this.onCodeLens.bind(this))
     this.connection.onDocumentLinks(this.onDocumentLinks.bind(this))
     this.connection.onRequest(this.onRequest.bind(this))
   }
@@ -809,6 +813,7 @@ export class TW {
     capabilities.add(HoverRequest.type, { documentSelector: null })
     capabilities.add(DocumentColorRequest.type, { documentSelector: null })
     capabilities.add(CodeActionRequest.type, { documentSelector: null })
+    capabilities.add(CodeLensRequest.type, { documentSelector: null })
     capabilities.add(DocumentLinkRequest.type, { documentSelector: null })
 
     capabilities.add(CompletionRequest.type, {
@@ -931,6 +936,11 @@ export class TW {
     return this.getProject(params.textDocument)?.onCodeAction(params) ?? null
   }
 
+  async onCodeLens(params: CodeLensParams): Promise<CodeLens[]> {
+    await this.init()
+    return this.getProject(params.textDocument)?.onCodeLens(params) ?? null
+  }
+
   async onDocumentLinks(params: DocumentLinkParams): Promise<DocumentLink[]> {
     await this.init()
     return this.getProject(params.textDocument)?.onDocumentLinks(params) ?? null
@@ -961,6 +971,9 @@ export class TW {
           hoverProvider: true,
           colorProvider: true,
           codeActionProvider: true,
+          codeLensProvider: {
+            resolveProvider: false,
+          },
           documentLinkProvider: {},
           completionProvider: {
             resolveProvider: true,

packages/tailwindcss-language-server/tests/utils/client.ts

@@ -1,6 +1,8 @@
 import type { Settings } from '@tailwindcss/language-service/src/util/state'
 import {
   ClientCapabilities,
+  CodeLens,
+  CodeLensRequest,
   CompletionList,
   CompletionParams,
   Diagnostic,
@@ -94,6 +96,11 @@ export interface ClientDocument {
    */
   reopen(): Promise<void>
 
+  /**
+   * Code lenses in the document
+   */
+  codeLenses(): Promise<CodeLens[] | null>
+
   /**
    * The diagnostics for the current version of this document
    */
@@ -677,6 +684,14 @@ export async function createClientWorkspace({
       return results
     }
 
+    async function codeLenses() {
+      return await conn.sendRequest(CodeLensRequest.type, {
+        textDocument: {
+          uri: uri.toString(),
+        },
+      })
+    }
+
     return {
       uri,
       reopen,
@@ -687,6 +702,7 @@ export async function createClientWorkspace({
       symbols,
       completions,
       diagnostics,
+      codeLenses,
     }
   }
 

packages/tailwindcss-language-service/src/codeLensProvider.ts

@@ -0,0 +1,13 @@
+import type { TextDocument } from 'vscode-languageserver-textdocument'
+import type { State } from './util/state'
+import type { CodeLens } from 'vscode-languageserver'
+
+export async function getCodeLens(state: State, doc: TextDocument): Promise<CodeLens[]> {
+  if (!state.enabled) return []
+
+  let groups: CodeLens[][] = await Promise.all([
+    //
+  ])
+
+  return groups.flat()
+}

packages/tailwindcss-language-service/src/util/state.ts

@@ -48,6 +48,7 @@ export type TailwindCssSettings = {
   classAttributes: string[]
   suggestions: boolean
   hovers: boolean
+  codeLens: boolean
   codeActions: boolean
   validate: boolean
   showPixelEquivalents: boolean

packages/vscode-tailwindcss/package.json

@@ -202,6 +202,12 @@
           "markdownDescription": "Enable code actions.",
           "scope": "language-overridable"
         },
+        "tailwindCSS.codeLens": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable code lens.",
+          "scope": "language-overridable"
+        },
         "tailwindCSS.colorDecorators": {
           "type": "boolean",
           "default": true,