feat: upgrade all packages to publish in ESM format as well as CommonJS

Author: Codeneos

.gitignore

@@ -8,6 +8,8 @@ retire-cache
 testReports
 tslint-report.json
 packages/*/lib
+packages/*/dist
+packages/*/out
 /coverage
 /packages/cli/dist
 *.tgz

.npmrc

@@ -1,7 +1,3 @@
-hoist=true
-node-linker=isolated
-public-hoist-pattern[]['*eslint*', '*prettier*', '@oclif/command']
-package-import-method=clone-or-copy
 strict-peer-dependencies=false
 prefer-workspace-packages=true
 shell-emulator=true

.vscode/tasks.json

@@ -75,7 +75,7 @@
                     }
                 }
             ],
-            "dependsOn": ["watch-vlocity-deploy"]
+            //"dependsOn": ["watch-vlocity-deploy"]
         },
         {
             "label": "watch-cli",

package.json

@@ -32,7 +32,7 @@
         "@types/node": "~20.17",
         "@typescript-eslint/eslint-plugin": "^8.1.0",
         "@typescript-eslint/parser": "^8.1.0",
-        "chalk": "^4.1.2",
+        "esbuild": "^0.25.4",
         "eslint": "^8.57.0",
         "eslint-config-prettier": "^8.10.0",
         "eslint-plugin-import": "^2.29.1",
@@ -45,7 +45,7 @@
         "jest-junit": "^16.0.0",
         "jest-sonar": "^0.2.16",
         "js-yaml": "^4.1.0",
-        "lint-staged": "^13.1.0",
+        "lint-staged": "^16.0.0",
         "log-symbols": "^4.1.0",
         "prettier": "^3.3.3",
         "ts-jest": "^29.3.4",
@@ -138,11 +138,9 @@
         "@salesforce/core@^3": "3.31.18",
         "@salesforce/core@^2": "2.37.1",
         "@types/jsforce": "1.9.42",
-        "chalk": "^4.1.2",
         "js-yaml": "^4.1.0",
         "typescript": "5.1.6",
         "xml2js": "^0.5.0",
-        "esbuild": "^0.20.1",
         "jsonwebtoken": "^9.0.0",
         "braces": "^3.0.3",
         "punycode": "^2.3.1"

packages/apex/package.json

@@ -9,10 +9,11 @@
         "Parser",
         "Grammar"
     ],
-    "main": "lib/index.js",
+    "main": "src/index.ts",
     "publishConfig": {
-        "main": "lib/index.js",
-        "typings": "lib/index.d.ts"
+        "main": "dist/index.cjs",
+        "module": "dist/index.mjs",
+        "typings": "dist/index.d.ts"
     },
     "readme": "../SITE.md",
     "directories": {
@@ -22,11 +23,13 @@
         "node": ">=20.0.0"
     },
     "scripts": {
-        "build": "tsc",
-        "clean": "shx rm -rf ./lib ./coverage ./tsconfig.tsbuildinfo './*.tgz' './src/**/*.{d.ts,ts.map,js.map,js}'",
-        "watch": "tsc -w",
-        "pack": "pnpm run build && pnpm pack",
-        "prepublish": "pnpm run build",
+        "clean": "shx rm -rf ./lib ./dist ./coverage ./tsconfig.tsbuildinfo './*.tgz' './src/**/*.{d.ts,ts.map,js.map,js}'",
+        "build": "tsc --emitDeclarationOnly && pnpm bundle",
+        "bundle": "node ../../scripts/esbuild.mjs --entrypoint ./src/index.ts",
+        "watch": "pnpm bundle --watch",
+        "pack": "pnpm build && pnpm pack",
+        "prepublish": "pnpm build",
+        "test": "jest",
         "build-grammar": "antlr4ng -Dlanguage=TypeScript -o ./src/grammar -visitor -listener ./grammar/ApexLexer.g4 ./grammar/ApexParser.g4"
     },
     "repository": {
@@ -38,8 +41,9 @@
         "email": "[email protected]"
     },
     "files": [
-        "lib/**/*.d.ts",
-        "lib/**/*.js",
+        "dist/**/*.d.ts",
+        "dist/index.cjs",
+        "dist/index.mjs",
         "lib/**/*.json",
         "patches/*.patch",
         "../SITE.md"
@@ -58,6 +62,7 @@
         "@types/node": "~20.17",
         "@types/tough-cookie": "^4.0.2",
         "antlr4ng-cli": "^2.0.0",
+        "esbuild": "^0.25.4",
         "jest": "^29.7.0",
         "nugget": "^2.2.0",
         "shx": "^0.3.4",

packages/apex/tsconfig.json

@@ -2,7 +2,8 @@
     "extends": "../../tsconfig",
     "compilerOptions": {
         "composite": true,
-        "outDir": "lib",
+        "module": "esnext",
+        "outDir": "dist",
         "rootDir": "src",
         "declaration": true,
         "declarationMap": true,

packages/cli/package.json

@@ -8,13 +8,12 @@
         "Datapacks",
         "Deployment"
     ],
-    "main": "lib/index.js",
     "bin": {
         "vlocode": "bin/run"
     },
+    "main": "src/index.ts",
     "publishConfig": {
-        "main": "lib/index.js",
-        "typings": "lib/index.d.ts"
+        "main": "dist/cli.js"
     },
     "readme": "./README.md",
     "directories": {
@@ -62,15 +61,15 @@
         "@vlocode/util": "workspace:*",
         "@vlocode/vlocity": "workspace:*",
         "@vlocode/vlocity-deploy": "workspace:*",
-        "chalk": "^4.1.1",
+        "chalk": "^5.4.1",
         "commander": "^11.1.0",
+        "esbuild": "^0.25.4",
         "esbuild-loader": "^4.3.0",
         "glob": "^11.0.2",
         "jest": "^29.7.0",
         "js-yaml": "^4.1.0",
         "log-symbols": "^4.0.0",
         "shx": "^0.3.4",
-        "source-map-support": "^0.5.21",
         "ts-jest": "^29.3.4",
         "ts-loader": "^9.5.2",
         "ts-node": "^10.9.2",

packages/cli/src/index.ts

@@ -4,7 +4,6 @@ import * as path from 'path';
 import { Command, Option } from 'commander';
 import { FancyConsoleWriter, container, Logger, LogLevel, LogManager, ConsoleWriter } from '@vlocode/core';
 import { getErrorMessage } from '@vlocode/util';
-import { Command as CliCommand } from './command';
 
 // @ts-ignore
 const nodeRequire = typeof __non_webpack_require__ === 'function' ? __non_webpack_require__ : require;
@@ -38,7 +37,6 @@ class CLI {
         if (CLI.isVerbose || CLI.isDebug) {
             LogManager.registerWriter(new FancyConsoleWriter());
             if (CLI.isDebug) {
-                import('source-map-support/register');
                 LogManager.setGlobalLogLevel(LogLevel.debug);
             } else {
                 LogManager.setGlobalLogLevel(LogLevel.verbose);
@@ -62,6 +60,7 @@ class CLI {
 
     constructor(private commandsFolder: string) {
         this.logger.verbose(this.versionString);
+        debugger; // eslint-disable-line no-debugger
         this.program = new Command()
             .name(CLI.programName)
             .description(CLI.description)

packages/cli/tsconfig.json

@@ -1,20 +1,11 @@
 {
     "extends": "../../tsconfig",
     "compilerOptions": {
-        "outDir": "lib",
+        "outDir": "dist",
         "rootDir": "src",
         "baseUrl": "src",
         "declaration": true,
         "declarationMap": true
     },
-    "include": ["src/**/*"],
-    "references": [
-        { "path": "../util" },
-        { "path": "../apex" },
-        { "path": "../core" },
-        { "path": "../salesforce" },
-        { "path": "../vlocity" },
-        { "path": "../omniscript" },
-        { "path": "../vlocity-deploy" }
-    ]
+    "include": ["src/**/*"]
 }

packages/cli/webpack/webpack.mjs

@@ -3,6 +3,7 @@ import { glob } from 'glob';
 import webpack from 'webpack';
 import { existsSync, readFileSync, readdirSync } from 'fs';
 import { EsbuildPlugin } from 'esbuild-loader';
+import { sourceMapsEnabled } from 'process';
 
 const packageExternals = [
     'vscode',
@@ -28,6 +29,7 @@ const common = {
     name: 'vlocode-cli',
     mode: 'production',
     context: contextFolder,
+    devtool: 'source-map',
     target: 'node',
     entry:
         glob.sync(
@@ -85,7 +87,6 @@ const common = {
         __filename: false
     },
     optimization: {
-        runtimeChunk: false,
         concatenateModules: true,
         mergeDuplicateChunks: true,
         mangleExports: false,
@@ -94,16 +95,11 @@ const common = {
         providedExports: false,
         usedExports: false,
         portableRecords: true,
-        splitChunks: false,
-        minimize: true,
-        minimizer: [
-            new EsbuildPlugin({
-                target: 'es2020',
-                keepNames: true,
-                minify: true,
-                legalComments: 'external'
-            })
-        ]
+        minimize: false,
+        splitChunks: {
+            minSize: 20000,
+            chunks: 'all'
+        },
     },
     externals: function({ request }, callback) {
         const isExternal = packageExternals.some(

packages/core/package.json

@@ -2,10 +2,11 @@
     "name": "@vlocode/core",
     "version": "1.28.2",
     "description": "Vlocode core IoC container framework library",
-    "main": "lib/index.js",
+    "main": "src/index.ts",
     "publishConfig": {
-        "main": "lib/index.js",
-        "typings": "lib/index.d.ts"
+        "main": "dist/index.cjs",
+        "module": "dist/index.mjs",
+        "typings": "dist/index.d.ts"
     },
     "readme": "../SITE.md",
     "directories": {
@@ -15,11 +16,12 @@
         "node": ">=20.0.0"
     },
     "scripts": {
-        "build": "tsc",
-        "clean": "shx rm -rf ./lib ./coverage ./tsconfig.tsbuildinfo './src/**/*.{d.ts,ts.map,js.map,js}'",
-        "watch": "tsc -w",
+        "clean": "shx rm -rf ./lib ./dist ./coverage ./tsconfig.tsbuildinfo './*.tgz' './src/**/*.{d.ts,ts.map,js.map,js}'",
+        "build": "tsc --emitDeclarationOnly && pnpm bundle",
+        "bundle": "node ../../scripts/esbuild.mjs --entrypoint ./src/index.ts",
+        "watch": "pnpm bundle --watch",
         "pack": "pnpm pack",
-        "prepublish": "pnpm run build"
+        "prepublish": "pnpm build"
     },
     "repository": {
         "type": "git",
@@ -30,8 +32,9 @@
         "email": "[email protected]"
     },
     "files": [
-        "lib/**/*.d.ts",
-        "lib/**/*.js",
+        "dist/**/*.d.ts",
+        "dist/index.cjs",
+        "dist/index.mjs",
         "patches/*.patch",
         "../SITE.md"
     ],
@@ -44,14 +47,15 @@
         "@types/jest": "^29.5.11",
         "@types/luxon": "^3.3.0",
         "@types/node": "~20.17",
+        "esbuild": "^0.25.4",
         "jest": "^29.7.0",
         "shx": "^0.3.4",
         "ts-jest": "^29.3.4",
         "typescript": "5.1.6"
     },
     "dependencies": {
         "@vlocode/util": "workspace:*",
-        "chalk": "^4.1.1",
+        "chalk": "^5.4.1",
         "fast-glob": "^3.3.3",
         "luxon": "^3.4.4",
         "memfs": "^4.17.0",

packages/core/src/logging/writers/fancyConsoleWriter.ts

@@ -1,5 +1,5 @@
 import { LogWriter, LogEntry, LogLevel } from '..';
-import chalk from 'chalk';
+import { Chalk } from 'chalk';
 import { DateTime } from 'luxon';
 
 export class FancyConsoleWriterOptions { 
@@ -12,7 +12,7 @@ export class FancyConsoleWriterOptions {
 export class FancyConsoleWriter implements LogWriter {
 
     private readonly options: FancyConsoleWriterOptions;
-    private readonly chalk = new chalk.Instance({ level: 2 });
+    private readonly chalk = new Chalk({ level: 2 });
     private readonly colors = {
         [LogLevel.debug]: this.chalk.magenta,
         [LogLevel.verbose]: this.chalk.dim,

packages/core/src/logging/writers/terminalWriter.ts

@@ -1,5 +1,5 @@
 import type * as vscode from 'vscode';
-import chalk from 'chalk';
+import { Chalk } from 'chalk';
 import { DateTime } from 'luxon';
 import { LogLevel, LogWriter, LogEntry } from '../../logging';
 
@@ -18,7 +18,8 @@ export class TerminalWriter implements LogWriter {
     private terminalWatchdog? : any;
     private isOpened = false;
     private readonly queuedMessages : LogEntry[] = [];
-    private readonly chalk = new chalk.Instance({ level: 2 });
+    private readonly chalk = new Chalk({ level: 2 });
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     private readonly vscode: typeof vscode = require('vscode');
     private readonly colors = {
         [LogLevel.debug]: this.chalk.magenta,

packages/core/tsconfig.json

@@ -2,7 +2,7 @@
     "extends": "../../tsconfig",
     "compilerOptions": {
         "composite": true,
-        "outDir": "lib",
+        "outDir": "dist",
         "rootDir": "src",
         "declaration": true,
         "declarationMap": true