From 68dc9324287fe2b3aa9a2b6d3ed9cf1c6b4ca84b Mon Sep 17 00:00:00 2001 From: Kevin Longmuir Date: Thu, 4 Sep 2025 11:02:58 -0400 Subject: [PATCH 1/2] feat: add version command properly --- package-lock.json | 14 ++++++++++++++ package.json | 4 +++- src/commands/scan/eol.ts | 1 + src/hooks/finally.ts | 13 ++++++++++--- 4 files changed, 28 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3fbcef20..c46e7723 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,6 +16,7 @@ "@oclif/core": "^4.5.2", "@oclif/plugin-help": "^6.2.32", "@oclif/plugin-update": "^4.7.4", + "@oclif/plugin-version": "^2.2.32", "graphql": "^16.11.0", "node-machine-id": "^1.1.12", "ora": "^8.2.0", @@ -4009,6 +4010,19 @@ "node": ">=12.20" } }, + "node_modules/@oclif/plugin-version": { + "version": "2.2.32", + "resolved": "https://registry.npmjs.org/@oclif/plugin-version/-/plugin-version-2.2.32.tgz", + "integrity": "sha512-KwsEKjb202nthRIwigyvRNQ5vK8mUr/FnPzBjkLX7SbgPMLM7iqoaWDPZqBvq5/A/226Ey4vCf64y3zJh4eaWA==", + "license": "MIT", + "dependencies": { + "@oclif/core": "^4", + "ansis": "^3.17.0" + }, + "engines": { + "node": ">=18.0.0" + } + }, "node_modules/@oclif/plugin-warn-if-update-available": { "version": "3.1.46", "resolved": "https://registry.npmjs.org/@oclif/plugin-warn-if-update-available/-/plugin-warn-if-update-available-3.1.46.tgz", diff --git a/package.json b/package.json index bccdecc3..93c0dabd 100644 --- a/package.json +++ b/package.json @@ -45,6 +45,7 @@ "@oclif/core": "^4.5.2", "@oclif/plugin-help": "^6.2.32", "@oclif/plugin-update": "^4.7.4", + "@oclif/plugin-version": "^2.2.32", "graphql": "^16.11.0", "node-machine-id": "^1.1.12", "ora": "^8.2.0", @@ -84,7 +85,8 @@ "plugins": [ "@oclif/plugin-help", "@oclif/plugin-plugins", - "@oclif/plugin-update" + "@oclif/plugin-update", + "@oclif/plugin-version" ], "hooks": { "init": "./dist/hooks/npm-update-notifier.js", diff --git a/src/commands/scan/eol.ts b/src/commands/scan/eol.ts index 46e3b827..656bd83e 100644 --- a/src/commands/scan/eol.ts +++ b/src/commands/scan/eol.ts @@ -52,6 +52,7 @@ export default class ScanEol extends Command { default: false, description: `Save the generated SBOM as ${filenamePrefix}.sbom.json in the scanned directory`, }), + version: Flags.version() }; public async run(): Promise { diff --git a/src/hooks/finally.ts b/src/hooks/finally.ts index 546c8f9a..edf3d525 100644 --- a/src/hooks/finally.ts +++ b/src/hooks/finally.ts @@ -3,17 +3,24 @@ import ora from 'ora'; import { track } from '../service/analytics.svc.ts'; const hook: Hook<'finally'> = async (opts) => { - const spinner = ora().start('Cleaning up'); + const isHelpOrVersionCmd = opts.argv.includes('--help') || opts.argv.includes('--version') || opts.Command?.id === 'version' + + let spinner; + + if (!isHelpOrVersionCmd) { + spinner = ora().start('Cleaning up'); + } + const event = track('CLI Session Ended', (context) => ({ cli_version: context.cli_version, ended_at: new Date(), })).promise; - if (!opts.argv.includes('--help')) { + if (!isHelpOrVersionCmd) { await event; + spinner?.stop(); } - spinner.stop(); }; export default hook; From 69232a1f85e4ef3f39f8672b564900db3d487a3d Mon Sep 17 00:00:00 2001 From: Kevin Longmuir Date: Thu, 4 Sep 2025 12:42:00 -0400 Subject: [PATCH 2/2] fix: command line hanging on unknown command --- package-lock.json | 14 -------------- package.json | 13 +++++++------ src/commands/scan/eol.ts | 2 +- src/hooks/{ => finally}/finally.ts | 11 +++++------ .../00_npm-update-notifier.ts} | 4 ++-- .../{prerun.ts => init/01_initialize_amplitude.ts} | 10 ++-------- src/hooks/prerun/prerun.ts | 11 +++++++++++ test/hooks/npm-update-notifier.test.ts | 2 +- 8 files changed, 29 insertions(+), 38 deletions(-) rename src/hooks/{ => finally}/finally.ts (74%) rename src/hooks/{npm-update-notifier.ts => init/00_npm-update-notifier.ts} (94%) rename src/hooks/{prerun.ts => init/01_initialize_amplitude.ts} (65%) create mode 100644 src/hooks/prerun/prerun.ts diff --git a/package-lock.json b/package-lock.json index c46e7723..3fbcef20 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,6 @@ "@oclif/core": "^4.5.2", "@oclif/plugin-help": "^6.2.32", "@oclif/plugin-update": "^4.7.4", - "@oclif/plugin-version": "^2.2.32", "graphql": "^16.11.0", "node-machine-id": "^1.1.12", "ora": "^8.2.0", @@ -4010,19 +4009,6 @@ "node": ">=12.20" } }, - "node_modules/@oclif/plugin-version": { - "version": "2.2.32", - "resolved": "https://registry.npmjs.org/@oclif/plugin-version/-/plugin-version-2.2.32.tgz", - "integrity": "sha512-KwsEKjb202nthRIwigyvRNQ5vK8mUr/FnPzBjkLX7SbgPMLM7iqoaWDPZqBvq5/A/226Ey4vCf64y3zJh4eaWA==", - "license": "MIT", - "dependencies": { - "@oclif/core": "^4", - "ansis": "^3.17.0" - }, - "engines": { - "node": ">=18.0.0" - } - }, "node_modules/@oclif/plugin-warn-if-update-available": { "version": "3.1.46", "resolved": "https://registry.npmjs.org/@oclif/plugin-warn-if-update-available/-/plugin-warn-if-update-available-3.1.46.tgz", diff --git a/package.json b/package.json index 93c0dabd..24656ced 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,6 @@ "@oclif/core": "^4.5.2", "@oclif/plugin-help": "^6.2.32", "@oclif/plugin-update": "^4.7.4", - "@oclif/plugin-version": "^2.2.32", "graphql": "^16.11.0", "node-machine-id": "^1.1.12", "ora": "^8.2.0", @@ -85,13 +84,15 @@ "plugins": [ "@oclif/plugin-help", "@oclif/plugin-plugins", - "@oclif/plugin-update", - "@oclif/plugin-version" + "@oclif/plugin-update" ], "hooks": { - "init": "./dist/hooks/npm-update-notifier.js", - "prerun": "./dist/hooks/prerun.js", - "finally": "./dist/hooks/finally.js" + "init": [ + "./dist/hooks/init/00_npm-update-notifier.js", + "./dist/hooks/init/01_initialize_amplitude.js" + ], + "prerun": "./dist/hooks/prerun/prerun.js", + "finally": "./dist/hooks/finally/finally.js" }, "topicSeparator": " ", "macos": { diff --git a/src/commands/scan/eol.ts b/src/commands/scan/eol.ts index 656bd83e..6a6c122d 100644 --- a/src/commands/scan/eol.ts +++ b/src/commands/scan/eol.ts @@ -52,7 +52,7 @@ export default class ScanEol extends Command { default: false, description: `Save the generated SBOM as ${filenamePrefix}.sbom.json in the scanned directory`, }), - version: Flags.version() + version: Flags.version(), }; public async run(): Promise { diff --git a/src/hooks/finally.ts b/src/hooks/finally/finally.ts similarity index 74% rename from src/hooks/finally.ts rename to src/hooks/finally/finally.ts index edf3d525..c769ac6a 100644 --- a/src/hooks/finally.ts +++ b/src/hooks/finally/finally.ts @@ -1,11 +1,11 @@ import type { Hook } from '@oclif/core'; -import ora from 'ora'; -import { track } from '../service/analytics.svc.ts'; +import ora, { type Ora } from 'ora'; +import { track } from '../../service/analytics.svc.ts'; const hook: Hook<'finally'> = async (opts) => { - const isHelpOrVersionCmd = opts.argv.includes('--help') || opts.argv.includes('--version') || opts.Command?.id === 'version' - - let spinner; + const isHelpOrVersionCmd = opts.argv.includes('--help') || opts.argv.includes('--version'); + + let spinner: Ora | undefined; if (!isHelpOrVersionCmd) { spinner = ora().start('Cleaning up'); @@ -20,7 +20,6 @@ const hook: Hook<'finally'> = async (opts) => { await event; spinner?.stop(); } - }; export default hook; diff --git a/src/hooks/npm-update-notifier.ts b/src/hooks/init/00_npm-update-notifier.ts similarity index 94% rename from src/hooks/npm-update-notifier.ts rename to src/hooks/init/00_npm-update-notifier.ts index a57cce08..e24442f1 100644 --- a/src/hooks/npm-update-notifier.ts +++ b/src/hooks/init/00_npm-update-notifier.ts @@ -1,7 +1,7 @@ import type { Hook } from '@oclif/core'; import updateNotifier, { type UpdateInfo } from 'update-notifier'; -import pkg from '../../package.json' with { type: 'json' }; -import { debugLogger } from '../service/log.svc.ts'; +import pkg from '../../../package.json' with { type: 'json' }; +import { debugLogger } from '../../service/log.svc.ts'; const updateNotifierHook: Hook.Init = async (options) => { debugLogger('pkg.version', pkg.version); diff --git a/src/hooks/prerun.ts b/src/hooks/init/01_initialize_amplitude.ts similarity index 65% rename from src/hooks/prerun.ts rename to src/hooks/init/01_initialize_amplitude.ts index 50b9c72b..866e0c56 100644 --- a/src/hooks/prerun.ts +++ b/src/hooks/init/01_initialize_amplitude.ts @@ -1,9 +1,8 @@ import { parseArgs } from 'node:util'; import type { Hook } from '@oclif/core'; -import debug from 'debug'; -import { initializeAnalytics, track } from '../service/analytics.svc.ts'; +import { initializeAnalytics, track } from '../../service/analytics.svc.ts'; -const hook: Hook<'prerun'> = async (opts) => { +const hook: Hook.Init = async () => { const args = parseArgs({ allowPositionals: true, strict: false }); initializeAnalytics(); track('CLI Command Submitted', (context) => ({ @@ -14,11 +13,6 @@ const hook: Hook<'prerun'> = async (opts) => { cli_version: context.cli_version, started_at: context.started_at, })); - - // If JSON flag is enabled, silence debug logging - if (opts.Command.prototype.jsonEnabled()) { - debug.disable(); - } }; export default hook; diff --git a/src/hooks/prerun/prerun.ts b/src/hooks/prerun/prerun.ts new file mode 100644 index 00000000..f6d90b2a --- /dev/null +++ b/src/hooks/prerun/prerun.ts @@ -0,0 +1,11 @@ +import type { Hook } from '@oclif/core'; +import debug from 'debug'; + +const hook: Hook<'prerun'> = async (opts) => { + // If JSON flag is enabled, silence debug logging + if (opts.Command.prototype.jsonEnabled()) { + debug.disable(); + } +}; + +export default hook; diff --git a/test/hooks/npm-update-notifier.test.ts b/test/hooks/npm-update-notifier.test.ts index 82acd0cf..c26fa044 100644 --- a/test/hooks/npm-update-notifier.test.ts +++ b/test/hooks/npm-update-notifier.test.ts @@ -1,6 +1,6 @@ import assert from 'node:assert'; import { describe, it } from 'node:test'; -import { getDistTag, handleUpdate } from '../../src/hooks/npm-update-notifier.ts'; +import { getDistTag, handleUpdate } from '../../src/hooks/init/00_npm-update-notifier'; describe('getDistTag', () => { it('should return beta for beta versions', () => {