feat!: migrate to ESM (#269)

* feat!: migrate to ESM

BREAKING CHANGES: node 18 minimum, removed exports

* chore: remove disabled linting rules

* fix: update bin scripts

* chore(release): 1.3.11-qa.0

---------

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

.commitlintrc.json

@@ -0,0 +1 @@
+{"extends": ["@commitlint/config-conventional"]}

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["oclif", "oclif-typescript", "prettier"]
+}

.git2gus/config.json

@@ -1,7 +1,7 @@
 {
   "productTag": "a1aB0000000ce2IIAQ",
-  "defaultBuild": "offcore.tooling.55",
-  "issueTypeLabels": { "enhancement": "USER STORY", "bug": "BUG P3" },
+  "defaultBuild": "offcore.tooling.59",
+  "issueTypeLabels": {"enhancement": "USER STORY", "bug": "BUG P3"},
   "hideWorkItemUrl": true,
   "statusWhenClosed": "CLOSED"
 }

.github/workflows/automerge.yml

@@ -2,9 +2,12 @@ name: automerge
 on:
   workflow_dispatch:
   schedule:
-    - cron: '17 2,5,8,11 * * *'
+    - cron: '42 2,5,8,11 * * *'
 
 jobs:
   automerge:
-    uses: oclif/github-workflows/.github/workflows/automerge.yml@main
-    secrets: inherit
+    uses: salesforcecli/github-workflows/.github/workflows/automerge.yml@main
+    secrets:
+      SVC_CLI_BOT_GITHUB_TOKEN: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }}
+    with:
+      mergeMethod: squash

.github/workflows/create-github-release.yml

@@ -7,12 +7,12 @@ on:
       # point at specific branches, or a naming convention via wildcard
       - prerelease/**
     tags-ignore:
-      - "*"
+      - '*'
   workflow_dispatch:
     inputs:
       prerelease:
         type: string
-        description: "Name to use for the prerelease: beta, dev, etc. NOTE: If this is already set in the package.json, it does not need to be passed in here."
+        description: 'Name to use for the prerelease: beta, dev, etc. NOTE: If this is already set in the package.json, it does not need to be passed in here.'
 
 jobs:
   release:

.github/workflows/failureNotifications.yml

@@ -3,7 +3,7 @@ name: failureNotifications
 on:
   workflow_run:
     workflows:
-      - version, tag and github release
+      - create-github-release
       - publish
     types:
       - completed

.github/workflows/test.yml

@@ -5,5 +5,11 @@ on:
   workflow_dispatch:
 
 jobs:
-  unit-tests:
-    uses: oclif/github-workflows/.github/workflows/unitTest.yml@main
+  yarn-lockfile-check:
+    uses: salesforcecli/github-workflows/.github/workflows/lockFileCheck.yml@main
+  linux-unit-tests:
+    needs: yarn-lockfile-check
+    uses: salesforcecli/github-workflows/.github/workflows/unitTestsLinux.yml@main
+  windows-unit-tests:
+    needs: linux-unit-tests
+    uses: salesforcecli/github-workflows/.github/workflows/unitTestsWindows.yml@main

.gitignore

@@ -7,3 +7,5 @@
 /node_modules
 /tmp
 .idea
+oclif.lock
+oclif.manifest.json

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged --concurrent false

.lintstagedrc.json

@@ -0,0 +1,5 @@
+{
+  "*.json": ["prettier --write"],
+  "*.md": ["prettier --write"],
+  "+(src|test)/**/*.+(ts|js)": ["eslint --fix", "prettier --write"]
+}

.mocharc.json

@@ -1,13 +1,8 @@
 {
-  "require": [
-    "test/helpers/init.js",
-    "ts-node/register",
-    "source-map-support/register"
-  ],
-  "watch-extensions": [
-    "ts"
-  ],
+  "require": ["ts-node/register"],
+  "watch-extensions": ["ts"],
   "recursive": true,
   "reporter": "spec",
-  "timeout": 60000
+  "timeout": 60000,
+  "node-option": ["loader=ts-node/esm"]
 }

.prettierrc.json

@@ -0,0 +1 @@
+"@oclif/prettier-config"

bin/dev.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env ts-node
+// 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,8 @@
+#!/usr/bin/env node
+
+async function main() {
+  const {execute} = await import('@oclif/core')
+  await execute({dir: import.meta.url})
+}
+
+await main()

package.json

@@ -1,45 +1,50 @@
 {
   "name": "@oclif/plugin-version",
   "description": "A command that shows the CLI version",
-  "version": "1.3.10",
+  "version": "1.3.11-qa.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-version/issues",
   "dependencies": {
-    "@oclif/core": "^2.15.0"
+    "@oclif/core": "^3.0.4"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^12.1.4",
+    "@commitlint/config-conventional": "^17.7.0",
     "@oclif/plugin-help": "5.2.20",
-    "@oclif/test": "^2.5.6",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3",
     "@types/chai": "^4.3.6",
-    "@types/mocha": "^8.0.0",
-    "@types/node": "^16",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
     "chai": "^4.3.10",
-    "commitlint": "^12.1.4",
-    "eslint": "^7.3.1",
-    "eslint-config-oclif": "^4",
-    "eslint-config-oclif-typescript": "^1.0.2",
-    "fancy-test": "^2.0.42",
-    "husky": "6",
-    "mocha": "^8.2.1",
-    "oclif": "^3.17.2",
+    "commitlint": "^17.7.2",
+    "eslint": "^8.51.0",
+    "eslint-config-oclif": "^5",
+    "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.0.0",
+    "fancy-test": "^3",
+    "husky": "^8",
+    "lint-staged": "^14.0.1",
+    "mocha": "^10.2.0",
+    "oclif": "^4",
+    "prettier": "^3.0.3",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "oclif.manifest.json",
+    "oclif.lock",
     "/lib"
   ],
   "homepage": "https://github.com/oclif/plugin-version",
   "keywords": [
     "oclif-plugin"
   ],
   "license": "MIT",
-  "main": "lib/index.js",
+  "exports": "./lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "devPlugins": [
@@ -49,16 +54,18 @@
   "repository": "oclif/plugin-version",
   "scripts": {
     "build": "shx rm -rf lib && tsc",
+    "clean": "shx rm -f oclif.manifest.json oclif.lock",
     "commitlint": "commitlint",
-    "clean": "shx rm -f oclif.manifest.json",
-    "lint": "eslint . --ext .ts --config .eslintrc",
-    "pretest": "yarn build",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "posttest": "yarn lint",
-    "prepublishOnly": "yarn run build && oclif manifest . && oclif readme",
+    "lint": "eslint . --ext .ts",
     "postpublish": "yarn run clean",
+    "posttest": "yarn lint",
+    "prepare": "husky install",
+    "prepublishOnly": "yarn run build && oclif lock && oclif manifest . && oclif readme",
+    "pretest": "yarn build --noEmit && tsc -p test --noEmit",
     "preversion": "yarn run clean",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },
-  "types": "lib/index.d.ts"
-}
+  "types": "lib/index.d.ts",
+  "type": "module"
+}

src/commands/version.ts

@@ -1,18 +1,18 @@
 import {Command, Flags, Interfaces} from '@oclif/core'
-// eslint-disable-next-line unicorn/prefer-node-protocol
-import {EOL} from 'os'
+import {EOL} from 'node:os'
 
 export type VersionDetail = Omit<Interfaces.VersionDetails, 'pluginVersions'> & {
-  pluginVersions?: string[];
+  pluginVersions?: string[]
 }
 
 export default class Version extends Command {
   static enableJsonFlag = true
 
   public static flags = {
     verbose: Flags.boolean({
+      description:
+        'Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.',
       summary: 'Show additional information about the CLI.',
-      description: 'Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.',
     }),
   }
 
@@ -51,28 +51,28 @@ export default class Version extends Command {
 
     this.log(output)
 
-    return flags.verbose ?
-      versionDetail :
-      {
-        cliVersion: versionDetail.cliVersion,
-        architecture: versionDetail.architecture,
-        nodeVersion: versionDetail.nodeVersion,
-      }
+    return flags.verbose
+      ? versionDetail
+      : {
+          architecture: versionDetail.architecture,
+          cliVersion: versionDetail.cliVersion,
+          nodeVersion: versionDetail.nodeVersion,
+        }
   }
 
   private formatPlugins(plugins: Record<string, Interfaces.PluginVersionDetail>): string[] {
     return Object.entries(plugins)
-    .map(([name, plugin]) => ({name, ...plugin}))
-    .sort((a, b) => (a.name > b.name ? 1 : -1))
-    .map(plugin =>
-      `${this.getFriendlyName(plugin.name)} ${plugin.version} (${plugin.type}) ${
-        plugin.type === 'link' ? plugin.root : ''
-      }`.trim(),
-    )
+      .map(([name, plugin]) => ({name, ...plugin}))
+      .sort((a, b) => (a.name > b.name ? 1 : -1))
+      .map((plugin) =>
+        `${this.getFriendlyName(plugin.name)} ${plugin.version} (${plugin.type}) ${
+          plugin.type === 'link' ? plugin.root : ''
+        }`.trim(),
+      )
   }
 
   private getFriendlyName(name: string): string {
-    const scope = this.config.pjson.oclif.scope
+    const {scope} = this.config.pjson.oclif
     if (!scope) return name
     const match = name.match(`@${scope}/plugin-(.+)`)
     if (!match) return name

src/index.ts

@@ -1 +1 @@
-export {VersionDetail, default as VersionCommand} from './commands/version'
+export {run} from '@oclif/core'