Merge pull request #53 from CodinGame/use-vscode-services

Use vscode services

Author: CGNonofr

.gitignore

@@ -2,3 +2,4 @@ dist/*
 stats.html
 .vscode
 node_modules
+/extensions

jest/resolver.js

@@ -0,0 +1,9 @@
+const browserResolve = require('browser-resolve');
+
+module.exports = (path, options) => {
+  try {
+      return browserResolve.sync(path, options)
+  } catch (error) {
+      return options.defaultResolver(path, options)
+  }
+}

package-lock.json

@@ -8,13 +8,13 @@
     "test:watch": "jest --watch",
     "build": "npm run test && npm run compile && npm run generate-types",
     "compile": "rollup --config rollup.config.ts --configPlugin typescript",
-    "generate-types": "tsc --project tsconfig.types.json && rollup --config rollup.types.config.ts --configPlugin typescript && rm -rf ./dist/types"
+    "generate-types": "tsc --project tsconfig.types.json && rollup --config rollup.types.config.ts --configPlugin typescript && rm -rf ./dist/types",
+    "preprepare": "./scripts/install-extensions"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/CodinGame/monaco-languageclient-wrapper"
   },
-  "moduleResolution": "node",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "files": [
@@ -23,52 +23,51 @@
   ],
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@codingame/monaco-editor-wrapper": "^1.14.8",
-    "sweetalert": "^2.1.2",
-    "vscode": "npm:@codingame/monaco-vscode-api@^1.68.4",
+    "@codingame/monaco-editor-wrapper": "^2.1.1",
+    "recast": "^0.21.1",
+    "vscode": "npm:@codingame/monaco-vscode-api@~1.67.12",
     "vscode-languageserver-protocol": "^3.17.1",
-    "vscode-ws-jsonrpc": "^1.0.0"
+    "vscode-ws-jsonrpc": "^1.0.1"
   },
   "devDependencies": {
-    "@babel/core": "7.18.5",
-    "@babel/plugin-proposal-class-properties": "7.17.12",
-    "@babel/plugin-proposal-optional-chaining": "7.17.12",
-    "@babel/plugin-transform-modules-commonjs": "^7.18.2",
-    "@babel/preset-env": "7.18.2",
-    "@babel/preset-typescript": "7.17.12",
-    "@babel/runtime": "7.18.3",
-    "@codingame/eslint-config": "^1.1.2",
-    "@codingame/tsconfig": "^1.0.5",
+    "@babel/core": "7.18.6",
+    "@babel/plugin-proposal-class-properties": "7.18.6",
+    "@babel/plugin-proposal-optional-chaining": "7.18.6",
+    "@babel/plugin-transform-modules-commonjs": "^7.18.6",
+    "@babel/preset-env": "7.18.6",
+    "@babel/preset-typescript": "7.18.6",
+    "@babel/runtime": "7.18.6",
+    "@codingame/eslint-config": "^1.1.5",
+    "@codingame/tsconfig": "^1.1.0",
     "@rollup/plugin-alias": "3.1.9",
     "@rollup/plugin-babel": "5.3.1",
-    "@rollup/plugin-commonjs": "22.0.0",
+    "@rollup/plugin-commonjs": "22.0.1",
     "@rollup/plugin-eslint": "8.0.2",
     "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-node-resolve": "13.3.0",
     "@rollup/plugin-typescript": "^8.3.3",
-    "@types/jest": "^28.1.2",
+    "@types/jest": "^28.1.4",
     "@types/once": "^1.4.0",
-    "@types/rollup-plugin-node-builtins": "^2.1.2",
-    "@types/vscode": "^1.68.0",
-    "@typescript-eslint/eslint-plugin": "5.29.0",
-    "@typescript-eslint/parser": "5.29.0",
-    "canvas": "^2.9.1",
+    "@types/vscode": "~1.67.0",
+    "@typescript-eslint/eslint-plugin": "5.30.5",
+    "@typescript-eslint/parser": "5.30.5",
+    "browser-resolve": "^2.0.0",
+    "canvas": "^2.9.3",
     "conventional-changelog-conventionalcommits": "^5.0.0",
     "delay": "^5.0.0",
-    "eslint": "8.18.0",
+    "eslint": "8.19.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-jest": "^26.5.3",
-    "eslint-plugin-n": "^15.2.3",
+    "eslint-plugin-n": "^15.2.4",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "jest": "^28.1.1",
-    "jest-environment-jsdom": "^28.1.1",
-    "monaco-languageclient": "^2.0.0",
+    "jest": "^28.1.2",
+    "jest-environment-jsdom": "^28.1.2",
+    "monaco-languageclient": "^2.0.2",
     "proxy-polyfill": "^0.3.2",
-    "rollup": "2.75.7",
+    "rollup": "2.76.0",
     "rollup-plugin-dts": "^4.2.2",
-    "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-postcss": "4.0.2",
     "rollup-plugin-visualizer": "5.6.0",
     "rollup-plugin-web-worker-loader": "1.6.1",
@@ -78,7 +77,7 @@
     "vscode-languageserver-protocol": "^3.17.1"
   },
   "resolutions": {
-    "eslint": "8.18.0"
+    "eslint": "8.19.0"
   },
   "browserslist": [
     "defaults",
@@ -89,6 +88,7 @@
     "not IE_Mob 11"
   ],
   "jest": {
+    "resolver": "<rootDir>/jest/resolver.js",
     "testEnvironment": "jest-environment-jsdom",
     "modulePathIgnorePatterns": [
       "<rootDir>/dist/"

package.json

@@ -5,9 +5,13 @@ import { nodeResolve } from '@rollup/plugin-node-resolve'
 import eslint from '@rollup/plugin-eslint'
 import { babel } from '@rollup/plugin-babel'
 import * as rollup from 'rollup'
-import builtins from 'rollup-plugin-node-builtins'
+import * as recast from 'recast'
+import path from 'path'
 import pkg from './package.json'
 
+const PURE_ANNO = '#__PURE__'
+const EXTENSION_DIR = path.resolve(__dirname, 'extensions')
+
 const externals = [
   ...Object.keys(pkg.dependencies),
   'monaco-editor'
@@ -20,17 +24,25 @@ export default rollup.defineConfig({
   input: {
     index: 'src/index.ts'
   },
+  treeshake: {
+    annotations: true,
+    moduleSideEffects: false
+  },
   external: function isExternal (source, importer, isResolved) {
     if (isResolved) {
       return false
     }
+    if (source.startsWith('extensions/')) {
+      return false
+    }
     if (externals.some(external => source === external || source.startsWith(`${external}/`))) {
       return true
     }
     return false
   },
   output: [{
     chunkFileNames: '[name].js',
+    hoistTransitiveImports: false,
     dir: 'dist',
     format: 'esm',
     paths: {
@@ -39,7 +51,6 @@ export default rollup.defineConfig({
     }
   }],
   plugins: [
-    builtins() as rollup.Plugin,
     eslint({
       throwOnError: true,
       throwOnWarning: true,
@@ -49,6 +60,15 @@ export default rollup.defineConfig({
       extensions,
       browser: true
     }),
+    {
+      name: 'resolve-extensions',
+      resolveId (id) {
+        if (id.startsWith('extensions/')) {
+          return path.resolve(__dirname, `${id}.js`)
+        }
+        return undefined
+      }
+    },
     commonjs({
       esmExternals: (id) => {
         if (id === 'vscode') {
@@ -93,6 +113,57 @@ export default rollup.defineConfig({
           right: ').then(module => module)'
         }
       }
+    },
+    {
+      name: 'improve-extension-treeshaking',
+      transform (code, id) {
+        if (id.startsWith(EXTENSION_DIR)) {
+          const ast = recast.parse(code, {
+            parser: require('recast/parsers/babylon')
+          })
+          let transformed: boolean = false
+          function addComment (node: recast.types.namedTypes.Expression) {
+            if (!(node.comments ?? []).some(comment => comment.value === PURE_ANNO)) {
+              transformed = true
+              node.comments = [recast.types.builders.commentBlock(PURE_ANNO, true)]
+            }
+          }
+          recast.visit(ast.program.body, {
+            visitNewExpression (path) {
+              const node = path.node
+              if (node.callee.type === 'Identifier') {
+                addComment(node)
+              }
+              this.traverse(path)
+            },
+            visitCallExpression (path) {
+              const node = path.node
+              if (node.callee.type === 'Identifier') {
+                addComment(node)
+              } else if (node.callee.type === 'FunctionExpression') {
+                // Mark IIFE as pure, because typescript compile enums as IIFE
+                addComment(node)
+              }
+              this.traverse(path)
+              return undefined
+            },
+            visitFunctionDeclaration () {
+              // Do not treeshake code inside functions, only at root
+              return false
+            },
+            visitThrowStatement () {
+              return false
+            }
+          })
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+          if (transformed) {
+            code = recast.print(ast).code
+            code = code.replace(/\/\*#__PURE__\*\/\s+/g, '/*#__PURE__*/ ') // Remove space after PURE comment
+            return code
+          }
+        }
+        return undefined
+      }
     }
   ]
 })

rollup.config.ts

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+
+rm -rf "`pwd`/extensions"
+mkdir -p "`pwd`/extensions"
+
+./scripts/install-java-extension

scripts/install-extensions

@@ -0,0 +1,38 @@
+#!/bin/bash
+set -e
+
+# In java, the vscode extension contains a lot of code to implement advanced features (jdt file provider, inlay hints, source action commands...)
+# Instead of copy-pasting this code, let's download it, build it and import it from our code
+
+output_directory="`pwd`/extensions/java"
+
+build_directory=`mktemp -d`
+echo "Downloading extension in $build_directory..."
+
+curl -L --max-redirs 5 https://github.com/redhat-developer/vscode-java/tarball/v1.8.0 | tar -xz -C $build_directory --strip-components=1 redhat-developer-vscode-java-a0ac341
+cd $build_directory
+
+echo "Installing dependencies..."
+npm install -y
+
+# Remove useless files
+rm -rf test
+
+echo "Patching code..."
+cd src
+
+# Change import syntax so it builds to ESM
+find . -type f -exec sed -E -i 's/import (.*) = require\((.*)\)/import * as \1 from \2/g' {} \;
+
+# Import from vscode-languageclient/lib/common/api instead of vscode-languageclient/node
+sed -i -E 's/import \{ (.*)LanguageClient(.*) \} from [\x27"]vscode-languageclient\/node[\x27"];/import { \1BaseLanguageClient as LanguageClient\2 } from \x27vscode-languageclient\/lib\/common\/api\x27;/g' sourceAction.ts inlayHintsProvider.ts
+
+# Change syntax due to incompatibility between vscode-languageclient versions
+sed -i -E 's/languageClient.protocol2CodeConverter.asWorkspaceEdit\(/await languageClient.protocol2CodeConverter.asWorkspaceEdit(/g' sourceAction.ts extension.ts
+sed -i 's/function applyWorkspaceEdit(obj, languageClient): Thenable<boolean>/async function applyWorkspaceEdit(obj, languageClient): Promise<boolean>/g' extension.ts
+
+echo "Building extension..."
+tsc --declaration --importHelpers --module es2020 --outDir "$output_directory/"
+
+echo "Cleaning..."
+rm -rf $build_directory

scripts/install-java-extension

@@ -134,7 +134,7 @@ class CGLSPConnectionProvider implements IConnectionProvider {
   }
 }
 
-function createLanguageClient (
+async function createLanguageClient (
   id: LanguageClientId,
   infrastructure: Infrastructure,
   {
@@ -145,7 +145,7 @@ function createLanguageClient (
   }: LanguageClientOptions,
   errorHandler: ErrorHandler,
   middleware?: Middleware
-): MonacoLanguageClient {
+): Promise<MonacoLanguageClient> {
   const client = new MonacoLanguageClient({
     id: `${id}-languageclient`,
     name: `CodinGame ${id} Language Client`,
@@ -165,7 +165,7 @@ function createLanguageClient (
   client.registerTextDocumentSaveFeatures()
 
   if (createAdditionalFeatures != null) {
-    client.registerFeatures(createAdditionalFeatures(client))
+    client.registerFeatures(await createAdditionalFeatures(client))
   }
 
   return client

src/createLanguageClient.ts

@@ -1,4 +1,4 @@
-import { loadConfigurationForExtension } from '@codingame/monaco-editor-wrapper/dist/features/extensionConfigurations'
+import { loadConfigurationForExtension } from '@codingame/monaco-editor-wrapper/features/extensionConfigurations'
 import { getLanguageClientOptions, LanguageClientId } from './languageClientOptions'
 
 /**

src/extensionConfiguration.ts

@@ -1,20 +1,17 @@
-import {
-  Disposable, MonacoLanguageClient
-} from 'monaco-languageclient'
-import { StaticFeature, FeatureState, ProtocolRequestType } from 'vscode-languageclient/lib/common/api'
+import { MonacoLanguageClient } from 'monaco-languageclient'
+import { ProtocolRequestType } from 'vscode-languageclient/lib/common/api'
 import { DocumentSelector, ServerCapabilities } from 'vscode-languageserver-protocol'
 import * as vscode from 'vscode'
+import { ExtensionFeature } from './tools'
 
 export const ResolveCobolSubroutineRequestType = new ProtocolRequestType<string, string | undefined, never, void, void>('cobol/resolveSubroutine')
-export class CobolResolveSubroutineFeature implements StaticFeature {
-  private onRequestDisposable: Disposable | undefined
+export class CobolResolveSubroutineFeature extends ExtensionFeature {
   constructor (private languageClient: MonacoLanguageClient) {
+    super()
   }
 
-  fillClientCapabilities (): void {}
-
-  initialize (capabilities: ServerCapabilities, documentSelector: DocumentSelector): void {
-    this.onRequestDisposable = this.languageClient.onRequest(ResolveCobolSubroutineRequestType, (routineName: string): string | undefined => {
+  activate (context: vscode.ExtensionContext, capabilities: ServerCapabilities, documentSelector: DocumentSelector): void {
+    context.subscriptions.push(this.languageClient.onRequest(ResolveCobolSubroutineRequestType, (routineName: string): string | undefined => {
       const constantRoutinePaths: Partial<Record<string, string>> = {
         'assert-equals': `file:${vscode.workspace.rootPath ?? '/tmp/project'}/deps/assert-equals.cbl`
       }
@@ -26,16 +23,6 @@ export class CobolResolveSubroutineFeature implements StaticFeature {
         .filter(textDocument => vscode.languages.match(documentSelector, textDocument))
         .filter(document => document.getText().match(new RegExp(`PROGRAM-ID\\.\\W+${routineName}\\.`, 'gi')))
         .sort((a, b) => a.uri.toString().localeCompare(b.uri.toString()))[0]?.uri.toString()
-    })
-  }
-
-  getState (): FeatureState {
-    return {
-      kind: 'static'
-    }
-  }
-
-  dispose (): void {
-    this.onRequestDisposable?.dispose()
+    }))
   }
 }