@oclif/core 3.14.0 → 3.15.0

package/lib/help/command.js

@@ -16,6 +16,16 @@ const formatter_1 = require("./formatter");
 // written on any platform, that may use \r\n or \n, will be
 // split on any platform, not just the os specific EOL at runtime.
 const POSSIBLE_LINE_FEED = /\r\n|\n/;
+/**
+ * Determines the sort order of flags. Will default to alphabetical if not set or set to an invalid value.
+ */
+function determineSortOrder(flagSortOrder) {
+    if (flagSortOrder === 'alphabetical')
+        return 'alphabetical';
+    if (flagSortOrder === 'none')
+        return 'none';
+    return 'alphabetical';
+}
 class CommandHelp extends formatter_1.HelpFormatter {
     command;
     config;
@@ -197,12 +207,15 @@ class CommandHelp extends formatter_1.HelpFormatter {
     }
     generate() {
         const cmd = this.command;
-        const flags = (0, util_1.sortBy)(Object.entries(cmd.flags || {})
+        const unsortedFlags = Object.entries(cmd.flags || {})
             .filter(([, v]) => !v.hidden)
             .map(([k, v]) => {
             v.name = k;
             return v;
-        }), (f) => [!f.char, f.char, f.name]);
+        });
+        const flags = determineSortOrder(this.opts.flagSortOrder) === 'alphabetical'
+            ? (0, util_1.sortBy)(unsortedFlags, (f) => [!f.char, f.char, f.name])
+            : unsortedFlags;
         const args = Object.values((0, ensure_arg_object_1.ensureArgObject)(cmd.args)).filter((a) => !a.hidden);
         const output = (0, util_1.compact)(this.sections().map(({ generate, header }) => {
             const body = generate({ args, cmd, flags }, header);

package/lib/interfaces/help.d.ts

@@ -4,6 +4,13 @@ export interface HelpOptions {
      * Use docopts as the usage. Defaults to true.
      */
     docopts?: boolean;
+    /**
+     * Order in which to sort flags in help output. Defaults to `alphabetical`.
+     *
+     * `alphabetical`: Sort flags alphabetically. All flags with short characters will come first.
+     * `none`: Do not sort flags. They will appear in the order in which they were defined on the command.
+     */
+    flagSortOrder?: 'alphabetical' | 'none';
     /**
      * If true, hide command aliases from the root help output. Defaults to false.
      */

package/lib/parser/errors.d.ts

@@ -49,9 +49,3 @@ export declare class FailedFlagValidationError extends CLIParseError {
         failed: Validation[];
     });
 }
-export declare class FailedFlagParsingError extends CLIParseError {
-    constructor({ flag, message }: {
-        flag: string;
-        message: string;
-    });
-}

package/lib/parser/errors.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.FailedFlagParsingError = exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.FlagInvalidOptionError = exports.NonExistentFlagsError = exports.UnexpectedArgsError = exports.RequiredArgsError = exports.InvalidArgsSpecError = exports.CLIParseError = exports.CLIError = void 0;
+exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.FlagInvalidOptionError = exports.NonExistentFlagsError = exports.UnexpectedArgsError = exports.RequiredArgsError = exports.InvalidArgsSpecError = exports.CLIParseError = exports.CLIError = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const cache_1 = __importDefault(require("../cache"));
 const list_1 = require("../cli-ux/list");
@@ -95,13 +95,3 @@ class FailedFlagValidationError extends CLIParseError {
     }
 }
 exports.FailedFlagValidationError = FailedFlagValidationError;
-class FailedFlagParsingError extends CLIParseError {
-    constructor({ flag, message }) {
-        super({
-            exit: cache_1.default.getInstance().get('exitCodes')?.failedFlagParsing,
-            message: `Parsing --${flag} \n\t${message}`,
-            parse: {},
-        });
-    }
-}
-exports.FailedFlagParsingError = FailedFlagParsingError;

package/lib/parser/parse.js

@@ -1,8 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Parser = exports.readStdin = void 0;
 /* eslint-disable no-await-in-loop */
 const node_readline_1 = require("node:readline");
+const cache_1 = __importDefault(require("../cache"));
 const util_1 = require("../util/util");
 const errors_1 = require("./errors");
 let debug;
@@ -264,7 +268,10 @@ class Parser {
                 return await flag.parse(input, ctx, flag);
             }
             catch (error) {
-                throw new errors_1.FailedFlagParsingError({ flag: flag.name, message: error.message });
+                error.message = `Parsing --${flag.name} \n\t${error.message}\nSee more help with --help`;
+                if (cache_1.default.getInstance().get('exitCodes')?.failedFlagParsing)
+                    error.oclif = { exit: cache_1.default.getInstance().get('exitCodes')?.failedFlagParsing };
+                throw error;
             }
         };
         /* Could add a valueFunction (if there is a value/env/default) and could metadata.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.14.0",
+  "version": "3.15.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -35,19 +35,19 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^17.8.1",
-    "@oclif/plugin-help": "^5.2.20",
-    "@oclif/plugin-plugins": "^3.3.0",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^4",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3.0.3",
     "@types/ansi-styles": "^3.2.1",
-    "@types/benchmark": "^2.1.2",
-    "@types/chai": "^4.3.10",
+    "@types/benchmark": "^2.1.5",
+    "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/clean-stack": "^2.1.1",
-    "@types/cli-progress": "^3.11.0",
+    "@types/cli-progress": "^3.11.5",
     "@types/color": "^3.0.5",
     "@types/debug": "^4.1.10",
-    "@types/ejs": "^3.1.3",
+    "@types/ejs": "^3.1.5",
     "@types/indent-string": "^4.0.1",
     "@types/js-yaml": "^3.12.7",
     "@types/mocha": "^10.0.2",