@oclif/core 3.25.3 → 3.26.1

package/lib/command.js

@@ -243,7 +243,14 @@ class Command {
             ...options,
             flags: (0, aggregate_flags_1.aggregateFlags)(options.flags, options.baseFlags, options.enableJsonFlag),
         };
-        const results = await Parser.parse(argv, opts);
+        const hookResult = await this.config.runHook('preparse', { argv: [...argv], options: opts });
+        // Since config.runHook will only run the hook for the root plugin, hookResult.successes will always have a length of 0 or 1
+        // But to be extra safe, we find the result that matches the root plugin.
+        const argvToParse = hookResult.successes?.length
+            ? hookResult.successes.find((s) => s.plugin.root === cache_1.default.getInstance().get('rootPlugin')?.root)?.result ?? argv
+            : argv;
+        this.argv = [...argvToParse];
+        const results = await Parser.parse(argvToParse, opts);
         this.warnIfFlagDeprecated(results.flags ?? {});
         return results;
     }

package/lib/config/config.js

@@ -50,6 +50,7 @@ const util_3 = require("./util");
 const debug = (0, util_3.Debug)();
 const _pjson = cache_1.default.getInstance().get('@oclif/core');
 const BASE = `${_pjson.name}@${_pjson.version}`;
+const ROOT_ONLY_HOOKS = new Set(['preparse']);
 function channelFromVersion(version) {
     const m = version.match(/[^-]+(?:-([^.]+))?/);
     return (m && m[1]) || 'stable';
@@ -468,7 +469,8 @@ class Config {
             failures: [],
             successes: [],
         };
-        const promises = [...this.plugins.values()].map(async (p) => {
+        const plugins = ROOT_ONLY_HOOKS.has(event) ? [this.rootPlugin] : [...this.plugins.values()];
+        const promises = plugins.map(async (p) => {
             const debug = require('debug')([this.bin, p.name, 'hooks', event].join(':'));
             const context = {
                 config: this,

package/lib/interfaces/hooks.d.ts

@@ -1,5 +1,6 @@
 import { Command } from '../command';
 import { Config } from './config';
+import { Input, OutputFlags } from './parser';
 import { Plugin } from './plugin';
 interface HookMeta {
     options: Record<string, unknown>;
@@ -70,6 +71,13 @@ export interface Hooks {
         };
         return: void;
     };
+    preparse: {
+        options: {
+            argv: string[];
+            options: Input<OutputFlags<any>, OutputFlags<any>, OutputFlags<any>>;
+        };
+        return: string[];
+    };
     prerun: {
         options: {
             Command: Command.Class;
@@ -97,14 +105,47 @@ 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 when the CLI is initialized before a command is executed.
+     */
     type Init = Hook<'init'>;
+    /**
+     * Runs before the `plugins install` command from @oclif/plugin-plugins is run.
+     */
     type PluginsPreinstall = Hook<'plugins:preinstall'>;
+    /**
+     * Runs after the `init` hook, after a command is found but before it is executed.
+     */
     type Prerun = Hook<'prerun'>;
+    /**
+     * Runs after a command is successfully executed. Does not run if the command fails.
+     */
     type Postrun = Hook<'postrun'>;
+    /**
+     * Runs before the CLI is updated by `update` command from @oclif/plugin-update.
+     */
     type Preupdate = Hook<'preupdate'>;
+    /**
+     * Runs before a command's flags and args are parsed. Useful for modifying the command line arguments before they are parsed.
+     *
+     * The return value is a string[] of the modified arguments.
+     */
+    type Preparse = Hook<'preparse'>;
+    /**
+     * Runs once the `update` command from @oclif/plugin-update is run.
+     */
     type Update = Hook<'update'>;
+    /**
+     * Runs when a command is not found.
+     */
     type CommandNotFound = Hook<'command_not_found'>;
+    /**
+     * Runs when a partial command is entered and no matching command is found.
+     */
     type CommandIncomplete = Hook<'command_incomplete'>;
+    /**
+     * Runs when a command from an uninstalled JIT plugins is run.
+     */
     type JitPluginNotInstalled = Hook<'jit_plugin_not_installed'>;
     interface Context {
         config: Config;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.25.3",
+  "version": "3.26.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -21,7 +21,7 @@
     "indent-string": "^4.0.0",
     "is-wsl": "^2.2.0",
     "js-yaml": "^3.14.1",
-    "minimatch": "^9.0.3",
+    "minimatch": "^9.0.4",
     "natural-orderby": "^2.0.3",
     "object-treeify": "^1.1.33",
     "password-prompt": "^1.1.3",
@@ -39,7 +39,7 @@
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-plugins": "^4",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3.2.1",
+    "@oclif/test": "^3.2.8",
     "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.5",
     "@types/chai": "^4.3.11",
@@ -65,21 +65,21 @@
     "commitlint": "^17.8.1",
     "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
-    "eslint-config-oclif": "^5.1.0",
-    "eslint-config-oclif-typescript": "^3.1.2",
+    "eslint-config-oclif": "^5.1.1",
+    "eslint-config-oclif-typescript": "^3.1.3",
     "eslint-config-prettier": "^9.1.0",
-    "fancy-test": "^3.0.13",
+    "fancy-test": "^3.0.14",
     "globby": "^11.1.0",
     "husky": "^8",
     "lint-staged": "^14.0.1",
     "madge": "^6.1.0",
-    "mocha": "^10.3.0",
+    "mocha": "^10.4.0",
     "nyc": "^15.1.0",
     "prettier": "^3.2.5",
     "shx": "^0.3.4",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.2",
-    "tsd": "^0.30.6",
+    "tsd": "^0.31.0",
     "typescript": "^5"
   },
   "engines": {