feat!: migrate to ESM (#437)

* feat!: migrate to ESM

BREAKING CHANGES: ESM and node 18 minimum

* feat: add SKIP_UPDATE_CHECK env var (#358)

* chore: bump @oclif/core

* feat: make warning frequency configurable

* feat: allow users to disable update checks

Fixes #279

This can speed up execution, reduce unnecessary network requests, and clean up log files.

* chore: code review

* test: add real tests

* chore: remove rogue console.log

* fix: use scoped env var

* chore: bump oclif/core

* chore: update dev.cmd

* chore: more code review

* chore(release): 2.1.2-qa.0 [skip ci]

* fix: use separate file for tracking last warning

* chore(release): 2.1.2-qa.1 [skip ci]

---------

Co-authored-by: Jake Howard <jake.howard@torchbox.com>
Co-authored-by: svc-cli-bot <svc_cli_bot@salesforce.com>

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

@@ -4,3 +4,6 @@
 /lib
 /node_modules
 /tmp
+
+oclif.lock
+oclif.manifest.json

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname $0)/_/husky.sh"
+
+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,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"

README.md

@@ -1,19 +1,19 @@
-@oclif/plugin-warn-if-update-available
-======================================
+# @oclif/plugin-warn-if-update-available
 
 warns if there is a newer version of CLI released
 
 [![Version](https://img.shields.io/npm/v/@oclif/plugin-warn-if-update-available.svg)](https://npmjs.org/package/@oclif/plugin-warn-if-update-available)
-[![CircleCI](https://circleci.com/gh/oclif/plugin-warn-if-update-available/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/plugin-warn-if-update-available/tree/main)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-warn-if-update-available?branch=main&svg=true)](https://ci.appveyor.com/project/oclif/plugin-warn-if-update-available/branch/main)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-warn-if-update-available.svg)](https://npmjs.org/package/@oclif/plugin-warn-if-update-available)
 [![License](https://img.shields.io/npm/l/@oclif/plugin-warn-if-update-available.svg)](https://github.com/oclif/plugin-warn-if-update-available/blob/main/package.json)
 
 <!-- toc -->
-* [What is this?](#what-is-this)
-* [How it works](#how-it-works)
-* [Installation](#installation)
-* [Configuration](#configuration)
+
+- [@oclif/plugin-warn-if-update-available](#oclifplugin-warn-if-update-available)
+- [What is this?](#what-is-this)
+- [How it works](#how-it-works)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Environment Variables](#environment-variables)
 <!-- tocstop -->
 
 # What is this?
@@ -24,7 +24,7 @@ This plugin shows a warning message if a user is running an out of date CLI.
 
 # How it works
 
-This checks the version against the npm registry asynchronously in a forked process, at most once per 7 days. It then saves a version file to the cache directory that will enable the warning. The upside of this method is that it won't block a user while they're using your CLI—the downside is that it will only display _after_ running a command that fetches the new version.
+This checks the version against the npm registry asynchronously in a forked process once every 60 days by default (see [Configuration](#configuration) for how to configure this). It then saves a version file to the cache directory that will enable the warning. The upside of this method is that it won't block a user while they're using your CLI—the downside is that it will only display _after_ running a command that fetches the new version.
 
 # Installation
 
@@ -50,15 +50,15 @@ any of the following configuration properties:
 - `message` - Customize update message.
 - `registry` - URL of registry. Defaults to the public npm registry: `https://registry.npmjs.org`
 - `authorization` - Authorization header value for registries that require auth.
+- `frequency` - The frequency that the new version warning should be shown.
+- `frequencyUnit` - The unit of time that should be used to calculate the frequency (`days`, `hours`, `minutes`, `seconds`, `milliseconds`). Defaults to `minutes`.
 
 ## Example configuration
 
 ```json
 {
   "oclif": {
-    "plugins": [
-      "@oclif/plugin-warn-if-update-available"
-    ],
+    "plugins": ["@oclif/plugin-warn-if-update-available"],
     "warn-if-update-available": {
       "timeoutInDays": 7,
       "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.",
@@ -68,3 +68,67 @@ any of the following configuration properties:
   }
 }
 ```
+
+## Notification Frequency
+
+Once a new version has been found, the default behavior is to notify the user on every command execution. You can modify this by setting the `frequency` and `frequencyUnit` options.
+
+**Examples**
+
+Once every 10 minutes.
+
+```json
+{
+  "oclif": {
+    "warn-if-update-available": {
+      "frequency": 10
+    }
+  }
+}
+```
+
+Once every 6 hours.
+
+```json
+{
+  "oclif": {
+    "warn-if-update-available": {
+      "frequency": 6,
+      "frequencyUnit": "hours"
+    }
+  }
+}
+```
+
+Once a day.
+
+```json
+{
+  "oclif": {
+    "warn-if-update-available": {
+      "frequency": 1,
+      "frequencyUnit": "days"
+    }
+  }
+}
+```
+
+Once every 30 seconds.
+
+```json
+{
+  "oclif": {
+    "warn-if-update-available": {
+      "frequency": 30,
+      "frequencyUnit": "seconds"
+    }
+  }
+}
+```
+
+# Environment Variables
+
+- `<CLI>_SKIP_NEW_VERSION_CHECK`: Skip this version check
+- `<CLI>_FORCE_VERSION_CACHE_UPDATE`: Force the version cache to update
+- `<CLI>_NEW_VERSION_CHECK_FREQ`: environment variable override for `frequency` setting
+- `<CLI>_NEW_VERSION_CHECK_FREQ_UNIT`: environment variable override for `frequencyUnit` setting

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