@oclif/core 3.14.1 → 3.15.1

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.14.1",
+  "version": "3.15.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -22,7 +22,7 @@
     "js-yaml": "^3.14.1",
     "natural-orderby": "^2.0.3",
     "object-treeify": "^1.1.33",
-    "password-prompt": "^1.1.2",
+    "password-prompt": "^1.1.3",
     "slice-ansi": "^4.0.0",
     "string-width": "^4.2.3",
     "strip-ansi": "^6.0.1",
@@ -35,29 +35,29 @@
   },
   "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",
+    "@types/mocha": "^10.0.6",
     "@types/node": "^18",
     "@types/node-notifier": "^8.0.2",
     "@types/pnpapi": "^0.0.4",
     "@types/slice-ansi": "^4.0.0",
     "@types/strip-ansi": "^5.2.1",
     "@types/supports-color": "^8.1.1",
-    "@types/wordwrap": "^1.0.1",
+    "@types/wordwrap": "^1.0.3",
     "@types/wrap-ansi": "^3.0.0",
     "benchmark": "^2.1.4",
     "chai": "^4.3.10",
@@ -75,9 +75,9 @@
     "madge": "^6.1.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.1",
     "shx": "^0.3.4",
-    "sinon": "^16.1.0",
+    "sinon": "^16.1.3",
     "ts-node": "^10.9.1",
     "tsd": "^0.29.0",
     "typescript": "^5"