Add virtual document abstraction

wip

wip

Author: thecrypticace

packages/tailwindcss-language-service/src/documents/document.ts

@@ -0,0 +1,75 @@
+import type { Position, TextDocument } from 'vscode-languageserver-textdocument'
+import type { State } from '../util/state'
+import { LanguageBoundary } from '../util/getLanguageBoundaries'
+import { isWithinRange } from '../util/isWithinRange'
+import { getTextWithoutComments } from '../util/doc'
+
+export type DocumentContext = 'html' | 'css' | 'js' | 'other' | (string & {})
+
+export class VirtualDocument {
+  /**
+   * A getter for the global state of the server. This state is shared across
+   * all virtual documents and may change arbitrarily over time.
+   *
+   * This is a getter to prevent stale references from being held.
+   */
+  private state: () => State
+
+  /**
+   * The "text document" that contains the content of this document and all of
+   * its embedded documents.
+   */
+  private storage: TextDocument
+
+  /**
+   * Conseptual boundaries of the document where different languages are used
+   *
+   * This is used to determine how the document is structured and what parts
+   * are relevant to the current operation.
+   */
+  private boundaries: LanguageBoundary[]
+
+  constructor(
+    state: () => State,
+    storage: TextDocument,
+    boundaries: LanguageBoundary[],
+  ) {
+    this.state = state
+    this.storage = storage
+    this.boundaries = boundaries
+  }
+
+  /**
+   * The current content of the document
+   */
+  public get contents() {
+    // Replace all comment nodes with whitespace
+    let tmp = ''
+
+    let type = this.boundaries[0].type
+    if (type === 'html') {
+      tmp = getTextWithoutComments(this.storage, 'html')
+    } else if (type === 'css') {
+      tmp = getTextWithoutComments(this.storage, 'css')
+    } else if (type === 'js') {
+      tmp = getTextWithoutComments(this.storage, 'js')
+    } else if (type === 'jsx') {
+      tmp = getTextWithoutComments(this.storage, 'jsx')
+    }
+
+    return tmp
+  }
+
+  /**
+   * Find the inner-most scope containing a given cursor position.
+   */
+  public boundaryAt(cursor: Position): LanguageBoundary | null {
+    for (let boundary of this.boundaries) {
+      if (isWithinRange(cursor, boundary.range)) {
+        return boundary
+      }
+    }
+
+    return null
+  }
+}

packages/tailwindcss-language-service/src/documents/manager.ts

@@ -0,0 +1,44 @@
+import type { TextDocument } from 'vscode-languageserver-textdocument'
+import type { State } from '../util/state'
+import { VirtualDocument } from './document'
+import { analyzeDocument } from '../scopes/analyze'
+import { getDocumentLanguages, getLanguageBoundaries } from '../util/getLanguageBoundaries'
+
+export class DocumentManager {
+  /**
+   * A getter for the global state of the server. This state is shared across
+   * all virtual documents and may change arbitrarily over time.
+
+   * This is a getter to prevent stale references from being held.
+   */
+  private state: () => State
+
+  /**
+   * A map of document URIs to their respective virtual documents.
+   */
+  private store = new Map<string, VirtualDocument>()
+
+  constructor(state: () => State) {
+    this.state = state
+  }
+
+  get(uri: TextDocument): Promise<VirtualDocument>
+  get(uri: string): Promise<VirtualDocument | null>
+
+  async get(doc: TextDocument | string): Promise<VirtualDocument | null> {
+    if (typeof doc === 'string') {
+      return this.store.get(doc) ?? null
+    }
+
+    let found = this.store.get(doc.uri)
+    if (found) return found
+
+    let state = this.state()
+    let scopes = await analyzeDocument(state, doc)
+    let boundaries = getDocumentLanguages(state, doc)
+    found = new VirtualDocument(this.state, doc, boundaries, scopes)
+    this.store.set(doc.uri, found)
+
+    return found
+  }
+}

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

@@ -7,7 +7,7 @@ import { isJsDoc } from './js'
 import moo, { Rules } from 'moo'
 import Cache from 'tmp-cache'
 import { getTextWithoutComments } from './doc'
-import { isCssLanguage } from './css'
+import { isCssDoc, isCssLanguage } from './css'
 
 export type LanguageBoundary = {
   type: 'html' | 'js' | 'jsx' | 'css' | (string & {})
@@ -146,6 +146,36 @@ export function clearLanguageBoundariesCache() {
   cache.clear()
 }
 
+/**
+ * @deprecated
+ */
+export function getDocumentLanguages(state: State, doc: TextDocument): LanguageBoundary[] {
+  let boundaries = getLanguageBoundaries(state, doc)
+  if (boundaries) return boundaries
+
+  // If we get here we most likely have non-HTML document in a single language
+  let type = doc.languageId
+
+  if (isCssDoc(state, doc)) {
+    type = 'css'
+  } else if (isHtmlDoc(state, doc)) {
+    type = 'html'
+  } else if (isJsDoc(state, doc)) {
+    type = 'js'
+  }
+
+  let text = doc.getText()
+
+  return [
+    {
+      type,
+      lang: doc.languageId,
+      span: [0, text.length],
+      range: { start: doc.positionAt(0), end: doc.positionAt(text.length) },
+    },
+  ]
+}
+
 export function getLanguageBoundaries(
   state: State,
   doc: TextDocument,