Language Server with Definitions Only

.codeclimate.json

@@ -7,6 +7,7 @@
     "**/contract.ts",
     "demo/**",
     "extension/src/test/**",
+    "languageServer/src/test/**",
     "webview/src/react-table-config.d.ts",
     "webview/src/shared/components/icons/**"
   ],

.vscode/settings.json

@@ -7,6 +7,7 @@
   "prettier.configPath": ".prettierrc.json",
   "editor.tabSize": 2,
   "typescript.updateImportsOnFileMove.enabled": "prompt",
+  "npm.exclude": ["**/{demo,.wdio*}/**"],
   "cSpell.words": [
     "appdirs",
     "camelcase",

.vscode/tasks.json

@@ -24,10 +24,25 @@
       "path": "webview/",
       "group": "build"
     },
+    {
+      "type": "npm",
+      "label": "npm: dev - languageServer",
+      "script": "dev",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never"
+      },
+      "path": "languageServer/",
+      "group": "build"
+    },
     {
       "label": "npm: dev - all",
       "isBackground": true,
-      "dependsOn": ["npm: dev - extension", "npm: dev - webview"],
+      "dependsOn": [
+        "npm: dev - extension",
+        "npm: dev - webview",
+        "npm: dev - languageServer"
+      ],
       "group": {
         "kind": "build",
         "isDefault": true

extension/package.json

@@ -1544,7 +1544,8 @@
     "lodash.merge": "4.6.2",
     "lodash.omit": "4.5.0",
     "tree-kill": "1.2.2",
-    "uuid": "9.0.0"
+    "uuid": "9.0.0",
+    "vscode-languageclient": "8.0.2"
   },
   "devDependencies": {
     "@swc/core": "1.3.1",

extension/src/extension.ts

@@ -51,6 +51,7 @@ import { collectWorkspaceScale } from './telemetry/collect'
 import { createFileSystemWatcher } from './fileSystem/watcher'
 import { GitExecutor } from './cli/git/executor'
 import { GitReader } from './cli/git/reader'
+import { LanguageClientWrapper } from './lspClient/languageClient'
 
 export class Extension extends Disposable implements IExtension {
   protected readonly internalCommands: InternalCommands
@@ -92,6 +93,8 @@ export class Extension extends Disposable implements IExtension {
     this.setCommandsAvailability(false)
     this.setProjectAvailability()
 
+    this.dispose.track(new LanguageClientWrapper())
+
     this.resourceLocator = this.dispose.track(
       new ResourceLocator(context.extensionUri)
     )
@@ -442,6 +445,7 @@ export class Extension extends Disposable implements IExtension {
 }
 
 let extension: undefined | Extension
+
 export function activate(context: ExtensionContext): void {
   extension = new Extension(context)
   context.subscriptions.push(extension)

extension/src/fileSystem/workspace.ts

@@ -27,7 +27,10 @@ export const isInWorkspace = (pathOrGlob: string): boolean => {
   return definedAndNonEmpty(isContained)
 }
 
-export const findFiles = async (relativeGlob: string): Promise<string[]> => {
-  const files = await workspace.findFiles(relativeGlob)
+export const findFiles = async (
+  relativeGlob: string,
+  exclude?: string
+): Promise<string[]> => {
+  const files = await workspace.findFiles(relativeGlob, exclude)
   return files.map(uri => uri.fsPath)
 }

extension/src/lspClient/languageClient.ts

@@ -0,0 +1,62 @@
+import { workspace } from 'vscode'
+import {
+  LanguageClient,
+  LanguageClientOptions,
+  ServerOptions,
+  TransportKind
+} from 'vscode-languageclient/node'
+import { documentSelector, serverModule } from 'dvc-vscode-lsp'
+import { Disposable } from '../class/dispose'
+
+export class LanguageClientWrapper extends Disposable {
+  private client: LanguageClient
+
+  constructor() {
+    super()
+
+    const clientOptions: LanguageClientOptions = {
+      documentSelector,
+
+      synchronize: {
+        fileEvents: workspace.createFileSystemWatcher(
+          '**/*.{yaml,dvc,dvc.lock,json,toml}'
+        )
+      }
+    }
+
+    this.client = this.dispose.track(
+      new LanguageClient(
+        'dvc-vscode-lsp',
+        'DVC Language Server',
+        this.getServerOptions(),
+        clientOptions
+      )
+    )
+
+    // Start the client. This will also launch the server
+    this.start()
+  }
+
+  start() {
+    this.client.start()
+
+    return this
+  }
+
+  stop() {
+    this.client.stop()
+  }
+
+  private getServerOptions(): ServerOptions {
+    const debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] }
+
+    return {
+      debug: {
+        module: serverModule,
+        options: debugOptions,
+        transport: TransportKind.ipc
+      },
+      run: { module: serverModule, transport: TransportKind.ipc }
+    }
+  }
+}

extension/webpack.config.ts

@@ -33,6 +33,7 @@ export default {
   devtool: 'source-map',
   entry: r('./src/extension'),
   externals: {
+    'dvc-vscode-lsp': 'dvc-vscode-lsp',
     'dvc-vscode-webview': 'dvc-vscode-webview',
     fsevents: "require('fsevents')",
     vscode: 'commonjs vscode'
@@ -65,6 +66,7 @@ export default {
   plugins: [
     new CleanWebpackPlugin(),
     includeDependency(r('../webview/')),
+    includeDependency(r('../languageServer/')),
     includeFiles(),
     new ForkTsCheckerWebpackPlugin()
   ],

languageServer/.eslintrc.js

@@ -0,0 +1,6 @@
+const config = require('../.eslintrc')
+
+module.exports = {
+  ...config,
+  ignorePatterns: [...config.ignorePatterns, 'src/test/fixtures/**']
+}

languageServer/.lintstagedrc.js

@@ -0,0 +1 @@
+module.exports = require('../.lintstagedrc')

languageServer/.prettierignore

@@ -0,0 +1 @@
+dist

languageServer/index.d.ts

@@ -0,0 +1,4 @@
+import { DocumentFilter } from 'vscode-languageserver'
+
+export const serverModule: string
+export const documentSelector: DocumentFilter[]

languageServer/index.js

@@ -0,0 +1,25 @@
+/* global module, require, __dirname */
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+// This is the entry point when this package is used as library from the extension.
+// This package MUST NOT be bundled.
+const path = require('path')
+
+module.exports.serverModule = path.join(__dirname, 'dist', 'server.js')
+module.exports.documentSelector = [
+  {
+    language: 'yaml'
+  },
+  {
+    pattern: '**/*.{dvc,dvc.lock}'
+  },
+  {
+    language: 'json'
+  },
+  {
+    language: 'toml'
+  },
+  {
+    language: 'python'
+  }
+]

languageServer/jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  collectCoverageFrom: ['src/**/*.{ts,tsx}', '!**/*.test.*', '!src/test/*'],
+  coverageDirectory: 'coverage/jest',
+  coveragePathIgnorePatterns: ['<rootDir>/src/test/'],
+  coverageReporters: ['json'],
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['<rootDir>/dist/'],
+  transform: {
+    '^.+\\.(t|j)sx?$': ['@swc/jest']
+  }
+}

languageServer/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "dvc-vscode-lsp",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": "*"
+  },
+  "peerDependencies": {
+    "dvc": ">=0.0.1",
+    "typescript": "*"
+  },
+  "dependencies": {
+    "jsonc-parser": "3.1.0",
+    "jsonpath-plus": "7.0.0",
+    "lodash": "4.17.21",
+    "vscode-languageserver": "8.0.2",
+    "vscode-languageserver-textdocument": "1.0.4",
+    "vscode-uri": "3.0.3",
+    "yaml": "2.1.1"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -b",
+    "test-build": "rm -rf dist && tsc -b",
+    "format": "prettier --write '**/*.{js,json,jsx,md,scss,ts,tsx,yaml,yml}'",
+    "lint:prettier": "prettier -c '**/*.{js,json,jsx,md,scss,ts,tsx,yaml,yml}'",
+    "lint:eslint": "eslint --cache '**/*.{js,ts,jsx,tsx}'",
+    "lint:tsc": "tsc --noEmit",
+    "lint": "run-p 'lint:*'",
+    "dev": "tsc -b --watch",
+    "test": "jest --collect-coverage"
+  },
+  "devDependencies": {
+    "@swc/core": "1.2.247",
+    "@swc/jest": "0.2.22",
+    "@types/jest": "28.1.8",
+    "fs-jetpack": "4.3.1",
+    "lint-staged": "13.0.3",
+    "jest": "29.0.1",
+    "jest-environment-node": "29.0.2"
+  }
+}

languageServer/src/ITextDocumentWrapper.ts

@@ -0,0 +1,7 @@
+import { Position } from 'vscode-languageserver-textdocument'
+import { Document } from 'yaml'
+
+export interface ITextDocumentWrapper {
+  getYamlDocument(): Document
+  offsetAt(position: Position): number
+}