feat!: migrate to ESM (#651)

* feat!: migrate to ESM

BREAKING CHANGES: ESM and node 18 minimum

* chore: dep cleanup

* refactor: drop ts-types

* style: typos

* fix: remove unspecified kit dependency

---------

Co-authored-by: mshanemc <[email protected]>

.eslintignore

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

.mocharc.json

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

bin/dev.cmd

@@ -1,3 +1,3 @@
 @echo off
 
-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

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/plugin-custom-metadata",
   "description": "Tools for working with custom metadata types and their records.",
-  "version": "2.2.13",
+  "version": "3.0.0",
   "contributors": [
     {
       "name": "Carolyn Grabill",
@@ -42,30 +42,26 @@
   ],
   "bugs": "https://github.com/salesforcecli/plugin-custom-metadata/issues",
   "dependencies": {
-    "@oclif/core": "^2.15.0",
+    "@oclif/core": "^3.11.0",
     "@salesforce/core": "^5.3.20",
-    "@salesforce/sf-plugins-core": "^3.1.22",
-    "@salesforce/ts-types": "^2.0.6",
+    "@salesforce/sf-plugins-core": "^4.1.2",
     "csv-parse": "^5.5.2",
-    "fast-xml-parser": "^4.3.2",
-    "tslib": "^2"
+    "fast-xml-parser": "^4.3.2"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^4.0.16",
-    "@salesforce/cli-plugins-testkit": "^4.4.12",
-    "@salesforce/dev-scripts": "^6.0.3",
+    "@oclif/plugin-command-snapshot": "^5.0.2",
+    "@salesforce/cli-plugins-testkit": "^5.0.4",
+    "@salesforce/dev-scripts": "^6.0.4",
     "@salesforce/plugin-command-reference": "^3.0.46",
-    "@salesforce/ts-sinon": "^1.4.19",
-    "@swc/core": "^1.3.37",
-    "eslint-plugin-sf-plugin": "^1.16.14",
-    "jsforce": "^2.0.0-beta.22",
-    "oclif": "^3.17.2",
+    "eslint-plugin-sf-plugin": "^1.16.15",
+    "jsforce": "^2.0.0-beta.28",
+    "oclif": "^4.0.3",
     "shx": "0.2.2",
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "/lib",
@@ -76,12 +72,14 @@
   ],
   "homepage": "https://github.com/salesforcecli/plugin-custom-metadata",
   "keywords": [
+    "sf",
+    "sf-plugin",
     "sfdx-plugin"
   ],
   "license": "BSD-3-Clause",
   "oclif": {
     "commands": "./lib/commands",
-    "bin": "sfdx",
+    "bin": "sf",
     "devPlugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-command-snapshot",
@@ -99,19 +97,21 @@
           }
         }
       }
-    }
+    },
+    "flexibleTaxonomy": true,
+    "topicSeparator": " "
   },
   "repository": "github:salesforcecli/plugin-custom-metadata",
   "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",
     "lint": "wireit",
-    "postpack": "shx rm -f oclif.manifest.json",
+    "postpack": "shx rm -f oclif.manifest.json oclif.lock",
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "test": "wireit",
@@ -199,7 +199,7 @@
       "output": []
     },
     "test:command-reference": {
-      "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
+      "command": "ts-node \"./bin/dev.js\" commandreference:generate --erroronwarnings",
       "files": [
         "src/**/*.ts",
         "messages/**",
@@ -210,7 +210,7 @@
       ]
     },
     "test:deprecation-policy": {
-      "command": "\"./bin/dev\" snapshot:compare",
+      "command": "ts-node \"./bin/dev.js\" snapshot:compare",
       "files": [
         "src/**/*.ts"
       ],
@@ -220,12 +220,15 @@
       ]
     },
     "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",
+  "author": "Salesforce"
 }

src/commands/cmdt/generate/field.ts

@@ -4,14 +4,16 @@
  * 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 fs from 'node:fs';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { arrayWithDeprecation, Flags, loglevel, SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages, SfError } from '@salesforce/core';
-import { writeFieldFile } from '../../../shared/helpers/fileWriter';
-import { validateAPIName } from '../../../shared/helpers/validationUtil';
-import { createDefaultTypeStructure, createFieldXML } from '../../../shared/templates/templates';
+import { writeFieldFile } from '../../../shared/helpers/fileWriter.js';
+import { validateAPIName } from '../../../shared/helpers/validationUtil.js';
+import { createDefaultTypeStructure, createFieldXML } from '../../../shared/templates/templates.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-custom-metadata', 'field');
 
 export interface CmdtFieldCreateResponse {

src/commands/cmdt/generate/fromorg.ts

@@ -4,8 +4,9 @@
  * 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 from 'node:path';
+import { fileURLToPath } from 'node:url';
 import {
   Flags,
   loglevel,
@@ -14,19 +15,18 @@ import {
   SfCommand,
 } from '@salesforce/sf-plugins-core';
 import { SfError, Messages } from '@salesforce/core';
-import { isEmpty } from '@salesforce/kit';
 import { CustomField, CustomObject } from 'jsforce/api/metadata';
-import { createRecord, getFileData } from '../../../shared/helpers/createUtil';
-import { writeTypeFile, writeFieldFile } from '../../../shared/helpers/fileWriter';
-import { describeObjFields, cleanQueryResponse, validCustomSettingType } from '../../../shared/helpers/metadataUtil';
+import { createRecord, getFileData } from '../../../shared/helpers/createUtil.js';
+import { writeTypeFile, writeFieldFile } from '../../../shared/helpers/fileWriter.js';
+import { describeObjFields, cleanQueryResponse, validCustomSettingType } from '../../../shared/helpers/metadataUtil.js';
 import {
   validateAPIName,
   validateMetadataTypeName,
   isValidMetadataRecordName,
-} from '../../../shared/helpers/validationUtil';
-import { canConvert, createObjectXML, createFieldXML } from '../../../shared/templates/templates';
+} from '../../../shared/helpers/validationUtil.js';
+import { canConvert, createObjectXML, createFieldXML } from '../../../shared/templates/templates.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(path.dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-custom-metadata', 'fromorg');
 
 export interface CmdtGenerateResponse {
@@ -103,7 +103,7 @@ export default class Generate extends SfCommand<CmdtGenerateResponse> {
     const describeObj = await conn.metadata.read('CustomObject', flags.sobject);
 
     // throw error if the object doesnot exist(empty json as response from the describe call.)
-    if (isEmpty(describeObj.fields)) {
+    if (describeObj.fields.length === 0) {
       const errMsg = messages.getMessage('sobjectnameNoResultError', [flags.sobject]);
       throw new SfError(errMsg, 'sobjectnameNoResultError');
     }

src/commands/cmdt/generate/object.ts

@@ -4,14 +4,16 @@
  * 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 fs from 'node:fs';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { Flags, loglevel, SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
-import { writeTypeFile } from '../../../shared/helpers/fileWriter';
-import { validateMetadataTypeName, validateLessThanForty } from '../../../shared/helpers/validationUtil';
-import { createObjectXML } from '../../../shared/templates/templates';
+import { writeTypeFile } from '../../../shared/helpers/fileWriter.js';
+import { validateMetadataTypeName, validateLessThanForty } from '../../../shared/helpers/validationUtil.js';
+import { createObjectXML } from '../../../shared/templates/templates.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-custom-metadata', 'object');
 
 export interface CmdtCreateResponse {

src/commands/cmdt/generate/record.ts

@@ -4,19 +4,20 @@
  * 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 from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { Flags, loglevel, parseVarArgs, SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { CustomField } from 'jsforce/api/metadata';
-import { appendDirectorySuffix, createRecord, getFileData } from '../../../shared/helpers/createUtil';
+import { appendDirectorySuffix, createRecord, getFileData } from '../../../shared/helpers/createUtil.js';
 import {
   validateMetadataRecordName,
   validateMetadataTypeName,
   validateLessThanForty,
-} from '../../../shared/helpers/validationUtil';
+} from '../../../shared/helpers/validationUtil.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(path.dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-custom-metadata', 'record');
 
 export interface CmdtRecordCreateResponse {

src/commands/cmdt/generate/records.ts

@@ -4,16 +4,17 @@
  * 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 from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { Flags, loglevel, SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages, SfError } from '@salesforce/core';
 import { Record } from 'jsforce';
 import { parse } from 'csv-parse/sync';
-import { getFieldNames, appendDirectorySuffix, createRecord, getFileData } from '../../../shared/helpers/createUtil';
-import { CreateConfig, CreateConfigs } from '../../../shared/interfaces/createConfig';
+import { getFieldNames, appendDirectorySuffix, createRecord, getFileData } from '../../../shared/helpers/createUtil.js';
+import { CreateConfig, CreateConfigs } from '../../../shared/interfaces/createConfig.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(path.dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-custom-metadata', 'records');
 
 export default class Insert extends SfCommand<CreateConfigs> {

src/shared/helpers/createUtil.ts

@@ -4,13 +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 fs from 'node:fs';
-import * as path from 'node:path';
+import fs from 'node:fs';
+import path from 'node:path';
 import { CustomField } from 'jsforce/api/metadata';
 import { XMLParser } from 'fast-xml-parser';
-import { isString } from '@salesforce/ts-types';
-import { CreateConfig } from '../interfaces/createConfig';
-import { canConvert } from '../templates/templates';
+import { CreateConfig } from '../interfaces/createConfig.js';
+import { canConvert } from '../templates/templates.js';
 
 interface CustomFieldFile {
   CustomField: CustomField;
@@ -110,15 +109,15 @@ export const appendDirectorySuffix = (typename: string): string =>
   typename.endsWith('__mdt') ? typename : `${typename}__mdt`;
 
 /**
- * Goes through the file data that has been genreated and gets all of the field names and adds the
+ * Goes through the file data that has been generated and gets all of the field names and adds the
  * name of the field that is used as the label for metadata record
  *
  * @param  fileData Array of objects based on metadata type xml
  * @param  nameField name of the column that is going to be used for the name of the metadata record
  * @return [] Array of field names
  */
 export const getFieldNames = (fileData: CustomField[], nameField: string): string[] => [
-  ...fileData.map((file) => file.fullName).filter(isString),
+  ...fileData.map((file) => file.fullName).filter((f): f is string => typeof f === 'string'),
   nameField,
 ];
 
@@ -139,7 +138,7 @@ const buildCustomFieldXml = (
   for (const fieldName of Object.keys(cliParams)) {
     const type = getFieldPrimitiveType(fileData, fieldName);
     const dataType = getFieldDataType(fileData, fieldName);
-    // Added functionality to handle the igonre fields scenario.
+    // Added functionality to handle the ignore fields scenario.
     if (canConvert(dataType) || !ignoreFields) {
       ret += getFieldTemplate(fieldName, cliParams[fieldName], type);
     }

src/shared/helpers/fileWriter.ts

@@ -5,8 +5,8 @@
  * 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 from 'node:path';
 
 interface FileWriterResult {
   dir: string;