@agilecustoms/envctl 0.1.3 → 0.2.1

package/Makefile

@@ -19,10 +19,3 @@ app2-test:
 
 app3-build:
 	@npm run build
-
-# npm cache clean --force
-# cd ~/.npm; open .
-app4-dry-run:
-	@set -e; \
-	echo "cd in other directory, otherwise npx picks up local package :("; cd ..; \
-	npx -y --force @agilecustoms/envctl --version

package/README.md

@@ -2,12 +2,12 @@
 - npm [@agilecustoms/envctl](https://www.npmjs.com/package/@agilecustoms/envctl)
 - npm [agilecustoms/packages](https://www.npmjs.com/settings/agilecustoms/packages) (admin view)
 
-## setup
+## setup/update
 ```shell
-npm install -g @agilecustoms/envctl
-npm outdated
-npm update
+npm install -g @agilecustoms/envctl # same command for update
 envctl --version
+npm outdated -g
+npm view @agilecustoms/envctl version # show latest version available (without installing)
 ```
 
 ## npmjs setup
@@ -23,6 +23,7 @@ envctl --version
    1. Name `NPMJS_TOKEN`
    2. Repository access: `envctl` only
 
+## History/motivation
 dev-env is a microservice hosted in 'maintenance' account and working as garbage collector: every environment first
 created in dev-env and then 'managed' by dev-env: it deletes env when it is not in use anymore OR can extend lifetime.
 Creation API yields unique ID, so you can safely manage env (delete, extend lifetime) via this ID. But creation API
@@ -40,4 +41,7 @@ Now problem is: any request needs to be signed with AWS signature v4. Originally
 quickly became bulky and hard to maintain. Then I thought about Node.js - it is available on dev machines and
 in GitHub actions (namely in Ubuntu runners). How to distribute it? First I thought about using `ncc` to bundle in one
 big .js file (as I do for `gha-upload-3` and `gha-healthcheck`) but it will be hard to use on dev machine...
-So I ended up with publishing this client as npm package in CodeArtifact and then running from anywhere with `npx`!
+
+So I ended up with publishing this client as npm package in npmjs
+- CI environments can install & run it with one command via `npx`
+- developer will install it globally via `npm install -g @agilecustoms/envctl`

package/dist/index.js

@@ -1,14 +1,16 @@
 #!/usr/bin/env node
 import { createRequire } from 'module';
 import { Command } from 'commander';
+import updateNotifier from 'update-notifier';
 import { deleteIt, ephemeral, register } from './commands/index.js';
 const require = createRequire(import.meta.url);
-const { version } = require('../package.json');
+const pkg = require('../package.json');
+updateNotifier({ pkg }).notify();
 const program = new Command();
 program
     .name('envctl')
     .description('CLI to manage environments')
-    .version(version);
+    .version(pkg.version);
 register(program);
 ephemeral(program);
 deleteIt(program);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agilecustoms/envctl",
   "description": "node.js CLI client for manage environments",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "author": "Alex Chekulaev",
   "type": "module",
   "bin": {
@@ -29,12 +29,14 @@
     "@aws-sdk/client-sts": "^3.716.0",
     "@aws-sdk/credential-providers": "^3.716.0",
     "aws4": "^1.13.2",
-    "commander": "^13.0.0"
+    "commander": "^13.0.0",
+    "update-notifier": "^7.3.1"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^4.2.0",
     "@types/aws4": "^1.11.6",
     "@types/node": "^22.10.2",
+    "@types/update-notifier": "^6.0.8",
     "@vitest/coverage-v8": "^3.0.2",
     "eslint": "^9.22.0",
     "eslint-plugin-import": "^2.31.0",

package/src/index.ts

@@ -1,17 +1,21 @@
 #!/usr/bin/env node
 import { createRequire } from 'module'
 import { Command } from 'commander'
+import updateNotifier from 'update-notifier'
 import { deleteIt, ephemeral, register } from './commands/index.js'
 
 // it is possible to use 'import' to load JSON files, but package.json is level higher, so such trick copies 'src' in /dist :(
 const require = createRequire(import.meta.url) // custom 'require' relative to current module’s file URL
-const { version } = require('../package.json')
+const pkg = require('../package.json')
+
+// Check for updates
+updateNotifier({ pkg }).notify()
 
 const program = new Command()
 program
   .name('envctl') // shown when running --help: Usage: envctl [options] [command]
   .description('CLI to manage environments')
-  .version(version)
+  .version(pkg.version)
 register(program)
 ephemeral(program)
 deleteIt(program)