Update all packages to esm (#1125)

Co-authored-by: Kai Salmen <[email protected]>

Author: msujew

.github/workflows/actions.yml

@@ -23,7 +23,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v3
       with:
-        node-version: '16'
+        node-version: '18'
     - name: Build
       shell: bash
       run: |
@@ -44,7 +44,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v3
       with:
-        node-version: '16'
+        node-version: '18'
     - name: Build
       shell: bash
       run: |

examples/arithmetics/bin/cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../out/cli/cli.js';

examples/arithmetics/bin/cli.js

@@ -0,0 +1,26 @@
+//@ts-check
+import * as esbuild from 'esbuild';
+
+const watch = process.argv.includes('--watch');
+
+const ctx = await esbuild.context({
+    entryPoints: ['src/extension.ts', 'src/language-server/main.ts'],
+    outdir: 'out',
+    outExtension: {
+        '.js': '.cjs'
+    },
+    bundle: true,
+    target: "ES2017",
+    format: 'cjs',
+    loader: { '.ts': 'ts' },
+    external: ['vscode'],
+    platform: 'node',
+    sourcemap: true
+});
+
+if (watch) {
+    await ctx.watch();
+} else {
+    await ctx.rebuild();
+    ctx.dispose();
+}

examples/arithmetics/esbuild.mjs

@@ -44,32 +44,30 @@
         "language-configuration.json"
     ],
     "bin": {
-        "arithmetics-cli": "./bin/cli"
+        "arithmetics-cli": "./bin/cli.js"
     },
-    "main": "./out/extension.js",
-    "types": "./out/extension.d.ts",
+    "type": "module",
+    "main": "./out/extension.cjs",
     "exports": {
-        ".": {
-            "types": "./out/extension.d.ts",
-            "default": "./out/extension.js"
-        },
-        "./api": {
-            "types": "./out/language-server/generated/ast.d.ts",
-            "default": "./out/language-server/generated/ast.js"
-        }
+      ".": {
+        "types": "./out/extension.d.ts",
+        "default": "./out/extension.js"
+      },
+      "./api": {
+        "types": "./out/language-server/generated/ast.d.ts",
+        "default": "./out/language-server/generated/ast.js"
+      }
     },
     "scripts": {
-        "vscode:prepublish": "npm run build && npm run lint",
-        "build": "tsc",
-        "watch": "tsc -watch",
+        "build": "node esbuild.mjs",
+        "watch": "node esbuild.mjs --watch",
         "lint": "eslint src test --ext ts",
         "langium:generate": "langium generate",
-        "langium:watch": "langium generate --watch",
         "publish:next": "npm --no-git-tag-version version \"$(semver $npm_package_version -i minor)-next.$(git rev-parse --short HEAD)\" && npm publish --tag next",
         "publish:latest": "npm publish --tag latest --access public"
     },
     "dependencies": {
-        "chalk": "~4.1.2",
+        "chalk": "~5.3.0",
         "commander": "~10.0.0",
         "langium": "~1.2.0",
         "vscode-languageclient": "~8.0.2",
@@ -79,8 +77,8 @@
         "langium-cli": "~1.2.0"
     },
     "volta": {
-        "node": "16.19.0",
-        "npm": "8.19.3"
+        "node": "18.17.0",
+        "npm": "9.5.1"
     },
     "repository": {
         "type": "git",

examples/arithmetics/package.json

@@ -5,10 +5,10 @@
  ******************************************************************************/
 
 import type { AstNode, LangiumDocument, LangiumServices } from 'langium';
-import fs from 'fs';
-import path from 'path';
+import { URI } from 'langium';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import chalk from 'chalk';
-import { URI } from 'vscode-uri';
 
 export async function extractDocument<T extends AstNode>(fileName: string, extensions: readonly string[], services: LangiumServices): Promise<LangiumDocument<T>> {
     if (!extensions.includes(path.extname(fileName))) {

examples/arithmetics/src/cli/cli-util.ts

@@ -6,14 +6,19 @@
 
 import 'chalk';
 import { Command } from 'commander';
-import { ArithmeticsLanguageMetaData } from '../language-server/generated/module';
-import { evalAction } from './interpreter';
+import { ArithmeticsLanguageMetaData } from '../language-server/generated/module.js';
+import { evalAction } from './interpreter.js';
+import * as url from 'node:url';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
+const packagePath = path.resolve(__dirname, '..', '..', 'package.json');
+const packageContent = await fs.readFile(packagePath, 'utf-8');
 
 const program = new Command();
 
-program
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    .version(require('../../package.json').version);
+program.version(JSON.parse(packageContent).version);
 
 program
     .command('eval')

examples/arithmetics/src/cli/cli.ts

@@ -4,13 +4,13 @@
  * terms of the MIT License, which is available in the project root.
  ******************************************************************************/
 
-import type { Module } from '../language-server/generated/ast';
+import type { Module } from '../language-server/generated/ast.js';
 import { NodeFileSystem } from 'langium/node';
-import { createArithmeticsServices } from '../language-server/arithmetics-module';
-import { ArithmeticsLanguageMetaData } from '../language-server/generated/module';
-import { extractDocument } from './cli-util';
+import { createArithmeticsServices } from '../language-server/arithmetics-module.js';
+import { ArithmeticsLanguageMetaData } from '../language-server/generated/module.js';
+import { extractDocument } from './cli-util.js';
 import chalk from 'chalk';
-import { interpretEvaluations } from '../language-server/arithmetics-evaluator';
+import { interpretEvaluations } from '../language-server/arithmetics-evaluator.js';
 
 export const evalAction = async (fileName: string): Promise<void> => {
     const services = createArithmeticsServices(NodeFileSystem).arithmetics;

examples/arithmetics/src/cli/interpreter.ts

@@ -4,10 +4,10 @@
  * terms of the MIT License, which is available in the project root.
  ******************************************************************************/
 
-import type { LanguageClientOptions, ServerOptions } from 'vscode-languageclient/node';
+import type { LanguageClientOptions, ServerOptions } from 'vscode-languageclient/node.js';
 import * as vscode from 'vscode';
-import * as path from 'path';
-import { LanguageClient, TransportKind } from 'vscode-languageclient/node';
+import * as path from 'node:path';
+import { LanguageClient, TransportKind } from 'vscode-languageclient/node.js';
 
 let client: LanguageClient;
 
@@ -25,7 +25,7 @@ export function deactivate(): Thenable<void> | undefined {
 }
 
 function startLanguageClient(context: vscode.ExtensionContext): LanguageClient {
-    const serverModule = context.asAbsolutePath(path.join('out', 'language-server', 'main'));
+    const serverModule = context.asAbsolutePath(path.join('out', 'language-server', 'main.cjs'));
     // The debug options for the server
     // --inspect=6009: runs the server in Node's Inspector mode so VS Code can attach to the server for debugging
     const debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] };

examples/arithmetics/src/extension.ts

@@ -3,9 +3,9 @@
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
  ******************************************************************************/
-import type { AbstractDefinition, Definition, Evaluation, Expression, Module, Statement } from './generated/ast';
-import { isBinaryExpression, isDefinition, isEvaluation, isFunctionCall, isNumberLiteral } from './generated/ast';
-import { applyOp } from './arithmetics-util';
+import type { AbstractDefinition, Definition, Evaluation, Expression, Module, Statement } from './generated/ast.js';
+import { isBinaryExpression, isDefinition, isEvaluation, isFunctionCall, isNumberLiteral } from './generated/ast.js';
+import { applyOp } from './arithmetics-util.js';
 
 export function interpretEvaluations(module: Module): Map<Evaluation, number> {
     const ctx = <InterpreterContext>{

examples/arithmetics/src/language-server/arithmetics-evaluator.ts

@@ -6,9 +6,9 @@
 
 import type { DefaultSharedModuleContext, LangiumServices, LangiumSharedServices, Module, PartialLangiumServices } from 'langium';
 import { createDefaultModule, createDefaultSharedModule, inject } from 'langium';
-import { ArithmeticsGeneratedModule, ArithmeticsGeneratedSharedModule } from './generated/module';
-import { ArithmeticsValidator, registerValidationChecks } from './arithmetics-validator';
-import { ArithmeticsScopeProvider } from './arithmetics-scope-provider';
+import { ArithmeticsGeneratedModule, ArithmeticsGeneratedSharedModule } from './generated/module.js';
+import { ArithmeticsValidator, registerValidationChecks } from './arithmetics-validator.js';
+import { ArithmeticsScopeProvider } from './arithmetics-scope-provider.js';
 
 /**
  * Declaration of custom services - add your own service classes here.

examples/arithmetics/src/language-server/arithmetics-module.ts

@@ -4,7 +4,7 @@
  * terms of the MIT License, which is available in the project root.
  ******************************************************************************/
 
-import type { BinaryExpression } from './generated/ast';
+import type { BinaryExpression } from './generated/ast.js';
 
 export function applyOp(op: BinaryExpression['operator']): (x: number, y: number) => number {
     switch (op) {

examples/arithmetics/src/language-server/arithmetics-util.ts

@@ -4,13 +4,13 @@
  * terms of the MIT License, which is available in the project root.
  ******************************************************************************/
 
-import type { ArithmeticsAstType, Definition, Expression, BinaryExpression, Module, DeclaredParameter, FunctionCall } from './generated/ast';
-import type { ArithmeticsServices } from './arithmetics-module';
+import type { ArithmeticsAstType, Definition, Expression, BinaryExpression, Module, DeclaredParameter, FunctionCall } from './generated/ast.js';
+import type { ArithmeticsServices } from './arithmetics-module.js';
 import type { ValidationChecks, ValidationAcceptor } from 'langium';
-import { isNumberLiteral, isFunctionCall, isBinaryExpression } from './generated/ast';
-import { applyOp } from './arithmetics-util';
+import { isNumberLiteral, isFunctionCall, isBinaryExpression } from './generated/ast.js';
+import { applyOp } from './arithmetics-util.js';
 import { MultiMap } from 'langium';
-import { evalExpression } from './arithmetics-evaluator';
+import { evalExpression } from './arithmetics-evaluator.js';
 
 export function registerValidationChecks(services: ArithmeticsServices): void {
     const registry = services.validation.ValidationRegistry;

examples/arithmetics/src/language-server/arithmetics-validator.ts

@@ -4,8 +4,8 @@
  ******************************************************************************/
 
 import type { LangiumGeneratedServices, LangiumGeneratedSharedServices, LangiumSharedServices, LangiumServices, LanguageMetaData, Module } from 'langium';
-import { ArithmeticsAstReflection } from './ast';
-import { ArithmeticsGrammar } from './grammar';
+import { ArithmeticsAstReflection } from './ast.js';
+import { ArithmeticsGrammar } from './grammar.js';
 
 export const ArithmeticsLanguageMetaData = {
     languageId: 'arithmetics',

examples/arithmetics/src/language-server/generated/module.ts

@@ -4,12 +4,12 @@
  * terms of the MIT License, which is available in the project root.
  ******************************************************************************/
 
-import type { Diagnostic, Range } from 'vscode-languageserver/browser';
+import type { Diagnostic, Range } from 'vscode-languageserver/browser.js';
 import { startLanguageServer, EmptyFileSystem, DocumentState } from 'langium';
-import { BrowserMessageReader, BrowserMessageWriter, createConnection, NotificationType } from 'vscode-languageserver/browser';
-import { createArithmeticsServices } from './arithmetics-module';
-import { interpretEvaluations } from './arithmetics-evaluator';
-import type { Module } from './generated/ast';
+import { BrowserMessageReader, BrowserMessageWriter, createConnection, NotificationType } from 'vscode-languageserver/browser.js';
+import { createArithmeticsServices } from './arithmetics-module.js';
+import { interpretEvaluations } from './arithmetics-evaluator.js';
+import type { Module } from './generated/ast.js';
 
 /* browser specific setup code */
 const messageReader = new BrowserMessageReader(self);

examples/arithmetics/src/language-server/main-browser.ts

@@ -6,8 +6,8 @@
 
 import { startLanguageServer } from 'langium';
 import { NodeFileSystem } from 'langium/node';
-import { createConnection, ProposedFeatures } from 'vscode-languageserver/node';
-import { createArithmeticsServices } from './arithmetics-module';
+import { createConnection, ProposedFeatures } from 'vscode-languageserver/node.js';
+import { createArithmeticsServices } from './arithmetics-module.js';
 
 const connection = createConnection(ProposedFeatures.all);
 

examples/arithmetics/src/language-server/main.ts

@@ -6,7 +6,7 @@
 
 import type { ExecException } from 'child_process';
 import { describe, expect, test } from 'vitest';
-import path from 'path';
+import * as path from 'node:path';
 import { exec } from 'child_process';
 
 describe('Test the arithmetics CLI', () => {

examples/arithmetics/test/arithmetics-cli.test.ts

@@ -1,16 +1,12 @@
+// this file is required for VSCode to work properly
 {
-    "extends": "../../tsconfig.json",
-    "compilerOptions": {
-      "rootDir": "src",
-      "outDir": "out",
-      "lib": ["ESNext", "WebWorker"]
-    },
-    "references": [{ "path": "../../packages/langium" }],
-    "include": [
-      "src/**/*"
-    ],
-    "exclude": [
-      "out",
-      "/node_modules"
-    ]
-  }
+  "extends": "./tsconfig.src.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "rootDir": "."
+  },
+  "include": [
+    "src/**/*",
+    "test/**/*"
+  ]
+}

examples/arithmetics/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "out",
+    "lib": ["ESNext", "WebWorker"]
+  },
+  "references": [{
+      "path": "../../packages/langium/tsconfig.src.json"
+  }],
+  "include": [
+    "src/**/*"
+  ]
+}

examples/arithmetics/tsconfig.src.json

@@ -1,11 +1,11 @@
 {
-  "extends": "./tsconfig.json",
+  "extends": "./tsconfig.src.json",
   "compilerOptions": {
     "noEmit": true,
     "rootDir": "test"
   },
   "references": [{
-    "path": "tsconfig.json"
+    "path": "./tsconfig.src.json"
   }],
   "include": [
     "test/**/*",

examples/arithmetics/tsconfig.test.json

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../out/cli/cli.js';

examples/domainmodel/bin/cli

@@ -0,0 +1,26 @@
+//@ts-check
+import * as esbuild from 'esbuild';
+
+const watch = process.argv.includes('--watch');
+
+const ctx = await esbuild.context({
+    entryPoints: ['src/extension.ts', 'src/language-server/main.ts'],
+    outdir: 'out',
+    outExtension: {
+        '.js': '.cjs'
+    },
+    bundle: true,
+    target: "ES2017",
+    format: 'cjs',
+    loader: { '.ts': 'ts' },
+    external: ['vscode'],
+    platform: 'node',
+    sourcemap: true
+});
+
+if (watch) {
+    await ctx.watch();
+} else {
+    await ctx.rebuild();
+    ctx.dispose();
+}