@oclif/core 4.0.0-beta.7 → 4.0.0-beta.9

package/lib/interfaces/plugin.d.ts

@@ -3,35 +3,35 @@ import { Logger } from './logger';
 import { HookOptions, PJSON } from './pjson';
 import { Topic } from './topic';
 export interface PluginOptions {
-    children?: Plugin[];
-    errorOnManifestCreate?: boolean;
-    flexibleTaxonomy?: boolean;
-    ignoreManifest?: boolean;
-    isRoot?: boolean;
-    name?: string;
-    parent?: Plugin;
-    pjson?: PJSON.Plugin;
-    respectNoCacheDefault?: boolean;
+    children?: Plugin[] | undefined;
+    errorOnManifestCreate?: boolean | undefined;
+    flexibleTaxonomy?: boolean | undefined;
+    ignoreManifest?: boolean | undefined;
+    isRoot?: boolean | undefined;
+    name?: string | undefined;
+    parent?: Plugin | undefined;
+    pjson?: PJSON | undefined;
+    respectNoCacheDefault?: boolean | undefined;
     root: string;
-    tag?: string;
-    type?: string;
-    url?: string;
+    tag?: string | undefined;
+    type?: string | undefined;
+    url?: string | undefined;
 }
 export interface Options extends PluginOptions {
-    channel?: string;
-    devPlugins?: boolean;
-    enablePerf?: boolean;
-    jitPlugins?: boolean;
-    logger?: Logger;
-    pjson?: PJSON.Plugin;
+    channel?: string | undefined;
+    devPlugins?: boolean | undefined;
+    enablePerf?: boolean | undefined;
+    jitPlugins?: boolean | undefined;
+    logger?: Logger | undefined;
+    pjson?: PJSON | undefined;
     pluginAdditions?: {
         core?: string[];
         dev?: string[];
         path?: string;
-    };
-    plugins?: Map<string, Plugin>;
-    userPlugins?: boolean;
-    version?: string;
+    } | undefined;
+    plugins?: Map<string, Plugin> | undefined;
+    userPlugins?: boolean | undefined;
+    version?: string | undefined;
 }
 export interface Plugin {
     /**
@@ -69,13 +69,13 @@ export interface Plugin {
      */
     name: string;
     readonly options: Options;
-    parent?: Plugin;
+    parent?: Plugin | undefined;
     /**
      * full package.json
      *
      * parsed with read-pkg
      */
-    pjson: PJSON.CLI | PJSON.Plugin;
+    pjson: PJSON;
     /**
      * base path of plugin
      */
@@ -84,7 +84,7 @@ export interface Plugin {
      * npm dist-tag of plugin
      * only used for user plugins
      */
-    tag?: string;
+    tag?: string | undefined;
     readonly topics: Topic[];
     /**
      * used to tell the user how the plugin was installed

package/lib/interfaces/topic.d.ts

@@ -1,5 +1,5 @@
 export interface Topic {
-    description?: string;
-    hidden?: boolean;
+    description?: string | undefined;
+    hidden?: boolean | undefined;
     name: string;
 }

package/lib/main.js

@@ -11,7 +11,7 @@ const help_1 = require("./help");
 const logger_1 = require("./logger");
 const performance_1 = require("./performance");
 const symbols_1 = require("./symbols");
-const ux_1 = __importDefault(require("./ux"));
+const ux_1 = require("./ux");
 const helpAddition = (argv, config) => {
     if (argv.length === 0 && !config.isSingleCommandCLI)
         return true;
@@ -69,7 +69,7 @@ async function run(argv, options) {
     await config.runHook('init', { argv: argvSlice, id });
     // display version if applicable
     if ((0, exports.versionAddition)(argv, config)) {
-        ux_1.default.stdout(config.userAgent);
+        ux_1.ux.stdout(config.userAgent);
         await collectPerf();
         return;
     }

package/lib/parser/errors.d.ts

@@ -3,7 +3,7 @@ import { Arg, ArgInput, CLIParseErrorOptions, OptionFlag } from '../interfaces/p
 export { CLIError } from '../errors';
 export type Validation = {
     name: string;
-    reason?: string;
+    reason?: string | undefined;
     status: 'failed' | 'success';
     validationFn: string;
 };

package/lib/parser/index.d.ts

@@ -1,3 +1,3 @@
 import { Input, OutputArgs, OutputFlags, ParserOutput } from '../interfaces/parser';
 export { flagUsages } from './help';
-export declare function parse<TFlags extends OutputFlags<any>, BFlags extends OutputFlags<any>, TArgs extends OutputArgs<any>>(argv: string[], options: Input<TFlags, BFlags, TArgs>): Promise<ParserOutput<TFlags, BFlags, TArgs>>;
+export declare function parse<TFlags extends OutputFlags<any>, TArgs extends OutputArgs<any>>(argv: string[], options: Input<TFlags, TArgs>): Promise<ParserOutput<TFlags, TArgs>>;

package/lib/settings.d.ts

@@ -5,19 +5,19 @@ export type Settings = {
      * Environment Variable:
      *   OCLIF_COLUMNS=80
      */
-    columns?: number;
+    columns?: number | undefined;
     /**
      * Show additional debug output without DEBUG. Mainly shows stackstraces.
      *
      * Useful to set in the ./bin/dev.js script.
      * oclif.settings.debug = true;
      */
-    debug?: boolean;
+    debug?: boolean | undefined;
     /**
      * Enable performance tracking. Resulting data is available in the `perf` property of the `Config` class.
      * This will be overridden by the `enablePerf` property passed into Config constructor.
      */
-    performanceEnabled?: boolean;
+    performanceEnabled?: boolean | undefined;
     /**
      * Try to use ts-node to load typescript source files instead of javascript files.
      * Defaults to true in development and test environments (e.g. using bin/dev.js or
@@ -25,12 +25,12 @@ export type Settings = {
      *
      * @deprecated use enableAutoTranspile instead.
      */
-    tsnodeEnabled?: boolean;
+    tsnodeEnabled?: boolean | undefined;
     /**
      * Enable automatic transpilation of TypeScript files to JavaScript.
      *
      * Defaults to true in development and test environments (e.g. using bin/dev.js or NODE_ENV=development or NODE_ENV=test).
      */
-    enableAutoTranspile?: boolean;
+    enableAutoTranspile?: boolean | undefined;
 };
 export declare const settings: Settings;

package/lib/util/aggregate-flags.d.ts

@@ -1,2 +1,2 @@
 import { FlagInput, FlagOutput } from '../interfaces/parser';
-export declare function aggregateFlags<F extends FlagOutput, B extends FlagOutput>(flags: FlagInput<F> | undefined, baseFlags: FlagInput<B> | undefined, enableJsonFlag: boolean | undefined): FlagInput<F>;
+export declare function aggregateFlags<F extends FlagOutput>(flags: FlagInput<F> | undefined, enableJsonFlag: boolean | undefined): FlagInput<F>;

package/lib/util/aggregate-flags.js

@@ -6,8 +6,7 @@ const json = (0, flags_1.boolean)({
     description: 'Format output as json.',
     helpGroup: 'GLOBAL',
 });
-function aggregateFlags(flags, baseFlags, enableJsonFlag) {
-    const combinedFlags = { ...baseFlags, ...flags };
-    return (enableJsonFlag ? { json, ...combinedFlags } : combinedFlags);
+function aggregateFlags(flags, enableJsonFlag) {
+    return (enableJsonFlag ? { json, ...flags } : flags);
 }
 exports.aggregateFlags = aggregateFlags;

package/lib/util/cache-command.js

@@ -6,8 +6,7 @@ const cache_default_value_1 = require("./cache-default-value");
 const ensure_arg_object_1 = require("./ensure-arg-object");
 const util_1 = require("./util");
 // In order to collect static properties up the inheritance chain, we need to recursively
-// access the prototypes until there's nothing left. This allows us to combine baseFlags
-// and flags as well as add in the json flag if enableJsonFlag is enabled.
+// access the prototypes until there's nothing left.
 function mergePrototype(result, cmd) {
     const proto = Object.getPrototypeOf(cmd);
     const filteredProto = (0, util_1.pickBy)(proto, (v) => v !== undefined);
@@ -71,10 +70,10 @@ async function cacheCommand(uncachedCmd, plugin, respectNoCacheDefault = false)
     const cmd = mergePrototype(uncachedCmd, uncachedCmd);
     // @ts-expect-error because v2 commands have flags stored in _flags
     const uncachedFlags = cmd.flags ?? cmd._flags;
-    // @ts-expect-error because v2 commands have base flags stored in _baseFlags
+    // @ts-expect-error because v2 commands have base flags stored in `_baseFlags` and v4 commands never have `baseFlags`
     const uncachedBaseFlags = cmd.baseFlags ?? cmd._baseFlags;
     const [flags, args] = await Promise.all([
-        await cacheFlags((0, aggregate_flags_1.aggregateFlags)(uncachedFlags, uncachedBaseFlags, cmd.enableJsonFlag), respectNoCacheDefault),
+        await cacheFlags((0, aggregate_flags_1.aggregateFlags)({ ...uncachedFlags, ...uncachedBaseFlags }, cmd.enableJsonFlag), respectNoCacheDefault),
         await cacheArgs((0, ensure_arg_object_1.ensureArgObject)(cmd.args), respectNoCacheDefault),
     ]);
     const stdProperties = {

package/lib/util/determine-priority.d.ts

@@ -0,0 +1,21 @@
+import { Command } from '../command';
+/**
+ * This function is responsible for locating the correct plugin to use for a named command id
+ * It searches the {Config} registered commands to match either the raw command id or the command alias
+ * It is possible that more than one command will be found. This is due the ability of two distinct plugins to
+ * create the same command or command alias.
+ *
+ * In the case of more than one found command, the function will select the command based on the order in which
+ * the plugin is included in the package.json `oclif.plugins` list. The command that occurs first in the list
+ * is selected as the command to run.
+ *
+ * Commands can also be present from either an install or a link. When a command is one of these and a core plugin
+ * is present, this function defers to the core plugin.
+ *
+ * If there is not a core plugin command present, this function will return the first
+ * plugin as discovered (will not change the order)
+ *
+ * @param commands commands to determine the priority of
+ * @returns command instance {Command.Loadable} or undefined
+ */
+export declare function determinePriority(plugins: string[], commands: Command.Loadable[]): Command.Loadable;

package/lib/util/determine-priority.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.determinePriority = void 0;
+/**
+ * This function is responsible for locating the correct plugin to use for a named command id
+ * It searches the {Config} registered commands to match either the raw command id or the command alias
+ * It is possible that more than one command will be found. This is due the ability of two distinct plugins to
+ * create the same command or command alias.
+ *
+ * In the case of more than one found command, the function will select the command based on the order in which
+ * the plugin is included in the package.json `oclif.plugins` list. The command that occurs first in the list
+ * is selected as the command to run.
+ *
+ * Commands can also be present from either an install or a link. When a command is one of these and a core plugin
+ * is present, this function defers to the core plugin.
+ *
+ * If there is not a core plugin command present, this function will return the first
+ * plugin as discovered (will not change the order)
+ *
+ * @param commands commands to determine the priority of
+ * @returns command instance {Command.Loadable} or undefined
+ */
+function determinePriority(plugins, commands) {
+    const commandPlugins = commands.sort((a, b) => {
+        const pluginAliasA = a.pluginAlias ?? 'A-Cannot-Find-This';
+        const pluginAliasB = b.pluginAlias ?? 'B-Cannot-Find-This';
+        const aIndex = plugins.indexOf(pluginAliasA);
+        const bIndex = plugins.indexOf(pluginAliasB);
+        // When both plugin types are 'core' plugins sort based on index
+        if (a.pluginType === 'core' && b.pluginType === 'core') {
+            // If b appears first in the pjson.plugins sort it first
+            return aIndex - bIndex;
+        }
+        // if b is a core plugin and a is not sort b first
+        if (b.pluginType === 'core' && a.pluginType !== 'core') {
+            return 1;
+        }
+        // if a is a core plugin and b is not sort a first
+        if (a.pluginType === 'core' && b.pluginType !== 'core') {
+            return -1;
+        }
+        // if a is a jit plugin and b is not sort b first
+        if (a.pluginType === 'jit' && b.pluginType !== 'jit') {
+            return 1;
+        }
+        // if b is a jit plugin and a is not sort a first
+        if (b.pluginType === 'jit' && a.pluginType !== 'jit') {
+            return -1;
+        }
+        // neither plugin is core, so do not change the order
+        return 0;
+    });
+    return commandPlugins[0];
+}
+exports.determinePriority = determinePriority;

package/lib/util/ids.d.ts

@@ -1,3 +1,3 @@
-import { Config } from '../interfaces';
+import { type Config } from '../interfaces/config';
 export declare function toStandardizedId(commandID: string, config: Config): string;
 export declare function toConfiguredId(commandID: string, config: Config): string;

package/lib/util/read-pjson.d.ts

@@ -4,4 +4,4 @@ import { PJSON } from '../interfaces';
  *
  * We can assume that the package.json file exists because the plugin root has already been loaded at this point.
  */
-export declare function readPjson(path: string): Promise<PJSON.Plugin>;
+export declare function readPjson(path: string): Promise<PJSON>;

package/lib/ux/colorize-json.d.ts

@@ -1,6 +1,6 @@
 type Options = {
-    pretty?: boolean;
-    theme?: Record<string, string>;
+    pretty?: boolean | undefined;
+    theme?: Record<string, string> | undefined;
 };
 export declare function tokenize(json?: unknown, options?: Options): {
     type: string;

package/lib/ux/index.d.ts

@@ -5,7 +5,13 @@ import Simple from './action/simple';
 import Spinner from './action/spinner';
 import colorizeJson from './colorize-json';
 import { colorize } from './theme';
-export declare const methods: {
+export { error } from '../errors/error';
+export { exit } from '../errors/exit';
+export { warn } from '../errors/warn';
+export { default as colorizeJson } from './colorize-json';
+export { colorize } from './theme';
+export { stderr, stdout } from './write';
+export declare const ux: {
     action: Simple | Spinner;
     /**
      * Add color to text.
@@ -61,4 +67,3 @@ export declare const methods: {
      */
     warn: typeof warn;
 };
-export default methods;

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.methods = void 0;
+exports.ux = 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");
@@ -12,12 +12,25 @@ const spinner_1 = __importDefault(require("./action/spinner"));
 const colorize_json_1 = __importDefault(require("./colorize-json"));
 const theme_1 = require("./theme");
 const write_1 = require("./write");
+var error_2 = require("../errors/error");
+Object.defineProperty(exports, "error", { enumerable: true, get: function () { return error_2.error; } });
+var exit_2 = require("../errors/exit");
+Object.defineProperty(exports, "exit", { enumerable: true, get: function () { return exit_2.exit; } });
+var warn_2 = require("../errors/warn");
+Object.defineProperty(exports, "warn", { enumerable: true, get: function () { return warn_2.warn; } });
+var colorize_json_2 = require("./colorize-json");
+Object.defineProperty(exports, "colorizeJson", { enumerable: true, get: function () { return __importDefault(colorize_json_2).default; } });
+var theme_2 = require("./theme");
+Object.defineProperty(exports, "colorize", { enumerable: true, get: function () { return theme_2.colorize; } });
+var write_2 = require("./write");
+Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return write_2.stderr; } });
+Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return write_2.stdout; } });
 const ACTION_TYPE = (Boolean(process.stderr.isTTY) &&
     !process.env.CI &&
     !['dumb', 'emacs-color'].includes(process.env.TERM) &&
     'spinner') ||
     'simple';
-exports.methods = {
+exports.ux = {
     action: ACTION_TYPE === 'spinner' ? new spinner_1.default() : new simple_1.default(),
     /**
      * Add color to text.
@@ -73,4 +86,3 @@ exports.methods = {
      */
     warn: warn_1.warn,
 };
-exports.default = exports.methods;

package/lib/ux/theme.d.ts

@@ -6,4 +6,4 @@ import { StandardAnsi, Theme } from '../interfaces/theme';
  * @returns colorized string
  */
 export declare function colorize(color: string | StandardAnsi | undefined, text: string): string;
-export declare function parseTheme(theme: Record<string, string>): Theme;
+export declare function parseTheme(theme: Record<string, string | Record<string, string>>): Theme;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.9",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -28,6 +28,7 @@
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-plugins": "^5",
     "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
     "@types/benchmark": "^2.1.5",
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
@@ -57,7 +58,7 @@
     "nyc": "^15.1.0",
     "prettier": "^3.2.5",
     "shx": "^0.3.4",
-    "sinon": "^17",
+    "sinon": "^18",
     "ts-node": "^10.9.2",
     "tsd": "^0.31.0",
     "typescript": "^5"
@@ -66,10 +67,7 @@
     "node": ">=18.0.0"
   },
   "files": [
-    "/lib",
-    "/flush.js",
-    "/flush.d.ts",
-    "/handle.js"
+    "/lib"
   ],
   "homepage": "https://github.com/oclif/core",
   "keywords": [
@@ -82,7 +80,26 @@
     "argv"
   ],
   "license": "MIT",
-  "main": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./args": "./lib/args.js",
+    "./command": "./lib/command.js",
+    "./config": "./lib/config/index.js",
+    "./errors": "./lib/errors/index.js",
+    "./execute": "./lib/execute.js",
+    "./flags": "./lib/flags.js",
+    "./flush": "./lib/flush.js",
+    "./handle": "./lib/errors/handle.js",
+    "./help": "./lib/help/index.js",
+    "./hooks": "./lib/interfaces/hooks.js",
+    "./interfaces": "./lib/interfaces/index.js",
+    "./logger": "./lib/logger.js",
+    "./performance": "./lib/performance.js",
+    "./run": "./lib/main.js",
+    "./settings": "./lib/settings.js",
+    "./util/ids": "./lib/util/ids.js",
+    "./ux": "./lib/ux/index.js"
+  },
   "repository": "oclif/core",
   "oclif": {
     "bin": "oclif",
@@ -96,20 +113,18 @@
   },
   "scripts": {
     "build": "shx rm -rf lib && tsc",
-    "commitlint": "commitlint",
     "compile": "tsc",
     "format": "prettier --write \"+(src|test)/**/*.+(ts|js|json)\"",
     "lint": "eslint . --ext .ts",
     "posttest": "yarn lint && yarn test:circular-deps",
     "prepack": "yarn run build",
     "prepare": "husky",
-    "pretest": "yarn build && tsc -p test --noEmit --skipLibCheck",
-    "test:circular-deps": "madge lib/ -c",
+    "test:circular-deps": "yarn build && madge lib/ -c",
     "test:debug": "nyc mocha --debug-brk --inspect \"test/**/*.test.ts\"",
     "test:integration": "mocha --forbid-only \"test/**/*.integration.ts\" --parallel --timeout 1200000",
     "test:interoperability": "cross-env DEBUG=integration:* ts-node test/integration/interop.ts",
     "test:perf": "ts-node test/perf/parser.perf.ts",
-    "test": "nyc mocha --forbid-only \"test/**/*.test.ts\""
+    "test": "nyc mocha --forbid-only \"test/**/*.test.ts\" --parallel"
   },
   "types": "lib/index.d.ts"
 }

package/flush.d.ts

@@ -1,3 +0,0 @@
-declare const flush: () => Promise<void>
-
-export = flush

package/flush.js

@@ -1 +0,0 @@
-module.exports = require('./lib/cli-ux/flush').flush

package/handle.js

@@ -1 +0,0 @@
-module.exports = async error => require('./lib/errors/handle').handle(error)