feat!: migrate to ESM

BREAKING CHANGES: ESM and node 18 minimum

.commitlintrc.json

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

.eslintrc.json

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

.git2gus/config.json

@@ -1,7 +1,10 @@
 {
   "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

@@ -0,0 +1,28 @@
+name: create-github-release
+
+on:
+  push:
+    branches:
+      - main
+      # 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.'
+
+jobs:
+  release:
+    # this job will throw if prerelease is true but it doesn't have a prerelease-looking package.json version
+    uses: salesforcecli/github-workflows/.github/workflows/create-github-release.yml@main
+    secrets:
+      SVC_CLI_BOT_GITHUB_TOKEN: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }}
+    with:
+      prerelease: ${{ inputs.prerelease }}
+      # If this is a push event, we want to skip the release if there are no semantic commits
+      # However, if this is a manual release (workflow_dispatch), then we want to disable skip-on-empty
+      # This helps recover from forgetting to add semantic commits ('fix:', 'feat:', etc.)
+      skip-on-empty: ${{ github.event_name == 'push' }}

.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/onRelease.yml

@@ -2,7 +2,7 @@ name: publish
 
 on:
   release:
-    types: [released]
+    types: [published]
   # support manual release in case something goes wrong and needs to be repeated or tested
   workflow_dispatch:
     inputs:
@@ -11,9 +11,23 @@ on:
         type: string
         required: true
 jobs:
+  # parses the package.json version and detects prerelease tag (ex: beta from 4.4.4-beta.0)
+  getDistTag:
+    outputs:
+      tag: ${{ steps.distTag.outputs.tag }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.release.tag_name || inputs.tag  }}
+      - uses: salesforcecli/github-workflows/.github/actions/getPreReleaseTag@main
+        id: distTag
+
   npm:
-    uses: oclif/github-workflows/.github/workflows/npmPublish.yml@main
+    uses: salesforcecli/github-workflows/.github/workflows/npmPublish.yml@main
+    needs: [getDistTag]
     with:
-      tag: latest
+      tag: ${{ needs.getDistTag.outputs.tag || 'latest' }}
       githubTag: ${{ github.event.release.tag_name || inputs.tag }}
-    secrets: inherit
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.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

@@ -6,3 +6,4 @@ oclif.manifest.json
 yarn-error.json
 
 .idea/*
+oclif.lock

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname $0)/_/husky.sh"
 
-yarn run commitlint --edit $1
+yarn commitlint --edit $1

.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,7 +1,8 @@
 {
-  "require": "ts-node/register",
+  "require": ["ts-node/register"],
   "watch-extensions": "ts",
   "recursive": true,
   "reporter": "spec",
-  "timeout": 5000
+  "timeout": 5000,
+  "node-option": ["loader=ts-node/esm"]
 }

.prettierrc.json

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

README.md

@@ -1,5 +1,4 @@
-@oclif/plugin-command-snapshot
-========
+# @oclif/plugin-command-snapshot
 
 Generates and compares OCLIF plugins snapshot files
 
@@ -9,12 +8,14 @@ Generates and compares OCLIF plugins snapshot files
 [![License](https://img.shields.io/npm/l/@oclif/plugin-command-snapshot.svg)](https://github.com/nramyasri-sf/@oclif/plugin-command-snapshot/blob/main/package.json)
 
 <!-- toc -->
-* [Usage](#usage)
-* [generates a snapshot file that has a list or commands and flags in the current CLI or plugin](#generates-a-snapshot-file-that-has-a-list-or-commands-and-flags-in-the-current-cli-or-plugin)
-* [compare the current CLI or plugin commands and flags with a snapshot file to identify changes](#compare-the-current-cli-or-plugin-commands-and-flags-with-a-snapshot-file-to-identify-changes)
+
+- [Usage](#usage)
+- [generates a snapshot file that has a list or commands and flags in the current CLI or plugin](#generates-a-snapshot-file-that-has-a-list-or-commands-and-flags-in-the-current-cli-or-plugin)
+- [compare the current CLI or plugin commands and flags with a snapshot file to identify changes](#compare-the-current-cli-or-plugin-commands-and-flags-with-a-snapshot-file-to-identify-changes)
 <!-- tocstop -->
 
 # Usage
+
 This plugin is used to take snapshot of commands and flags in OCLIF plugins. These snapshots can be used to enforce a deprecation policy or to keep track of changes.
 
 To include it in your plugin, add it to the `devPlugins` section in your package.json.
@@ -32,12 +33,12 @@ Use the `snapshot:generate` command in your development process.
 
 ```sh-session
 # generates a snapshot file that has a list or commands and flags in the current CLI or plugin
-$ ./bin/run snapshot:generate
+$ ./bin/run.js snapshot:generate
 ```
 
 Use the `snapshot:compare` command in your continuos integration. This command will fail if changes are detected. The snapshot file should be updated and committed to the repository when legitimate changes are made.
 
 ```sh-session
 # compare the current CLI or plugin commands and flags with a snapshot file to identify changes
-$ ./bin/run snapshot:compare
+$ ./bin/run.js snapshot:compare
 ```

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()