@oclif/core 4.1.0 → 4.2.0

package/lib/interfaces/hooks.d.ts

@@ -33,6 +33,13 @@ export interface Hooks {
         };
         return: unknown;
     };
+    finally: {
+        options: {
+            argv: string[];
+            id: string;
+        };
+        return: void;
+    };
     init: {
         options: {
             argv: string[];
@@ -105,6 +112,10 @@ export type Hook<T extends keyof P, P extends Hooks = Hooks> = (this: Hook.Conte
     context: Context;
 }) => Promise<P[T]['return']>;
 export declare namespace Hook {
+    /**
+     * Runs at the end of the CLI lifecycle - regardless of success or failure.
+     */
+    type Finally = Hook<'finally'>;
     /**
      * Runs when the CLI is initialized before a command is executed.
      */

package/lib/main.js

@@ -37,13 +37,6 @@ exports.versionAddition = versionAddition;
 async function run(argv, options) {
     const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, 'main.run');
     const initMarker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, 'main.run#init');
-    const collectPerf = async () => {
-        marker?.stop();
-        if (!initMarker?.stopped)
-            initMarker?.stop();
-        await performance_1.Performance.collect();
-        performance_1.Performance.debug();
-    };
     const showHelp = async (argv) => {
         const Help = await (0, help_1.loadHelpClass)(config);
         const help = new Help(config, config.pjson.oclif.helpOptions ?? config.pjson.helpOptions);
@@ -66,18 +59,26 @@ async function run(argv, options) {
         argv = [symbols_1.SINGLE_COMMAND_CLI_SYMBOL, ...argv];
     }
     const [id, ...argvSlice] = (0, help_1.normalizeArgv)(config, argv);
+    const runFinally = async () => {
+        marker?.stop();
+        if (!initMarker?.stopped)
+            initMarker?.stop();
+        await performance_1.Performance.collect();
+        performance_1.Performance.debug();
+        await config.runHook('finally', { argv: argvSlice, id });
+    };
     // run init hook
     await config.runHook('init', { argv: argvSlice, id });
     // display version if applicable
     if ((0, exports.versionAddition)(argv, config)) {
         ux_1.ux.stdout(config.userAgent);
-        await collectPerf();
+        await runFinally();
         return;
     }
     // display help version if applicable
     if ((0, exports.helpAddition)(argv, config)) {
         await showHelp(argv);
-        await collectPerf();
+        await runFinally();
         return;
     }
     // find & run command
@@ -86,7 +87,7 @@ async function run(argv, options) {
         const topic = config.flexibleTaxonomy ? null : config.findTopic(id);
         if (topic) {
             await showHelp([id]);
-            await collectPerf();
+            await runFinally();
             return;
         }
     }
@@ -95,6 +96,6 @@ async function run(argv, options) {
         return await config.runCommand(id, argvSlice, cmd);
     }
     finally {
-        await collectPerf();
+        await runFinally();
     }
 }

package/lib/ux/index.d.ts

@@ -11,6 +11,7 @@ export { warn } from '../errors/warn';
 export { default as colorizeJson } from './colorize-json';
 export { colorize } from './theme';
 export { stderr, stdout } from './write';
+export declare const action: Simple | Spinner;
 export declare const ux: {
     action: Simple | Spinner;
     /**

package/lib/ux/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ux = exports.stdout = exports.stderr = exports.colorize = exports.colorizeJson = exports.warn = exports.exit = exports.error = void 0;
+exports.ux = exports.action = exports.stdout = exports.stderr = exports.colorize = exports.colorizeJson = exports.warn = exports.exit = exports.error = void 0;
 const error_1 = require("../errors/error");
 const exit_1 = require("../errors/exit");
 const warn_1 = require("../errors/warn");
@@ -30,8 +30,9 @@ const ACTION_TYPE = (Boolean(process.stderr.isTTY) &&
     !['dumb', 'emacs-color'].includes(process.env.TERM) &&
     'spinner') ||
     'simple';
+exports.action = ACTION_TYPE === 'spinner' ? new spinner_1.default() : new simple_1.default();
 exports.ux = {
-    action: ACTION_TYPE === 'spinner' ? new spinner_1.default() : new simple_1.default(),
+    action: exports.action,
     /**
      * Add color to text.
      * @param color color to use. Can be hex code (e.g. `#ff0000`), rgb (e.g. `rgb(255, 255, 255)`) or a standard ansi color (e.g. `red`)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {