Merge pull request #439 from salesforcecli/wr/esm

Wr/esm

.eslintignore

@@ -0,0 +1 @@
+*.cjs/

.gitignore

@@ -44,3 +44,5 @@ node_modules
 .idea
 
 oclif.manifest.json
+
+oclif.lock

.mocharc.json

@@ -1,8 +1,16 @@
 {
-  "require": "ts-node/register,source-map-support/register",
+  "require": [
+    "ts-node/register"
+  ],
   "watch-extensions": "ts",
-  "watch-files": ["src/**/*.ts", "test/**/*.ts"],
+  "watch-files": [
+    "src/**/*.ts",
+    "test/**/*.ts"
+  ],
   "recursive": true,
   "reporter": "spec",
-  "timeout": 5000
-}
+  "timeout": 5000,
+  "node-option": [
+    "loader=ts-node/esm"
+  ]
+}

bin/dev.cmd

@@ -1,3 +1,3 @@
 @echo off
-set NODE_ENV=development
-node "%~dp0\dev" %*
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

bin/dev.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+// eslint-disable-next-line node/shebang
+async function main() {
+  const {execute} = await import('@oclif/core')
+  await execute({development: true, dir: import.meta.url})
+}
+
+await main()

bin/run.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+// eslint-disable-next-line node/shebang
+async function main() {
+  const {execute} = await import('@oclif/core')
+  await execute({dir: import.meta.url})
+}
+
+await main()

package.json

@@ -5,56 +5,49 @@
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^2.15.0",
+    "@oclif/core": "^3.9.2",
     "@salesforce/core": "^5.3.17",
     "@salesforce/kit": "^3.0.15",
-    "@salesforce/sf-plugins-core": "^3.1.22",
+    "@salesforce/sf-plugins-core": "^4.0.0",
     "change-case": "^4.1.2",
     "fast-glob": "^3.3.1",
     "fast-xml-parser": "^4.3.2",
-    "inquirer": "^8.2.6",
-    "js2xmlparser": "^4.0.2",
-    "tslib": "^2"
+    "js2xmlparser": "^4.0.2"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^4.0.14",
-    "@oclif/test": "^2.5.6",
-    "@salesforce/cli-plugins-testkit": "^4.4.10",
+    "@oclif/plugin-command-snapshot": "^5.0.1",
+    "@salesforce/cli-plugins-testkit": "^5.0.0",
     "@salesforce/dev-scripts": "^6.0.3",
     "@salesforce/plugin-command-reference": "^3.0.44",
-    "@salesforce/ts-sinon": "1.4.19",
-    "@swc/core": "^1.3.37",
     "@types/inquirer": "^8.2.0",
-    "@types/shelljs": "^0.8.13",
     "eslint-plugin-sf-plugin": "^1.16.14",
-    "oclif": "^3.17.1",
-    "shelljs": "^0.8.4",
+    "oclif": "^4.0.3",
     "shx": "0.3.4",
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2"
   },
   "config": {},
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "/lib",
     "/messages",
     "/oclif.manifest.json",
-    "/schemas"
+    "/schemas",
+    "/oclif.lock"
   ],
   "homepage": "https://github.com/salesforcecli/plugin-sobject",
   "keywords": [
     "force",
     "salesforce",
-    "sfdx",
     "salesforcedx",
-    "sfdx-plugin",
+    "sf",
     "sf-plugin",
-    "sf"
+    "sfdx",
+    "sfdx-plugin"
   ],
   "license": "BSD-3-Clause",
-  "main": "lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "bin": "sf",
@@ -74,14 +67,15 @@
           }
         }
       }
-    }
+    },
+    "flexibleTaxonomy": true
   },
   "repository": "salesforcecli/plugin-sobject",
   "scripts": {
     "build": "wireit",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
-    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json oclif.lock",
     "compile": "wireit",
     "docs": "sf-docs",
     "format": "wireit",
@@ -173,7 +167,7 @@
       "output": []
     },
     "test:command-reference": {
-      "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
+      "command": "ts-node \"./bin/dev.js\" commandreference:generate --erroronwarnings",
       "files": [
         "src/**/*.ts",
         "messages/**",
@@ -184,7 +178,7 @@
       ]
     },
     "test:deprecation-policy": {
-      "command": "\"./bin/dev\" snapshot:compare",
+      "command": "ts-node \"./bin/dev.js\" snapshot:compare",
       "files": [
         "src/**/*.ts"
       ],
@@ -194,12 +188,14 @@
       ]
     },
     "test:json-schema": {
-      "command": "\"./bin/dev\" schema:compare",
+      "command": "ts-node \"./bin/dev.js\" schema:compare",
       "files": [
         "src/**/*.ts",
         "schemas"
       ],
       "output": []
     }
-  }
+  },
+  "exports": "./lib/index.js",
+  "type": "module"
 }

src/commands/schema/generate/field.ts

@@ -4,24 +4,25 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import * as fs from 'node:fs';
-import * as path from 'node:path';
+import fs  from 'node:fs';
+import path, {dirname} from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import { CustomField } from 'jsforce/api/metadata';
-import { convertJsonToXml } from '../../../shared/convert';
+import { convertJsonToXml } from '../../../shared/convert.js';
 import {
   descriptionPrompt,
   apiNamePrompt,
   objectPrompt,
   integerValidation,
   picklistPrompts,
-} from '../../../shared/prompts/prompts';
-import { relationshipFieldPrompts } from '../../../shared/prompts/relationshipField';
-import { isObjectsFolder, labelValidation } from '../../../shared/flags';
+} from '../../../shared/prompts/prompts.js';
+import { relationshipFieldPrompts } from '../../../shared/prompts/relationshipField.js';
+import { isObjectsFolder, labelValidation } from '../../../shared/flags.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-sobject', 'generate.field');
 
 const MAX_LONG_TEXT_LENGTH = 131072;

src/commands/schema/generate/platformevent.ts

@@ -5,15 +5,17 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+import { fileURLToPath } from 'node:url';
+import {dirname} from 'node:path';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
-import { apiNamePrompt, descriptionPrompt, directoryPrompt, pluralPrompt } from '../../../shared/prompts/prompts';
-import { writeObjectFile } from '../../../shared/fs';
-import { SaveablePlatformEvent } from '../../../shared/types';
-import { labelValidation } from '../../../shared/flags';
+import { apiNamePrompt, descriptionPrompt, directoryPrompt, pluralPrompt } from '../../../shared/prompts/prompts.js';
+import { writeObjectFile } from '../../../shared/fs.js';
+import { SaveablePlatformEvent } from '../../../shared/types.js';
+import { labelValidation } from '../../../shared/flags.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-sobject', 'generate.event');
 
 export type PlatformEventGenerateResult = {

src/commands/schema/generate/sobject.ts

@@ -5,6 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { dirname } from 'node:path';
+import {fileURLToPath} from 'node:url';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
@@ -15,12 +16,12 @@ import {
   pluralPrompt,
   apiNamePrompt,
   namePrompts,
-} from '../../../shared/prompts/prompts';
-import { writeObjectFile } from '../../../shared/fs';
-import { SaveableCustomObject, NameFieldResponse } from '../../../shared/types';
-import { labelValidation } from '../../../shared/flags';
+} from '../../../shared/prompts/prompts.js';
+import { writeObjectFile } from '../../../shared/fs.js';
+import { SaveableCustomObject, NameFieldResponse } from '../../../shared/types.js';
+import { labelValidation } from '../../../shared/flags.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-sobject', 'generate.object');
 
 export type CustomObjectGenerateResult = {

src/commands/schema/generate/tab.ts

@@ -5,15 +5,16 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as fs from 'node:fs';
-import * as path from 'node:path';
+import fs  from 'node:fs';
+import path, {dirname} from 'node:path';
+import {fileURLToPath} from 'node:url';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { CustomTab } from 'jsforce/api/metadata';
-import { isTabsFolder } from '../../../shared/flags';
-import { convertJsonToXml } from '../../../shared/convert';
+import { isTabsFolder } from '../../../shared/flags.js';
+import { convertJsonToXml } from '../../../shared/convert.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-sobject', 'generate.tab');
 
 export type GenerateTabResult = {

src/index.ts

@@ -5,4 +5,4 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-export = {};
+export default {};

src/shared/convert.ts

@@ -6,7 +6,7 @@
  */
 import * as jsToXml from 'js2xmlparser';
 import { XMLParser } from 'fast-xml-parser';
-import { IOptions } from 'js2xmlparser/lib/options';
+import { IOptions } from 'js2xmlparser/lib/options.js';
 import { CustomObject, CustomField } from 'jsforce/api/metadata';
 import { JsonMap } from '@salesforce/ts-types';
 

src/shared/flags.ts

@@ -5,10 +5,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { sep, resolve } from 'node:path';
+import {sep, resolve, dirname} from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { Messages, SfError } from '@salesforce/core';
 
-Messages.importMessagesDirectory(__dirname);
+
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-sobject', 'flags');
 
 // eslint-disable-next-line @typescript-eslint/require-await

src/shared/fs.ts

@@ -4,12 +4,12 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import * as path from 'node:path';
-import * as fs from 'node:fs';
-import * as fg from 'fast-glob';
+import path from 'node:path';
+import fs  from 'node:fs';
+import fg from 'fast-glob';
 import { CustomObject } from 'jsforce/api/metadata';
-import { convertJsonToXml, parseXml } from './convert';
-import { SaveableCustomObject, SaveablePlatformEvent } from './types';
+import { convertJsonToXml, parseXml } from './convert.js';
+import { SaveableCustomObject, SaveablePlatformEvent } from './types.js';
 
 const getObjectXmlByPathAsJson = async (objectFilePath: string): Promise<CustomObject> => {
   const xml = await fs.promises.readFile(objectFilePath, 'utf8');