Merge pull request #413 from salesforcecli/wr/esm

feat!: migrate to esm

.eslintignore

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

.gitignore

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

.lintstagedrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  '**/*.{js,json,md}?(x)': () => 'npm run reformat',
+};

.mocharc.json

@@ -1,8 +1,9 @@
 {
-  "require": "ts-node/register,source-map-support/register",
+  "require": ["ts-node/register"],
   "watch-extensions": "ts",
   "recursive": true,
   "reporter": "spec",
   "timeout": 10000,
-  "exclude": "node_modules/**/*"
+  "exclude": "node_modules/**/*",
+  "node-option": ["loader=ts-node/esm"]
 }

README.md

@@ -54,7 +54,7 @@ yarn install
 yarn build
 ```
 
-To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+To use your plugin, run using the local `./bin/dev.js` or `./bin/dev.cmd` file.
 
 ```bash
 # Run using local run file.

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

@@ -1,29 +1,27 @@
 {
   "name": "@salesforce/plugin-settings",
   "description": "configure the Salesforce CLI",
-  "version": "1.4.37",
+  "version": "2.0.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^2.15.0",
+    "@oclif/core": "^3.9.0",
     "@salesforce/core": "^5.3.14",
-    "@salesforce/sf-plugins-core": "^3.1.25",
-    "fast-levenshtein": "^3.0.0",
-    "tslib": "^2"
+    "@salesforce/sf-plugins-core": "^4.0.0",
+    "fast-levenshtein": "^3.0.0"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^4.0.14",
-    "@oclif/test": "^2.5.6",
-    "@salesforce/cli-plugins-testkit": "^4.4.7",
+    "@oclif/plugin-command-snapshot": "^5.0.1",
+    "@oclif/test": "^3.0.3",
+    "@salesforce/cli-plugins-testkit": "^5.0.0",
     "@salesforce/dev-config": "^4.1.0",
     "@salesforce/dev-scripts": "^5.12.2",
     "@salesforce/kit": "^3.0.11",
     "@salesforce/plugin-command-reference": "^3.0.44",
-    "@salesforce/plugin-deploy-retrieve": "^1.18.7",
+    "@salesforce/plugin-deploy-retrieve": "^1.19.3",
     "@salesforce/prettier-config": "^0.0.3",
     "@salesforce/ts-sinon": "^1.4.17",
     "@salesforce/ts-types": "^2.0.9",
-    "@swc/core": "^1.3.27",
     "@types/fast-levenshtein": "^0.0.3",
     "@types/fs-extra": "^9.0.13",
     "@types/shelljs": "^0.8.14",
@@ -43,7 +41,7 @@
     "husky": "^7.0.4",
     "mocha": "^9.2.2",
     "nyc": "^15.1.0",
-    "oclif": "^3.17.2",
+    "oclif": "^4.0.3",
     "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3",
     "shelljs": "^0.8.5",
@@ -55,13 +53,14 @@
   },
   "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-settings",
   "keywords": [
@@ -74,7 +73,6 @@
     "sf"
   ],
   "license": "BSD-3-Clause",
-  "main": "lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "bin": "sf",
@@ -97,7 +95,8 @@
       "alias": {
         "description": "Use the alias commands to manage your aliases."
       }
-    }
+    },
+    "flexibleTaxonomy": true
   },
   "repository": "salesforcecli/plugin-settings",
   "scripts": {
@@ -198,7 +197,7 @@
       "output": []
     },
     "test:command-reference": {
-      "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
+      "command": "ts-node \"./bin/dev.js\" commandreference:generate --erroronwarnings",
       "files": [
         "src/**/*.ts",
         "messages/**",
@@ -209,7 +208,7 @@
       ]
     },
     "test:deprecation-policy": {
-      "command": "\"./bin/dev\" snapshot:compare",
+      "command": "ts-node \"./bin/dev.js\" snapshot:compare",
       "files": [
         "src/**/*.ts"
       ],
@@ -219,12 +218,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/alias/list.ts

@@ -5,11 +5,13 @@
  * 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 { StateAggregator, Messages } from '@salesforce/core';
 import { loglevel } from '@salesforce/sf-plugins-core';
-import { AliasCommand, AliasResults } from '../../alias';
+import { AliasCommand, AliasResults } from '../../alias.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'alias.list');
 export default class AliasList extends AliasCommand<AliasResults> {
   public static summary = messages.getMessage('summary');

src/commands/alias/set.ts

@@ -5,11 +5,13 @@
  * 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 { loglevel, parseVarArgs } from '@salesforce/sf-plugins-core';
 import { StateAggregator, Messages } from '@salesforce/core';
-import { AliasCommand, AliasResults } from '../../alias';
+import { AliasCommand, AliasResults } from '../../alias.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'alias.set');
 
 export default class AliasSet extends AliasCommand<AliasResults> {

src/commands/alias/unset.ts

@@ -5,11 +5,13 @@
  * 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 { Flags, loglevel } from '@salesforce/sf-plugins-core';
 import { StateAggregator, Messages } from '@salesforce/core';
-import { AliasCommand, AliasResults } from '../../alias';
+import { AliasCommand, AliasResults } from '../../alias.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'alias.unset');
 
 export default class AliasUnset extends AliasCommand<AliasResults> {

src/commands/config/get.ts

@@ -4,6 +4,8 @@
  * 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 { fileURLToPath } from 'node:url';
+import { dirname } from 'node:path';
 import { Flags, loglevel, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { ConfigAggregator, Messages } from '@salesforce/core';
 import {
@@ -13,9 +15,9 @@ import {
   buildSuccessMsg,
   output,
   ConfigResponses,
-} from '../../config';
+} from '../../config.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'config.get');
 
 export class Get extends SfCommand<ConfigResponses> {

src/commands/config/list.ts

@@ -4,11 +4,13 @@
  * 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 { fileURLToPath } from 'node:url';
+import { dirname } from 'node:path';
 import { ConfigAggregator, Messages } from '@salesforce/core';
 import { loglevel, SfCommand, Ux } from '@salesforce/sf-plugins-core';
-import { ConfigResponses, buildSuccessMsg, output } from '../../config';
+import { ConfigResponses, buildSuccessMsg, output } from '../../config.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'config.list');
 
 export default class List extends SfCommand<ConfigResponses> {

src/commands/config/set.ts

@@ -5,11 +5,13 @@
  * 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 { parseVarArgs, Flags, loglevel, Ux, SfCommand } from '@salesforce/sf-plugins-core';
 import { Config, Messages, Org, SfError, OrgConfigProperties } from '@salesforce/core';
-import { CONFIG_HELP_SECTION, Msg, buildFailureMsg, calculateSuggestion, output } from '../../config';
+import { CONFIG_HELP_SECTION, Msg, buildFailureMsg, calculateSuggestion, output } from '../../config.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'config.set');
 
 export type SetOrUnsetConfigCommandResult = { successes: Msg[]; failures: Msg[] };

src/commands/config/unset.ts

@@ -5,12 +5,14 @@
  * 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 { Flags, loglevel, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { Config, Messages } from '@salesforce/core';
-import { CONFIG_HELP_SECTION, buildFailureMsg, calculateSuggestion, output } from '../../config';
-import { SetOrUnsetConfigCommandResult } from './set';
+import { CONFIG_HELP_SECTION, buildFailureMsg, calculateSuggestion, output } from '../../config.js';
+import { SetOrUnsetConfigCommandResult } from './set.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
 const messages = Messages.loadMessages('@salesforce/plugin-settings', 'config.unset');
 
 export class UnSet extends SfCommand<SetOrUnsetConfigCommandResult> {

src/config.ts

@@ -8,8 +8,9 @@
 import { Ux } from '@salesforce/sf-plugins-core';
 import { ConfigInfo, SfError, Config } from '@salesforce/core';
 import { toHelpSection } from '@salesforce/sf-plugins-core';
-import * as Levenshtein from 'fast-levenshtein';
+import Levenshtein from 'fast-levenshtein';
 import { isJsonMap } from '@salesforce/ts-types';
+import { HelpSection } from '@oclif/core';
 
 export type Msg = {
   name: string;
@@ -27,7 +28,7 @@ export type Msg = {
 };
 export type ConfigResponses = Msg[];
 
-export const CONFIG_HELP_SECTION = toHelpSection(
+export const CONFIG_HELP_SECTION: HelpSection = toHelpSection(
   'CONFIGURATION VARIABLES',
   ...new Set(Config.getAllowedProperties().map((k) => k.newKey ?? k.key))
 );