@govuk-pay/cli 0.0.19 → 0.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/cli",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "GOV.UK Pay Command Line Interface",
   "bin": {
     "pay": "bin/cli.js",
@@ -10,12 +10,16 @@
   "keywords": [],
   "author": "",
   "license": "MIT",
+  "engines": {
+    "node": ">= 18.x"
+  },
   "dependencies": {
     "@aws-sdk/client-ec2": "^3.641.0",
     "@aws-sdk/client-ecs": "^3.637.0",
     "@aws-sdk/client-rds": "^3.637.0",
     "@aws-sdk/client-ssm": "^3.651.1",
     "openurl": "^1.1.1",
+    "semver": "^7.6.3",
     "ts-standard": "^12.0.2"
   },
   "files": [

package/readme.md

@@ -1,6 +1,21 @@
 # pay-cli
 GOV.UK Pay Command Line Interface
 
+## Installation and migration guide
+
+If you have used the Ruby CLI in the past, there are some additional steps required:
+
+- Remove references to `pay` from your `.bashrc` (or other autostart shell script, `.bash_profile`, `.zshrc`, `.zprofile`, etc).
+- Check `which pay`, if it points to `~/.rbenv/shims/pay` or similar, remove that script. Ideally, it should return `pay not found`.
+- Restart your shell to clear functions and environment variables leftover.
+
+To install the Node.js CLI:
+
+- Run `npm install -g @govuk-pay/cli`. If npm was installed through Homebrew, you shouldn't need to use sudo to install packages.
+- Run `pay` to see if you are running the new version (new features such as `pay tunnel` should be available), if not check `which pay` in case you are using an older version.
+
+There is nothing more to do, you're done! To update, run `npm install -g @govuk-pay/cli` again, there are version check notifications if you are behind a version.
+
 ## Usage
 
 This is published to NPM, you can install it globally using `npm install -g @govuk-pay/cli`,

package/src/core/commandRouter.js

@@ -9,6 +9,8 @@ const demo_js_1 = __importDefault(require("../commands/demo.js"));
 const legacy_1 = __importDefault(require("../commands/legacy"));
 const help_1 = __importDefault(require("../commands/help"));
 const tunnel_js_1 = __importDefault(require("../commands/tunnel.js"));
+const package_json_1 = __importDefault(require("../../package.json"));
+const semver_1 = __importDefault(require("semver"));
 const handlers = new Map();
 handlers.set('browse', {
     handler: browse_js_1.default
@@ -51,6 +53,7 @@ handlers.set('demo', {
 });
 async function runCommand() {
     const command = process.argv[2];
+    await checkVersion();
     await showUsageIfNoCommand(command);
     const commandDetails = await getCommandDetails(command);
     if (commandDetails === undefined) {
@@ -83,3 +86,18 @@ async function runHandler(commandName, commandHandler) {
         process.exit(12);
     }
 }
+async function checkVersion() {
+    try {
+        const { version: currentVersion, engines: { node: requiredNodeVersion } } = package_json_1.default;
+        if (!semver_1.default.satisfies(process.version, requiredNodeVersion)) {
+            console.log(`Required Node.js version is ${requiredNodeVersion}, you are running ${process.version}. Please upgrade before continuing.`);
+        }
+        const { version: remoteVersion } = await fetch('https://registry.npmjs.org/@govuk-pay/cli/latest')
+            .then(async (r) => await r.json());
+        if (currentVersion !== remoteVersion) {
+            console.log(`You are running pay-cli version ${currentVersion}, the latest version is ${remoteVersion}.`);
+            console.log('Run `npm install -g @govuk-pay/cli` to upgrade.');
+        }
+    }
+    catch { }
+}