@optique/run 1.4.0-dev.2678 → 1.4.0-dev.2679

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/run.cjs +2 -0
  2. package/dist/run.d.cts +17 -1
  3. package/dist/run.d.ts +17 -1
  4. package/dist/run.js +2 -0
  5. package/package.json +4 -4
package/dist/run.cjs CHANGED
@@ -79,6 +79,7 @@ function buildCoreOptions(options, programMetadata) {
79
79
  const termWidth = options.termWidth;
80
80
  const showDefault = options.showDefault;
81
81
  const showChoices = options.showChoices;
82
+ const showAliases = options.showAliases;
82
83
  const showEnvironment = options.showEnvironment;
83
84
  const showUsage = options.showUsage;
84
85
  const usageLine = options.usageLine;
@@ -163,6 +164,7 @@ function buildCoreOptions(options, programMetadata) {
163
164
  termWidth,
164
165
  showDefault,
165
166
  showChoices,
167
+ showAliases,
166
168
  showEnvironment,
167
169
  showUsage,
168
170
  usageLine,
package/dist/run.d.cts CHANGED
@@ -5,7 +5,7 @@ import { SourceContext } from "@optique/core/context";
5
5
  import { CommandListMode, CommandSubConfig, ContextOptionsParam, HelpSectionsOptions, OptionSubConfig, RunOptions as RunOptions$1 } from "@optique/core/facade";
6
6
  import { InferMode, InferValue, Mode, ModeValue, Parser } from "@optique/core/parser";
7
7
  import { Program } from "@optique/core/program";
8
- import { DocSection, ShowChoicesOptions, ShowDefaultOptions, ShowEnvironmentOptions } from "@optique/core/doc";
8
+ import { DocSection, ShowAliasesOptions, ShowChoicesOptions, ShowDefaultOptions, ShowEnvironmentOptions } from "@optique/core/doc";
9
9
  import { Usage } from "@optique/core/usage";
10
10
 
11
11
  //#region src/run.d.ts
@@ -107,6 +107,22 @@ interface RunOptions {
107
107
  * @since 0.10.0
108
108
  */
109
109
  readonly showChoices?: boolean | ShowChoicesOptions;
110
+ /**
111
+ * Whether and how to display command aliases in command lists of help
112
+ * output.
113
+ *
114
+ * - `boolean`: When `true`, displays aliases using format
115
+ * `(aliases: i, add)`
116
+ * - `ShowAliasesOptions`: Custom formatting with configurable prefix,
117
+ * suffix, and label
118
+ *
119
+ * This is the fallback for commands that do not set their own
120
+ * `showAliases` option. Usage lines always show canonical command names.
121
+ *
122
+ * @default `false`
123
+ * @since 1.4.0
124
+ */
125
+ readonly showAliases?: boolean | ShowAliasesOptions;
110
126
  /**
111
127
  * Displays declared environment bindings in help. `true` selects inline
112
128
  * annotations; an object can select a section or both. Names without visible
package/dist/run.d.ts CHANGED
@@ -5,7 +5,7 @@ import { ShellCompletion } from "@optique/core/completion";
5
5
  import { SourceContext } from "@optique/core/context";
6
6
  import { InferMode, InferValue, Mode, ModeValue, Parser } from "@optique/core/parser";
7
7
  import { Program } from "@optique/core/program";
8
- import { DocSection, ShowChoicesOptions, ShowDefaultOptions, ShowEnvironmentOptions } from "@optique/core/doc";
8
+ import { DocSection, ShowAliasesOptions, ShowChoicesOptions, ShowDefaultOptions, ShowEnvironmentOptions } from "@optique/core/doc";
9
9
  import { Usage } from "@optique/core/usage";
10
10
 
11
11
  //#region src/run.d.ts
@@ -107,6 +107,22 @@ interface RunOptions {
107
107
  * @since 0.10.0
108
108
  */
109
109
  readonly showChoices?: boolean | ShowChoicesOptions;
110
+ /**
111
+ * Whether and how to display command aliases in command lists of help
112
+ * output.
113
+ *
114
+ * - `boolean`: When `true`, displays aliases using format
115
+ * `(aliases: i, add)`
116
+ * - `ShowAliasesOptions`: Custom formatting with configurable prefix,
117
+ * suffix, and label
118
+ *
119
+ * This is the fallback for commands that do not set their own
120
+ * `showAliases` option. Usage lines always show canonical command names.
121
+ *
122
+ * @default `false`
123
+ * @since 1.4.0
124
+ */
125
+ readonly showAliases?: boolean | ShowAliasesOptions;
110
126
  /**
111
127
  * Displays declared environment bindings in help. `true` selects inline
112
128
  * annotations; an object can select a section or both. Names without visible
package/dist/run.js CHANGED
@@ -78,6 +78,7 @@ function buildCoreOptions(options, programMetadata) {
78
78
  const termWidth = options.termWidth;
79
79
  const showDefault = options.showDefault;
80
80
  const showChoices = options.showChoices;
81
+ const showAliases = options.showAliases;
81
82
  const showEnvironment = options.showEnvironment;
82
83
  const showUsage = options.showUsage;
83
84
  const usageLine = options.usageLine;
@@ -162,6 +163,7 @@ function buildCoreOptions(options, programMetadata) {
162
163
  termWidth,
163
164
  showDefault,
164
165
  showChoices,
166
+ showAliases,
165
167
  showEnvironment,
166
168
  showUsage,
167
169
  usageLine,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/run",
3
- "version": "1.4.0-dev.2678",
3
+ "version": "1.4.0-dev.2679",
4
4
  "description": "Type-safe combinatorial command-line interface parser",
5
5
  "keywords": [
6
6
  "CLI",
@@ -76,11 +76,11 @@
76
76
  },
77
77
  "sideEffects": false,
78
78
  "dependencies": {
79
- "@optique/core": "1.4.0-dev.2678+a475f32a"
79
+ "@optique/core": "1.4.0-dev.2679+3a3a57d2"
80
80
  },
81
81
  "devDependencies": {
82
- "@optique/config": "1.4.0-dev.2678+a475f32a",
83
- "@optique/env": "1.4.0-dev.2678+a475f32a",
82
+ "@optique/config": "1.4.0-dev.2679+3a3a57d2",
83
+ "@optique/env": "1.4.0-dev.2679+3a3a57d2",
84
84
  "@types/node": "^24.0.0",
85
85
  "fast-check": "^4.7.0",
86
86
  "tsdown": "^0.13.0",