Language Server for dvc.yaml files (#2408)

* Add a test and a definitions provider

* Remove unused logic

* Refactor getCompletions

* Refactor yamlScalarNodeToDocumentSymbol

* Refactor DvcYamlModel

* Extract onInitialize handler to dedicated method

* Remove dupes from DvcLanguageServer

* Extract documentSelector constant

* Add lspClient to Extension class

* Restore disposable exports in extension.ts

* Make ServerModule class into a method

* Add prettier to languageServer

* Remove commented out config

* Remove unnecessary jest config entries

* Add swc/jest to languageServer

* Rename DvcLanguageServer->LanguageServer

* Rename DvcTextDocument->TextDocumentWrapper

* Rename IDvcTextDocument->ITextDocumentWrapper

* Fix test coverage config in languageServer

* Collect only from src folder

* Refactor dependencies

* Create onDefinition method

* Create more connection handler methods

* Add method access specifiers to TextDocumentWrapper

* Remove unnecessary if

* Remove await before return

* Remove make script

* Remove useless accessor

* Remove constructor shorthands

* Add a codeAction request test

* Use a better fixture for the codeActions test

* Drop DVC prefix from LanguageClient

* Simplify lspClient track call

* Add access prefixes in DvcYamlModel

* Export documentSelector from languageServer

* Export more regex for readability

* Simplify Stage::toJSON

* Simplify Stage::addDependencies

* Make TextDocumentWrapper implement ITextDocumentWrapper

* Move more logic from DocumentWrapper to DvcYaml

* Commit lock file

* Move definitions logic to languageServer

* Simplify findLocationFor

* More readability improvements

* New PR with only the definitions provider

* Add test-build script to languageServer

* Fix document selector bug

* Fix code styling issues

* Fix definition bugs

* Add test for definitions outside dvc.yamls

* Add test for file path symbols

Author: wolmir

.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')