@optique/run 1.0.0-dev.400 → 1.0.0-dev.407

package/dist/run.cjs

@@ -32,7 +32,7 @@ function runImpl(parserOrProgram, options = {}) {
 			footer: program.metadata.footer
 		};
 	} else parser = parserOrProgram;
-	const { programName = programNameFromProgram ?? node_path.default.basename(node_process.default.argv[1] || "cli"), args = node_process.default.argv.slice(2), colors = node_process.default.stdout.isTTY, maxWidth = node_process.default.stdout.columns, showDefault, showChoices, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, examples = programMetadata?.examples, author = programMetadata?.author, bugs = programMetadata?.bugs, footer = programMetadata?.footer } = options;
+	const { programName = programNameFromProgram ?? node_path.default.basename(node_process.default.argv[1] || "cli"), args = node_process.default.argv.slice(2), colors = node_process.default.stdout.isTTY, maxWidth = node_process.default.stdout.columns, showDefault, showChoices, sectionOrder, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, examples = programMetadata?.examples, author = programMetadata?.author, bugs = programMetadata?.bugs, footer = programMetadata?.footer } = options;
 	const helpConfig = help ? typeof help === "string" ? {
 		mode: help,
 		onShow: () => node_process.default.exit(0)
@@ -109,6 +109,7 @@ function runImpl(parserOrProgram, options = {}) {
 		maxWidth,
 		showDefault,
 		showChoices,
+		sectionOrder,
 		help: helpConfig,
 		version: versionConfig,
 		completion: completionConfig,

package/dist/run.d.cts

@@ -1,7 +1,7 @@
 import { ShellCompletion } from "@optique/core/completion";
 import { InferMode, InferValue, Mode, ModeValue, Parser } from "@optique/core/parser";
 import { Program } from "@optique/core/program";
-import { ShowChoicesOptions, ShowDefaultOptions } from "@optique/core/doc";
+import { DocSection, ShowChoicesOptions, ShowDefaultOptions } from "@optique/core/doc";
 import { Message } from "@optique/core/message";
 
 //#region src/run.d.ts
@@ -62,6 +62,20 @@ interface RunOptions {
    * @since 0.10.0
    */
   readonly showChoices?: boolean | ShowChoicesOptions;
+  /**
+   * A custom comparator function to control the order of sections in the
+   * help output.  When provided, it is used instead of the default smart
+   * sort (command-only sections first, then mixed, then option/argument-only
+   * sections).  Sections that compare equal (return `0`) preserve their
+   * original relative order.
+   *
+   * @param a The first section to compare.
+   * @param b The second section to compare.
+   * @returns A negative number if `a` should appear before `b`, a positive
+   *   number if `a` should appear after `b`, or `0` if they are equal.
+   * @since 1.0.0
+   */
+  readonly sectionOrder?: (a: DocSection, b: DocSection) => number;
   /**
    * Help configuration. Determines how help is made available:
    *

package/dist/run.d.ts

@@ -2,7 +2,7 @@ import { Message } from "@optique/core/message";
 import { ShellCompletion } from "@optique/core/completion";
 import { InferMode, InferValue, Mode, ModeValue, Parser } from "@optique/core/parser";
 import { Program } from "@optique/core/program";
-import { ShowChoicesOptions, ShowDefaultOptions } from "@optique/core/doc";
+import { DocSection, ShowChoicesOptions, ShowDefaultOptions } from "@optique/core/doc";
 
 //#region src/run.d.ts
 
@@ -62,6 +62,20 @@ interface RunOptions {
    * @since 0.10.0
    */
   readonly showChoices?: boolean | ShowChoicesOptions;
+  /**
+   * A custom comparator function to control the order of sections in the
+   * help output.  When provided, it is used instead of the default smart
+   * sort (command-only sections first, then mixed, then option/argument-only
+   * sections).  Sections that compare equal (return `0`) preserve their
+   * original relative order.
+   *
+   * @param a The first section to compare.
+   * @param b The second section to compare.
+   * @returns A negative number if `a` should appear before `b`, a positive
+   *   number if `a` should appear after `b`, or `0` if they are equal.
+   * @since 1.0.0
+   */
+  readonly sectionOrder?: (a: DocSection, b: DocSection) => number;
   /**
    * Help configuration. Determines how help is made available:
    *

package/dist/run.js

@@ -31,7 +31,7 @@ function runImpl(parserOrProgram, options = {}) {
 			footer: program.metadata.footer
 		};
 	} else parser = parserOrProgram;
-	const { programName = programNameFromProgram ?? path.basename(process.argv[1] || "cli"), args = process.argv.slice(2), colors = process.stdout.isTTY, maxWidth = process.stdout.columns, showDefault, showChoices, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, examples = programMetadata?.examples, author = programMetadata?.author, bugs = programMetadata?.bugs, footer = programMetadata?.footer } = options;
+	const { programName = programNameFromProgram ?? path.basename(process.argv[1] || "cli"), args = process.argv.slice(2), colors = process.stdout.isTTY, maxWidth = process.stdout.columns, showDefault, showChoices, sectionOrder, help, version, completion, aboveError = "usage", errorExitCode = 1, brief = programMetadata?.brief, description = programMetadata?.description, examples = programMetadata?.examples, author = programMetadata?.author, bugs = programMetadata?.bugs, footer = programMetadata?.footer } = options;
 	const helpConfig = help ? typeof help === "string" ? {
 		mode: help,
 		onShow: () => process.exit(0)
@@ -108,6 +108,7 @@ function runImpl(parserOrProgram, options = {}) {
 		maxWidth,
 		showDefault,
 		showChoices,
+		sectionOrder,
 		help: helpConfig,
 		version: versionConfig,
 		completion: completionConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/run",
-  "version": "1.0.0-dev.400+a38bcb54",
+  "version": "1.0.0-dev.407+21363ee4",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",
@@ -70,7 +70,7 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@optique/core": "1.0.0-dev.400+a38bcb54"
+    "@optique/core": "1.0.0-dev.407+21363ee4"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",