Feature/language service plugin

.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/typescript-node:0-18",
+	"features": {
+		"ghcr.io/devcontainers-contrib/features/pnpm:2": {}
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [3000],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "npm i -g turbo && pnpm install && git config --global core.editor 'code --wait'",
+
+	// Configure tool-specific properties.
+	"customizations": {
+    "vscode": {
+      "extensions": [
+        "dbaeumer.vscode-eslint"
+      ]
+    }
+  }
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.gitignore

@@ -4,6 +4,7 @@
 node_modules
 .pnp
 .pnp.js
+.pnpm-store/
 
 # testing
 coverage

.vscode/extensions.json

@@ -2,6 +2,7 @@
 	// See http://go.microsoft.com/fwlink/?LinkId=827846
 	// for the documentation about the extensions.json format
 	"recommendations": [
-		"dbaeumer.vscode-eslint"
-	]
+    "dbaeumer.vscode-eslint",
+    "ms-vscode-remote.remote-containers"
+  ]
 }

.vscode/settings.json

@@ -7,5 +7,6 @@
         "out": true // set this to false to include "out" folder in search results
     },
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off"
+    "typescript.tsc.autoDetect": "off",
+    "typescript.tsserver.log": "normal"
 }

CONTRIBUTING.md

@@ -12,14 +12,22 @@ Your contributions will eventually help save countless hours for people struggli
 1. Node.js version installed, [latest LTS is recommended](https://nodejs.org/en/about/releases/)
 2. Install pnpm
 
+### Using [devcontainer](https://code.visualstudio.com/docs/devcontainers/create-dev-container)
+
+Devcontainers is an easy way to avoid "works on my machine" situations. Essentially, the development happens in a Docker container.
+
+1. Make sure you've got Docker installed on your machine
+2. Do install the recommended by VSCode extensions
+3. Click "Reopen in Container" button in a popup
+
 ## How to start developing?
 
 Clone the repo and install the needed dependencies for all the packages by following these steps:
 
 ```sh
 git clone https://github.com/mattpocock/ts-error-translator.git
 cd ts-error-translator
-pnpm
+pnpm install
 pnpm dev # This will run the next app
 ```
 

packages/engine/package.json

@@ -2,11 +2,12 @@
   "name": "@total-typescript/error-translation-engine",
   "version": "1.0.3",
   "license": "MIT",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "./out/index.js",
+  "types": "./out/index.d.ts",
   "private": true,
   "scripts": {
-    "test": "vitest run"
+    "test": "vitest run",
+    "build": "tsc"
   },
   "dependencies": {
     "front-matter": "^4.0.2"

packages/engine/tsconfig.json

@@ -1,9 +1,13 @@
 {
   "extends": "tsconfig/base.json",
+  "compilerOptions": {
+    "outDir": "out"
+  },
   "include": [
     "src"
   ],
   "exclude": [
-    "node_modules"
+    "node_modules",
+    "src/__tests__"
   ]
 }

packages/language-service-plugin/README.MD

@@ -0,0 +1,11 @@
+# Language Service Plugin
+
+[Reference](https://github.com/microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin)
+
+To test this plugin out, compile the code and open the `example` folder in a VSCode instance:
+
+```
+code ./example
+```
+
+Also, please, make sure the workspace version of TypeScript is used. Use the `TypeScript: Select TypeScript version` command for this.

packages/language-service-plugin/example/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "typescript.tsserver.log": "normal",
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

packages/language-service-plugin/example/index.ts

@@ -0,0 +1,19 @@
+export function A(b: number): number {
+  return b;
+}
+A("test")
+
+
+let a: { m: number[] };
+let b = { m: [""] };
+a = b;
+
+// Extra Properties
+
+type A = { m: number };
+const w: A = { m: 10, n: "" };
+
+// Union Assignments
+
+type Thing = "none" | { name: string };
+const e: Thing = { name: 0 };

packages/language-service-plugin/example/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@total-typescript/language-service-plugin-example",
+  "version": "0.1.0",
+  "dependencies": {
+    "ts-error-translator-tssplugin": "file:..",
+    "typescript": "^4.5.3"
+  }
+}

packages/language-service-plugin/example/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "plugins": [{
+      "name": "ts-error-translator-tssplugin"
+    }]
+  }
+}

packages/language-service-plugin/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "ts-error-translator-tssplugin",
+  "version": "0.1.0",
+  "license": "MIT",
+  "main": "./out/index.js",
+  "private": true,
+  "files": [
+    "./out/**"
+  ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "rollup -c rollup.config.mjs"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "rollup": "^3.14.0",
+    "tsconfig": "workspace:*",
+    "typescript": "^4.5.3"
+  },
+  "dependencies": {
+    "@total-typescript/error-translation-engine": "workspace:*"
+  }
+}

packages/language-service-plugin/rollup.config.mjs

@@ -0,0 +1,21 @@
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import typescript from '@rollup/plugin-typescript';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+
+export default {
+  input: 'src/index.ts',
+  output: {
+    file: 'out/index.js',
+    sourcemap: true,
+    format: 'cjs'
+  },
+  plugins: [
+    nodeResolve({
+      extensions: ['.mjs', '.js', '.json', '.node', '.ts']
+    }),
+    commonjs({ extensions: ['.js', '.ts'] }),
+    typescript(),
+    json()
+  ]
+};

packages/language-service-plugin/src/index.ts

@@ -0,0 +1,53 @@
+import { parseErrors } from '@total-typescript/error-translation-engine';
+
+export default function init(modules: { typescript: typeof import("typescript/lib/tsserverlibrary") }) {
+  const ts = modules.typescript;
+
+  function withParsedError(messageText: string): string {
+    const parsed = parseErrors(messageText);
+    const allMessages = parsed.map(err => err.error).join('\n\n');
+    return `${messageText}\n\nIn other words,\n${allMessages}\n`;
+  }
+
+  function enrichDiagnostic(diagnostic: ts.Diagnostic): ts.Diagnostic {
+    if (typeof diagnostic.messageText === 'string') {
+      diagnostic.messageText = withParsedError(diagnostic.messageText);
+      return diagnostic;
+    }
+    if (diagnostic.messageText.category === ts.DiagnosticCategory.Error) {
+      const msg = withParsedError(diagnostic.messageText.messageText);
+      diagnostic.messageText.messageText = msg;
+
+      const nextMesgs = diagnostic.messageText.next;
+      if (nextMesgs) {
+        for (let i = 0; i < nextMesgs.length; i++) {
+          let nextMsg = nextMesgs[i];
+          nextMesgs[i].messageText = withParsedError(nextMsg.messageText);
+        }
+      }
+    }
+    return diagnostic;
+  }
+
+  function create(info: ts.server.PluginCreateInfo) {
+    // Set up decorator object
+    const proxy: ts.LanguageService = Object.create(null);
+
+    for (let k of Object.keys(info.languageService) as Array<keyof ts.LanguageService>) {
+      const x = info.languageService[k]!;
+      // @ts-expect-error - JS runtime trickery which is tricky to type tersely
+      proxy[k] = (...args: Array<{}>) => x.apply(info.languageService, args);
+    }
+
+    proxy.getSemanticDiagnostics = (filename) => {
+      return info.languageService.getSemanticDiagnostics(filename).map(enrichDiagnostic);
+    }
+
+    return proxy;
+  }
+
+  return { create };
+
+}
+
+// export = init;

packages/language-service-plugin/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "tsconfig/base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "outDir": "./out",
+    "rootDir": "src",
+    "strict": true,
+    "declaration": true,
+    "sourceMap": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules", "out"
+  ]
+}