@kjanat/dreamcli 3.0.0-rc.9 → 3.0.1
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.
- package/CHANGELOG.md +262 -1
- package/README.md +32 -13
- package/dist/core/cli/dispatch.mjs +0 -11
- package/dist/core/cli/index.d.mts +133 -9
- package/dist/core/cli/index.mjs +108 -21
- package/dist/core/cli/planner.mjs +7 -1
- package/dist/core/cli/root-help.mjs +5 -0
- package/dist/core/cli/runtime-preflight.d.mts +4 -0
- package/dist/core/cli/runtime-preflight.mjs +5 -3
- package/dist/core/completion/shells/shared.mjs +1 -0
- package/dist/core/config/index.d.mts +43 -12
- package/dist/core/config/index.mjs +55 -16
- package/dist/core/config/package-json.d.mts +1 -0
- package/dist/core/errors/index.d.mts +2 -2
- package/dist/core/execution/index.mjs +6 -2
- package/dist/core/help/ansi.d.mts +11 -5
- package/dist/core/help/ansi.mjs +14 -16
- package/dist/core/help/index.d.mts +22 -0
- package/dist/core/help/index.mjs +75 -25
- package/dist/core/json-schema/index.d.mts +7 -8
- package/dist/core/json-schema/index.mjs +271 -88
- package/dist/core/json-schema/meta-descriptions.generated.d.mts +40 -40
- package/dist/core/output/contracts.d.mts +5 -5
- package/dist/core/output/contracts.mjs +1 -1
- package/dist/core/output/index.d.mts +38 -1
- package/dist/core/output/index.mjs +37 -2
- package/dist/core/parse/index.mjs +9 -6
- package/dist/core/resolve/contracts.d.mts +7 -2
- package/dist/core/resolve/flags.d.mts +3 -1
- package/dist/core/resolve/flags.mjs +29 -12
- package/dist/core/resolve/index.mjs +6 -1
- package/dist/core/resolve/property.d.mts +1 -1
- package/dist/core/resolve/standard.d.mts +24 -0
- package/dist/core/resolve/standard.mjs +114 -0
- package/dist/core/schema/arg.d.mts +37 -2
- package/dist/core/schema/arg.mjs +5 -2
- package/dist/core/schema/command.d.mts +49 -7
- package/dist/core/schema/command.mjs +15 -5
- package/dist/core/schema/flag.d.mts +77 -9
- package/dist/core/schema/flag.mjs +7 -3
- package/dist/core/schema/index.d.mts +3 -2
- package/dist/core/schema/prompt.d.mts +1 -1
- package/dist/core/schema/run.d.mts +7 -0
- package/dist/core/schema/standard.d.mts +100 -0
- package/dist/core/schema/standard.mjs +15 -0
- package/dist/core/testkit/index.d.mts +7 -5
- package/dist/core/testkit/index.mjs +12 -7
- package/dist/index.d.mts +5 -4
- package/dist/index.mjs +4 -4
- package/dist/runtime/adapter.d.mts +33 -0
- package/dist/runtime/adapter.mjs +6 -1
- package/dist/runtime/deno.d.mts +4 -0
- package/dist/runtime/deno.mjs +4 -1
- package/dist/runtime/node.mjs +9 -1
- package/dist/version.mjs +2 -2
- package/dreamcli.schema.json +82 -0
- package/examples/basic.ts +2 -2
- package/examples/flag-types.ts +79 -0
- package/examples/gh/node_modules/typescript/LICENSE +55 -0
- package/examples/gh/node_modules/typescript/NOTICE.txt +436 -0
- package/examples/gh/node_modules/typescript/README.md +49 -0
- package/examples/gh/node_modules/typescript/bin/tsc +2 -0
- package/examples/gh/node_modules/typescript/dist/api/async/api.d.ts +529 -0
- package/examples/gh/node_modules/typescript/dist/api/async/api.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/async/api.js +1657 -0
- package/examples/gh/node_modules/typescript/dist/api/async/api.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/async/client.d.ts +39 -0
- package/examples/gh/node_modules/typescript/dist/api/async/client.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/async/client.js +211 -0
- package/examples/gh/node_modules/typescript/dist/api/async/client.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/async/types.d.ts +310 -0
- package/examples/gh/node_modules/typescript/dist/api/async/types.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/async/types.js +2 -0
- package/examples/gh/node_modules/typescript/dist/api/async/types.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/compilerOptions.d.ts +109 -0
- package/examples/gh/node_modules/typescript/dist/api/compilerOptions.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/compilerOptions.js +2 -0
- package/examples/gh/node_modules/typescript/dist/api/compilerOptions.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/fs.d.ts +23 -0
- package/examples/gh/node_modules/typescript/dist/api/fs.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/fs.js +109 -0
- package/examples/gh/node_modules/typescript/dist/api/fs.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.d.ts +15 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.generated.d.ts +5 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.generated.js +74 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.js +287 -0
- package/examples/gh/node_modules/typescript/dist/api/node/encoder.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/msgpack.d.ts +32 -0
- package/examples/gh/node_modules/typescript/dist/api/node/msgpack.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/msgpack.js +213 -0
- package/examples/gh/node_modules/typescript/dist/api/node/msgpack.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.d.ts +76 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.generated.d.ts +182 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.generated.js +835 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.infrastructure.d.ts +62 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.infrastructure.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.infrastructure.js +122 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.infrastructure.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.js +298 -0
- package/examples/gh/node_modules/typescript/dist/api/node/node.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.d.ts +29 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.generated.d.ts +4 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.generated.js +241 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.js +30 -0
- package/examples/gh/node_modules/typescript/dist/api/node/protocol.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/wtf8.d.ts +6 -0
- package/examples/gh/node_modules/typescript/dist/api/node/wtf8.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/node/wtf8.js +61 -0
- package/examples/gh/node_modules/typescript/dist/api/node/wtf8.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/options.d.ts +32 -0
- package/examples/gh/node_modules/typescript/dist/api/options.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/options.js +11 -0
- package/examples/gh/node_modules/typescript/dist/api/options.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/path.d.ts +110 -0
- package/examples/gh/node_modules/typescript/dist/api/path.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/path.js +508 -0
- package/examples/gh/node_modules/typescript/dist/api/path.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/proto.d.ts +239 -0
- package/examples/gh/node_modules/typescript/dist/api/proto.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/proto.js +37 -0
- package/examples/gh/node_modules/typescript/dist/api/proto.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sourceFileCache.d.ts +79 -0
- package/examples/gh/node_modules/typescript/dist/api/sourceFileCache.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sourceFileCache.js +169 -0
- package/examples/gh/node_modules/typescript/dist/api/sourceFileCache.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/api.d.ts +529 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/api.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/api.js +1665 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/api.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/client.d.ts +30 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/client.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/client.js +124 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/client.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/types.d.ts +310 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/types.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/types.js +2 -0
- package/examples/gh/node_modules/typescript/dist/api/sync/types.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/syncChannel.d.ts +114 -0
- package/examples/gh/node_modules/typescript/dist/api/syncChannel.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/syncChannel.js +508 -0
- package/examples/gh/node_modules/typescript/dist/api/syncChannel.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/timing.d.ts +175 -0
- package/examples/gh/node_modules/typescript/dist/api/timing.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/api/timing.js +149 -0
- package/examples/gh/node_modules/typescript/dist/api/timing.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.d.ts +100 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.generated.d.ts +1161 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.generated.js +4 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.js +7 -0
- package/examples/gh/node_modules/typescript/dist/ast/ast.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/astnav.d.ts +19 -0
- package/examples/gh/node_modules/typescript/dist/ast/astnav.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/astnav.js +596 -0
- package/examples/gh/node_modules/typescript/dist/ast/astnav.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/clone.d.ts +16 -0
- package/examples/gh/node_modules/typescript/dist/ast/clone.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/clone.js +104 -0
- package/examples/gh/node_modules/typescript/dist/ast/clone.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/factory.generated.d.ts +520 -0
- package/examples/gh/node_modules/typescript/dist/ast/factory.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/factory.generated.js +3057 -0
- package/examples/gh/node_modules/typescript/dist/ast/factory.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/index.d.ts +20 -0
- package/examples/gh/node_modules/typescript/dist/ast/index.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/index.js +20 -0
- package/examples/gh/node_modules/typescript/dist/ast/index.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.d.ts +35 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.generated.d.ts +329 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.generated.js +1103 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.js +233 -0
- package/examples/gh/node_modules/typescript/dist/ast/is.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/jsdoc.d.ts +11 -0
- package/examples/gh/node_modules/typescript/dist/ast/jsdoc.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/jsdoc.js +202 -0
- package/examples/gh/node_modules/typescript/dist/ast/jsdoc.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/scanner.d.ts +97 -0
- package/examples/gh/node_modules/typescript/dist/ast/scanner.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/scanner.js +2230 -0
- package/examples/gh/node_modules/typescript/dist/ast/scanner.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/utils.d.ts +17 -0
- package/examples/gh/node_modules/typescript/dist/ast/utils.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/utils.js +67 -0
- package/examples/gh/node_modules/typescript/dist/ast/utils.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.d.ts +14 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.generated.d.ts +50 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.generated.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.generated.js +978 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.generated.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.js +47 -0
- package/examples/gh/node_modules/typescript/dist/ast/visitor.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.enum.d.ts +129 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.enum.js +132 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.js +130 -0
- package/examples/gh/node_modules/typescript/dist/enums/characterCodes.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.enum.d.ts +5 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.enum.js +6 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.js +6 -0
- package/examples/gh/node_modules/typescript/dist/enums/commentDirectiveType.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.enum.d.ts +28 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.enum.js +30 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.js +30 -0
- package/examples/gh/node_modules/typescript/dist/enums/completionItemKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.enum.d.ts +7 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.enum.js +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.js +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/diagnosticCategory.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.enum.d.ts +12 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.enum.js +14 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.js +14 -0
- package/examples/gh/node_modules/typescript/dist/enums/elementFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.enum.d.ts +23 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.enum.js +25 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.js +25 -0
- package/examples/gh/node_modules/typescript/dist/enums/internalSymbolName.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.enum.d.ts +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.enum.js +11 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.js +11 -0
- package/examples/gh/node_modules/typescript/dist/enums/jsxEmit.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.enum.d.ts +5 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.enum.js +6 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.js +6 -0
- package/examples/gh/node_modules/typescript/dist/enums/languageVariant.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.enum.d.ts +42 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.enum.js +44 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.js +44 -0
- package/examples/gh/node_modules/typescript/dist/enums/modifierFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.enum.d.ts +7 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.enum.js +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.js +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleDetectionKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.enum.d.ts +17 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.enum.js +19 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.js +19 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.enum.d.ts +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.enum.js +11 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.js +11 -0
- package/examples/gh/node_modules/typescript/dist/enums/moduleResolutionKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.enum.d.ts +6 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.enum.js +8 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.js +8 -0
- package/examples/gh/node_modules/typescript/dist/enums/newLineKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.enum.d.ts +36 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.enum.js +38 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.js +38 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeBuilderFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.enum.d.ts +44 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.enum.js +46 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.js +46 -0
- package/examples/gh/node_modules/typescript/dist/enums/nodeFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.enum.d.ts +50 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.enum.js +52 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.js +52 -0
- package/examples/gh/node_modules/typescript/dist/enums/objectFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.enum.d.ts +16 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.enum.js +18 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.js +18 -0
- package/examples/gh/node_modules/typescript/dist/enums/outerExpressionKinds.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.enum.d.ts +13 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.enum.js +14 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.js +14 -0
- package/examples/gh/node_modules/typescript/dist/enums/regularExpressionFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.enum.d.ts +11 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.enum.js +12 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.js +12 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.enum.d.ts +17 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.enum.js +18 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.js +18 -0
- package/examples/gh/node_modules/typescript/dist/enums/scriptTarget.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.enum.d.ts +15 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.enum.js +17 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.js +17 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.enum.d.ts +5 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.enum.js +7 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.js +7 -0
- package/examples/gh/node_modules/typescript/dist/enums/signatureKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.enum.d.ts +71 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.enum.js +73 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.js +73 -0
- package/examples/gh/node_modules/typescript/dist/enums/symbolFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.enum.d.ts +389 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.enum.js +391 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.js +391 -0
- package/examples/gh/node_modules/typescript/dist/enums/syntaxKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.enum.d.ts +30 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.enum.js +32 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.js +32 -0
- package/examples/gh/node_modules/typescript/dist/enums/tokenFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.enum.d.ts +76 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.enum.js +78 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.js +78 -0
- package/examples/gh/node_modules/typescript/dist/enums/typeFlags.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.d.ts +2 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.enum.d.ts +7 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.enum.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.enum.js +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.enum.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.js +9 -0
- package/examples/gh/node_modules/typescript/dist/enums/typePredicateKind.js.map +1 -0
- package/examples/gh/node_modules/typescript/dist/internal/utils.d.ts +23 -0
- package/examples/gh/node_modules/typescript/dist/internal/utils.d.ts.map +1 -0
- package/examples/gh/node_modules/typescript/dist/internal/utils.js +25 -0
- package/examples/gh/node_modules/typescript/dist/internal/utils.js.map +1 -0
- package/examples/gh/node_modules/typescript/lib/getExePath.d.ts +2 -0
- package/examples/gh/node_modules/typescript/lib/getExePath.js +70 -0
- package/examples/gh/node_modules/typescript/lib/tsc.js +28 -0
- package/examples/gh/node_modules/typescript/lib/version.cjs +3 -0
- package/examples/gh/node_modules/typescript/lib/version.d.cts +2 -0
- package/examples/gh/node_modules/typescript/package.json +87 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/License.txt +11 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/README.md +54 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/browser/main.d.ts +17 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/browser/main.js +83 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/browser/ril.d.ts +22 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/browser/ril.js +210 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/api.d.ts +14 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/api.js +87 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/cancellation.d.ts +32 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/cancellation.js +132 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/connection.d.ts +367 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/connection.js +1271 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/disposable.d.ts +9 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/disposable.js +16 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/encoding.d.ts +52 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/encoding.js +70 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/events.d.ts +39 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/events.js +135 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/is.d.ts +7 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/is.js +34 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/linkedMap.d.ts +55 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/linkedMap.js +412 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messageBuffer.d.ts +18 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messageBuffer.js +155 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messageReader.d.ts +77 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messageReader.js +246 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messageWriter.d.ts +60 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messageWriter.js +157 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messages.d.ts +369 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/messages.js +436 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/ral.d.ts +74 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/ral.js +23 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/semaphore.d.ts +10 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/semaphore.js +74 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/sharedArrayCancellation.d.ts +15 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/common/sharedArrayCancellation.js +77 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/node/main.d.ts +58 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/node/main.js +289 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/node/ril.d.ts +12 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/lib/node/ril.js +163 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/package.json +54 -0
- package/examples/gh/node_modules/typescript/vendor/vscode-jsonrpc/typings/thenable.d.ts +5 -0
- package/examples/gh/package.json +11 -5
- package/examples/gh/src/main.ts +10 -4
- package/examples/help-config.ts +43 -0
- package/examples/json-mode.ts +8 -4
- package/examples/middleware.ts +1 -1
- package/examples/output-extras.ts +46 -0
- package/examples/parser-control.ts +40 -0
- package/examples/pwsh-demo/package.json +1 -1
- package/examples/pwsh-demo/src/main.ts +1 -1
- package/examples/standard-schema.ts +45 -0
- package/examples/transport-launcher.ts +10 -10
- package/package.json +26 -31
- package/skills/cli-creation/SKILL.md +140 -0
- package/skills/cli-creation/agents/openai.yaml +4 -0
- package/skills/cli-creation/assets/templates/multi-command.bun-test.ts.tpl +20 -0
- package/skills/cli-creation/assets/templates/multi-command.test.ts.tpl +20 -0
- package/skills/cli-creation/assets/templates/multi-command.ts.tpl +89 -0
- package/skills/cli-creation/assets/templates/single-command.bun-test.ts.tpl +29 -0
- package/skills/cli-creation/assets/templates/single-command.test.ts.tpl +29 -0
- package/skills/cli-creation/assets/templates/single-command.ts.tpl +47 -0
- package/skills/cli-creation/references/consumer-workflow.md +65 -0
- package/skills/cli-creation/references/pattern-cookbook.md +293 -0
- package/skills/cli-creation/references/runtime-notes.md +29 -0
- package/skills/cli-creation/scripts/scaffold_cli.py +360 -0
- package/dist/core/schema-dsl/runtime.d.mts +0 -144
- package/dist/core/schema-dsl/runtime.mjs +0 -271
- package/dist/core/schema-dsl/to-json-schema.d.mts +0 -29
- package/dist/core/schema-dsl/to-json-schema.mjs +0 -74
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { getFlagAliasNames } from "../schema/flag.mjs";
|
|
2
|
-
import {
|
|
3
|
-
import { nodeToJsonSchema } from "../schema-dsl/to-json-schema.mjs";
|
|
2
|
+
import { resolveExampleCommand } from "../schema/command.mjs";
|
|
4
3
|
import { definitionMetaSchemaDescriptions } from "./meta-descriptions.generated.mjs";
|
|
5
4
|
//#region src/core/json-schema/index.ts
|
|
6
5
|
/**
|
|
@@ -38,6 +37,8 @@ function isRecord(value) {
|
|
|
38
37
|
*
|
|
39
38
|
* @param schema - The CLI schema from `CLIBuilder.schema`.
|
|
40
39
|
* @param options - Generation options.
|
|
40
|
+
* @param meta - Program name/version for function-form examples; defaults to
|
|
41
|
+
* the CLI schema's own `name`/`version`.
|
|
41
42
|
* @returns A plain object suitable for `JSON.stringify()`.
|
|
42
43
|
*
|
|
43
44
|
* @example
|
|
@@ -47,16 +48,20 @@ function isRecord(value) {
|
|
|
47
48
|
* writeFileSync('cli-schema.json', JSON.stringify(definition, null, 2));
|
|
48
49
|
* ```
|
|
49
50
|
*/
|
|
50
|
-
function generateSchema(schema, options) {
|
|
51
|
+
function generateSchema(schema, options, meta) {
|
|
51
52
|
const opts = resolveOptions(options);
|
|
53
|
+
const resolvedMeta = meta ?? {
|
|
54
|
+
name: schema.name,
|
|
55
|
+
version: schema.version
|
|
56
|
+
};
|
|
52
57
|
const result = {
|
|
53
58
|
$schema: DEFINITION_SCHEMA_URL,
|
|
54
59
|
name: schema.name
|
|
55
60
|
};
|
|
56
61
|
if (schema.version !== void 0) result.version = schema.version;
|
|
57
62
|
if (schema.description !== void 0) result.description = schema.description;
|
|
58
|
-
if (schema.defaultCommand !== void 0 && (opts.includeHidden || !schema.defaultCommand.schema.hidden)) result.defaultCommand = serializeCommand(schema.defaultCommand.schema, opts);
|
|
59
|
-
result.commands = schema.commands.filter((cmd) => opts.includeHidden || !cmd.schema.hidden).map((cmd) => serializeCommand(cmd.schema, opts));
|
|
63
|
+
if (schema.defaultCommand !== void 0 && (opts.includeHidden || !schema.defaultCommand.schema.hidden)) result.defaultCommand = serializeCommand(schema.defaultCommand.schema, opts, resolvedMeta);
|
|
64
|
+
result.commands = schema.commands.filter((cmd) => opts.includeHidden || !cmd.schema.hidden).map((cmd) => serializeCommand(cmd.schema, opts, resolvedMeta));
|
|
60
65
|
return result;
|
|
61
66
|
}
|
|
62
67
|
/**
|
|
@@ -69,10 +74,16 @@ function generateSchema(schema, options) {
|
|
|
69
74
|
*
|
|
70
75
|
* @param schema - The command schema to serialize.
|
|
71
76
|
* @param options - Generation options.
|
|
77
|
+
* @param meta - Program name/version for function-form examples; defaults to
|
|
78
|
+
* the command's own name with no version.
|
|
72
79
|
* @returns A plain object suitable for `JSON.stringify()`.
|
|
73
80
|
*/
|
|
74
|
-
function generateCommandSchema(schema, options) {
|
|
75
|
-
|
|
81
|
+
function generateCommandSchema(schema, options, meta) {
|
|
82
|
+
const resolvedMeta = meta ?? {
|
|
83
|
+
name: schema.name,
|
|
84
|
+
version: void 0
|
|
85
|
+
};
|
|
86
|
+
return serializeCommand(schema, resolveOptions(options), resolvedMeta);
|
|
76
87
|
}
|
|
77
88
|
/**
|
|
78
89
|
* Serialize a single {@link CommandSchema} into a plain object.
|
|
@@ -81,17 +92,17 @@ function generateCommandSchema(schema, options) {
|
|
|
81
92
|
* @param opts - Resolved generation options (hidden/prompt inclusion).
|
|
82
93
|
* @returns JSON-serializable object representing the command.
|
|
83
94
|
*/
|
|
84
|
-
function serializeCommand(schema, opts) {
|
|
95
|
+
function serializeCommand(schema, opts, meta) {
|
|
85
96
|
const result = { name: schema.name };
|
|
86
97
|
if (schema.description !== void 0) result.description = schema.description;
|
|
87
98
|
if (schema.aliases.length > 0) result.aliases = [...schema.aliases];
|
|
88
99
|
if (schema.hidden) result.hidden = true;
|
|
89
|
-
if (schema.examples.length > 0) result.examples = schema.examples.map(serializeExample);
|
|
100
|
+
if (schema.examples.length > 0) result.examples = schema.examples.map((example) => serializeExample(example, meta));
|
|
90
101
|
const flags = {};
|
|
91
102
|
for (const [name, flagDef] of Object.entries(schema.flags)) flags[name] = serializeFlag(flagDef, opts);
|
|
92
103
|
result.flags = flags;
|
|
93
104
|
result.args = schema.args.map(serializeArgEntry);
|
|
94
|
-
result.commands = schema.commands.filter((cmd) => opts.includeHidden || !cmd.hidden).map((cmd) => serializeCommand(cmd, opts));
|
|
105
|
+
result.commands = schema.commands.filter((cmd) => opts.includeHidden || !cmd.hidden).map((cmd) => serializeCommand(cmd, opts, meta));
|
|
95
106
|
return result;
|
|
96
107
|
}
|
|
97
108
|
/**
|
|
@@ -113,7 +124,23 @@ function serializeFlag(schema, opts) {
|
|
|
113
124
|
if (schema.configPath !== void 0) result.configPath = schema.configPath;
|
|
114
125
|
if (schema.description !== void 0) result.description = schema.description;
|
|
115
126
|
if (schema.enumValues !== void 0) result.enumValues = [...schema.enumValues];
|
|
127
|
+
if (schema.numberConstraints !== void 0) result.numberConstraints = { ...schema.numberConstraints };
|
|
128
|
+
if (schema.stringConstraints !== void 0) result.stringConstraints = {
|
|
129
|
+
...schema.stringConstraints,
|
|
130
|
+
...schema.stringConstraints.pattern !== void 0 ? { pattern: {
|
|
131
|
+
source: schema.stringConstraints.pattern.source,
|
|
132
|
+
flags: schema.stringConstraints.pattern.flags
|
|
133
|
+
} } : {}
|
|
134
|
+
};
|
|
116
135
|
if (schema.elementSchema !== void 0) result.elementSchema = serializeFlag(schema.elementSchema, opts);
|
|
136
|
+
if (schema.separator !== void 0) result.separator = schema.separator;
|
|
137
|
+
if (schema.unique) result.unique = true;
|
|
138
|
+
if (schema.pathChecks !== void 0) result.pathChecks = {
|
|
139
|
+
mustExist: schema.pathChecks.mustExist,
|
|
140
|
+
...schema.pathChecks.type !== void 0 ? { type: schema.pathChecks.type } : {},
|
|
141
|
+
...schema.pathChecks.create ? { create: true } : {}
|
|
142
|
+
};
|
|
143
|
+
if (schema.valueHint !== void 0) result.valueHint = schema.valueHint;
|
|
117
144
|
if (opts.includePrompts && schema.prompt !== void 0) result.prompt = serializePrompt(schema.prompt);
|
|
118
145
|
if (schema.deprecated !== void 0) result.deprecated = schema.deprecated;
|
|
119
146
|
if (schema.propagate) result.propagate = true;
|
|
@@ -190,11 +217,15 @@ function serializeChoice(choice) {
|
|
|
190
217
|
/**
|
|
191
218
|
* Serialize a {@link CommandExample} into a plain object.
|
|
192
219
|
*
|
|
220
|
+
* Function-form commands are resolved against `meta` so the output is a plain
|
|
221
|
+
* serializable string rather than a dropped function.
|
|
222
|
+
*
|
|
193
223
|
* @param example - The example to serialize.
|
|
224
|
+
* @param meta - Program name/version passed to function-form commands.
|
|
194
225
|
* @returns JSON-serializable object with command and optional description.
|
|
195
226
|
*/
|
|
196
|
-
function serializeExample(example) {
|
|
197
|
-
const result = { command: example.command };
|
|
227
|
+
function serializeExample(example, meta) {
|
|
228
|
+
const result = { command: resolveExampleCommand(example.command, meta) };
|
|
198
229
|
if (example.description !== void 0) result.description = example.description;
|
|
199
230
|
return result;
|
|
200
231
|
}
|
|
@@ -448,10 +479,6 @@ function isPlainJsonObject(value) {
|
|
|
448
479
|
const proto = Object.getPrototypeOf(value);
|
|
449
480
|
return proto === Object.prototype || proto === null;
|
|
450
481
|
}
|
|
451
|
-
/** Convert a DSL string to a JSON Schema object definition. */
|
|
452
|
-
function def(source) {
|
|
453
|
-
return nodeToJsonSchema(parseSchema(source));
|
|
454
|
-
}
|
|
455
482
|
function withDefinitionDescriptions(schema, descriptions) {
|
|
456
483
|
const propertiesValue = schema.properties;
|
|
457
484
|
const describedProperties = typeof propertiesValue === "object" && propertiesValue !== null && isPlainJsonObject(propertiesValue) && descriptions.properties !== void 0 ? Object.fromEntries(Object.entries(propertiesValue).map(([name, propertySchema]) => {
|
|
@@ -481,11 +508,6 @@ function withDefinitionMetaSchemaDescriptions(schema, descriptions) {
|
|
|
481
508
|
/**
|
|
482
509
|
* JSON Schema (draft 2020-12) that validates the output of {@link generateSchema}.
|
|
483
510
|
*
|
|
484
|
-
* Each `$defs` entry is defined once as a schema DSL string — the DSL
|
|
485
|
-
* parser produces a runtime AST, and {@link nodeToJsonSchema} converts
|
|
486
|
-
* that AST to a JSON Schema fragment. No probe fixtures, no override
|
|
487
|
-
* maps, no manually maintained type definitions.
|
|
488
|
-
*
|
|
489
511
|
* Hosted at {@link DEFINITION_SCHEMA_URL} for `$schema` resolution. Also
|
|
490
512
|
* exported so tooling can validate definition documents without a network
|
|
491
513
|
* round-trip.
|
|
@@ -505,74 +527,235 @@ const definitionMetaSchema = withDefinitionMetaSchemaDescriptions({
|
|
|
505
527
|
$id: DEFINITION_SCHEMA_URL,
|
|
506
528
|
title: "@kjanat/dreamcli definition schema",
|
|
507
529
|
description: "Describes the structure of a CLI built with dreamcli — commands, flags, args, types, constraints, env bindings, and prompts.",
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
530
|
+
type: "object",
|
|
531
|
+
additionalProperties: false,
|
|
532
|
+
properties: {
|
|
533
|
+
$schema: { const: DEFINITION_SCHEMA_URL },
|
|
534
|
+
name: { type: "string" },
|
|
535
|
+
version: { type: "string" },
|
|
536
|
+
description: { type: "string" },
|
|
537
|
+
defaultCommand: { $ref: "#/$defs/command" },
|
|
538
|
+
commands: {
|
|
539
|
+
type: "array",
|
|
540
|
+
items: { $ref: "#/$defs/command" }
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
required: [
|
|
544
|
+
"$schema",
|
|
545
|
+
"name",
|
|
546
|
+
"commands"
|
|
547
|
+
],
|
|
516
548
|
$defs: {
|
|
517
|
-
command:
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
549
|
+
command: {
|
|
550
|
+
type: "object",
|
|
551
|
+
additionalProperties: false,
|
|
552
|
+
properties: {
|
|
553
|
+
name: { type: "string" },
|
|
554
|
+
description: { type: "string" },
|
|
555
|
+
aliases: {
|
|
556
|
+
type: "array",
|
|
557
|
+
items: { type: "string" }
|
|
558
|
+
},
|
|
559
|
+
hidden: { const: true },
|
|
560
|
+
examples: {
|
|
561
|
+
type: "array",
|
|
562
|
+
items: { $ref: "#/$defs/example" }
|
|
563
|
+
},
|
|
564
|
+
flags: {
|
|
565
|
+
type: "object",
|
|
566
|
+
additionalProperties: { $ref: "#/$defs/flag" }
|
|
567
|
+
},
|
|
568
|
+
args: {
|
|
569
|
+
type: "array",
|
|
570
|
+
items: { $ref: "#/$defs/arg" }
|
|
571
|
+
},
|
|
572
|
+
commands: {
|
|
573
|
+
type: "array",
|
|
574
|
+
items: { $ref: "#/$defs/command" }
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
required: [
|
|
578
|
+
"name",
|
|
579
|
+
"flags",
|
|
580
|
+
"args",
|
|
581
|
+
"commands"
|
|
582
|
+
]
|
|
583
|
+
},
|
|
584
|
+
flag: {
|
|
585
|
+
type: "object",
|
|
586
|
+
additionalProperties: false,
|
|
587
|
+
properties: {
|
|
588
|
+
kind: { enum: [
|
|
589
|
+
"string",
|
|
590
|
+
"number",
|
|
591
|
+
"boolean",
|
|
592
|
+
"enum",
|
|
593
|
+
"array",
|
|
594
|
+
"custom",
|
|
595
|
+
"count",
|
|
596
|
+
"keyValue"
|
|
597
|
+
] },
|
|
598
|
+
presence: { enum: [
|
|
599
|
+
"optional",
|
|
600
|
+
"required",
|
|
601
|
+
"defaulted"
|
|
602
|
+
] },
|
|
603
|
+
defaultValue: {},
|
|
604
|
+
aliases: {
|
|
605
|
+
type: "array",
|
|
606
|
+
items: { type: "string" }
|
|
607
|
+
},
|
|
608
|
+
envVar: { type: "string" },
|
|
609
|
+
configPath: { type: "string" },
|
|
610
|
+
description: { type: "string" },
|
|
611
|
+
enumValues: {
|
|
612
|
+
type: "array",
|
|
613
|
+
items: { type: "string" }
|
|
614
|
+
},
|
|
615
|
+
numberConstraints: {
|
|
616
|
+
type: "object",
|
|
617
|
+
additionalProperties: false,
|
|
618
|
+
properties: {
|
|
619
|
+
min: { type: "number" },
|
|
620
|
+
max: { type: "number" },
|
|
621
|
+
int: { type: "boolean" },
|
|
622
|
+
finite: { type: "boolean" }
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
stringConstraints: {
|
|
626
|
+
type: "object",
|
|
627
|
+
additionalProperties: false,
|
|
628
|
+
properties: {
|
|
629
|
+
nonEmpty: { type: "boolean" },
|
|
630
|
+
minLength: {
|
|
631
|
+
type: "integer",
|
|
632
|
+
minimum: 0
|
|
633
|
+
},
|
|
634
|
+
maxLength: {
|
|
635
|
+
type: "integer",
|
|
636
|
+
minimum: 0
|
|
637
|
+
},
|
|
638
|
+
pattern: {
|
|
639
|
+
type: "object",
|
|
640
|
+
additionalProperties: false,
|
|
641
|
+
properties: {
|
|
642
|
+
source: { type: "string" },
|
|
643
|
+
flags: { type: "string" }
|
|
644
|
+
},
|
|
645
|
+
required: ["source", "flags"]
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
},
|
|
649
|
+
elementSchema: { $ref: "#/$defs/flag" },
|
|
650
|
+
separator: {
|
|
651
|
+
type: "string",
|
|
652
|
+
minLength: 1
|
|
653
|
+
},
|
|
654
|
+
unique: { type: "boolean" },
|
|
655
|
+
pathChecks: {
|
|
656
|
+
type: "object",
|
|
657
|
+
additionalProperties: false,
|
|
658
|
+
properties: {
|
|
659
|
+
mustExist: { type: "boolean" },
|
|
660
|
+
type: { enum: ["file", "directory"] },
|
|
661
|
+
create: { type: "boolean" }
|
|
662
|
+
},
|
|
663
|
+
required: ["mustExist"]
|
|
664
|
+
},
|
|
665
|
+
valueHint: { type: "string" },
|
|
666
|
+
prompt: { $ref: "#/$defs/prompt" },
|
|
667
|
+
deprecated: { oneOf: [{ type: "string" }, { const: true }] },
|
|
668
|
+
propagate: { const: true },
|
|
669
|
+
negation: { $ref: "#/$defs/negation" },
|
|
670
|
+
duplicates: { enum: [
|
|
671
|
+
"last",
|
|
672
|
+
"first",
|
|
673
|
+
"error"
|
|
674
|
+
] }
|
|
675
|
+
},
|
|
676
|
+
required: ["kind", "presence"]
|
|
677
|
+
},
|
|
678
|
+
negation: {
|
|
679
|
+
type: "object",
|
|
680
|
+
additionalProperties: false,
|
|
681
|
+
properties: {
|
|
682
|
+
alias: { type: "string" },
|
|
683
|
+
hidden: { const: true }
|
|
684
|
+
}
|
|
685
|
+
},
|
|
686
|
+
arg: {
|
|
687
|
+
type: "object",
|
|
688
|
+
additionalProperties: false,
|
|
689
|
+
properties: {
|
|
690
|
+
name: { type: "string" },
|
|
691
|
+
kind: { enum: [
|
|
692
|
+
"string",
|
|
693
|
+
"number",
|
|
694
|
+
"enum",
|
|
695
|
+
"custom"
|
|
696
|
+
] },
|
|
697
|
+
presence: { enum: [
|
|
698
|
+
"required",
|
|
699
|
+
"optional",
|
|
700
|
+
"defaulted"
|
|
701
|
+
] },
|
|
702
|
+
variadic: { const: true },
|
|
703
|
+
stdinMode: { const: true },
|
|
704
|
+
defaultValue: {},
|
|
705
|
+
description: { type: "string" },
|
|
706
|
+
envVar: { type: "string" },
|
|
707
|
+
enumValues: {
|
|
708
|
+
type: "array",
|
|
709
|
+
items: { type: "string" }
|
|
710
|
+
},
|
|
711
|
+
deprecated: { oneOf: [{ type: "string" }, { const: true }] }
|
|
712
|
+
},
|
|
713
|
+
required: [
|
|
714
|
+
"name",
|
|
715
|
+
"kind",
|
|
716
|
+
"presence"
|
|
717
|
+
]
|
|
718
|
+
},
|
|
719
|
+
prompt: {
|
|
720
|
+
type: "object",
|
|
721
|
+
additionalProperties: false,
|
|
722
|
+
properties: {
|
|
723
|
+
kind: { enum: [
|
|
724
|
+
"confirm",
|
|
725
|
+
"input",
|
|
726
|
+
"select",
|
|
727
|
+
"multiselect"
|
|
728
|
+
] },
|
|
729
|
+
message: { type: "string" },
|
|
730
|
+
placeholder: { type: "string" },
|
|
731
|
+
choices: {
|
|
732
|
+
type: "array",
|
|
733
|
+
items: { $ref: "#/$defs/choice" }
|
|
734
|
+
},
|
|
735
|
+
min: { type: "integer" },
|
|
736
|
+
max: { type: "integer" }
|
|
737
|
+
},
|
|
738
|
+
required: ["kind", "message"]
|
|
739
|
+
},
|
|
740
|
+
choice: {
|
|
741
|
+
type: "object",
|
|
742
|
+
additionalProperties: false,
|
|
743
|
+
properties: {
|
|
744
|
+
value: { type: "string" },
|
|
745
|
+
label: { type: "string" },
|
|
746
|
+
description: { type: "string" }
|
|
747
|
+
},
|
|
748
|
+
required: ["value"]
|
|
749
|
+
},
|
|
750
|
+
example: {
|
|
751
|
+
type: "object",
|
|
752
|
+
additionalProperties: false,
|
|
753
|
+
properties: {
|
|
754
|
+
command: { type: "string" },
|
|
755
|
+
description: { type: "string" }
|
|
756
|
+
},
|
|
757
|
+
required: ["command"]
|
|
758
|
+
}
|
|
576
759
|
}
|
|
577
760
|
}, definitionMetaSchemaDescriptions);
|
|
578
761
|
//#endregion
|
|
@@ -6,22 +6,22 @@
|
|
|
6
6
|
*/
|
|
7
7
|
declare const definitionMetaSchemaDescriptions: {
|
|
8
8
|
readonly root: {
|
|
9
|
-
readonly description:
|
|
9
|
+
readonly description: "Runtime descriptor for the CLI program.\n\nStores the program name, version, description, and registered commands.\\\nBuilt incrementally by CLIBuilder.";
|
|
10
10
|
readonly properties: {
|
|
11
11
|
readonly name: {
|
|
12
|
-
readonly description:
|
|
12
|
+
readonly description: "Program name (used in help text, usage lines, and completion scripts).";
|
|
13
13
|
};
|
|
14
14
|
readonly version: {
|
|
15
|
-
readonly description:
|
|
15
|
+
readonly description: "Program version (shown by `--version`).";
|
|
16
16
|
};
|
|
17
17
|
readonly description: {
|
|
18
|
-
readonly description:
|
|
18
|
+
readonly description: "Program description (shown in root help).";
|
|
19
19
|
};
|
|
20
20
|
readonly defaultCommand: {
|
|
21
|
-
readonly description:
|
|
21
|
+
readonly description: "Default command dispatched when no subcommand matches.\n\nWhen set, the CLI root behaves like a hybrid command group: subcommands\ndispatch by name as usual, but empty argv or flags-only argv falls\nthrough to this command instead of showing root help.\n\nSet via the .default() builder method.";
|
|
22
22
|
};
|
|
23
23
|
readonly commands: {
|
|
24
|
-
readonly description:
|
|
24
|
+
readonly description: "Registered commands (type-erased for heterogeneous storage).";
|
|
25
25
|
};
|
|
26
26
|
};
|
|
27
27
|
};
|
|
@@ -33,25 +33,25 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
33
33
|
readonly description: "The command name (used for dispatch, e.g. `'deploy'`).";
|
|
34
34
|
};
|
|
35
35
|
readonly description: {
|
|
36
|
-
readonly description:
|
|
36
|
+
readonly description: "Human-readable description for help text.";
|
|
37
37
|
};
|
|
38
38
|
readonly aliases: {
|
|
39
|
-
readonly description:
|
|
39
|
+
readonly description: "Alternative names for this command.";
|
|
40
40
|
};
|
|
41
41
|
readonly hidden: {
|
|
42
|
-
readonly description:
|
|
42
|
+
readonly description: "Whether this command is hidden from help listings.";
|
|
43
43
|
};
|
|
44
44
|
readonly examples: {
|
|
45
|
-
readonly description:
|
|
45
|
+
readonly description: "Usage examples for help text.";
|
|
46
46
|
};
|
|
47
47
|
readonly flags: {
|
|
48
|
-
readonly description:
|
|
48
|
+
readonly description: "Named flag schemas, keyed by flag name.";
|
|
49
49
|
};
|
|
50
50
|
readonly args: {
|
|
51
|
-
readonly description:
|
|
51
|
+
readonly description: "Ordered positional arg entries (name + schema).";
|
|
52
52
|
};
|
|
53
53
|
readonly commands: {
|
|
54
|
-
readonly description:
|
|
54
|
+
readonly description: "Nested subcommand schemas (for help rendering and completion).\n\nPure data — no execution closures. Populated by `.command()` on\n`CommandBuilder`. Empty for leaf commands.";
|
|
55
55
|
};
|
|
56
56
|
};
|
|
57
57
|
};
|
|
@@ -59,25 +59,25 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
59
59
|
readonly description: "The runtime descriptor stored inside every FlagBuilder. Consumers (parser,\nhelp generator, resolution chain) read this to understand the flag's shape\nwithout touching generics.";
|
|
60
60
|
readonly properties: {
|
|
61
61
|
readonly kind: {
|
|
62
|
-
readonly description:
|
|
62
|
+
readonly description: "What kind of value this flag accepts.";
|
|
63
63
|
};
|
|
64
64
|
readonly presence: {
|
|
65
65
|
readonly description: "Presence describes whether a flag value is guaranteed to exist when the\naction handler runs:\n\n- `'optional'` — not required; unresolved value follows the kind-specific\n optional fallback (`undefined` for most flags, `[]` for arrays)\n- `'required'` — must be supplied; error if missing\n- `'defaulted'` — always present (falls back to default value)";
|
|
66
66
|
};
|
|
67
67
|
readonly defaultValue: {
|
|
68
|
-
readonly description:
|
|
68
|
+
readonly description: "Runtime default value (if any).";
|
|
69
69
|
};
|
|
70
70
|
readonly aliases: {
|
|
71
71
|
readonly description: "Short/long aliases (e.g. `[{ name: 'f', hidden: false }]` for `--force`).";
|
|
72
72
|
};
|
|
73
73
|
readonly envVar: {
|
|
74
|
-
readonly description:
|
|
74
|
+
readonly description: "Environment variable name for v0.2+ resolution.";
|
|
75
75
|
};
|
|
76
76
|
readonly configPath: {
|
|
77
77
|
readonly description: "Dotted config path for v0.2+ resolution (e.g. `'deploy.region'`).";
|
|
78
78
|
};
|
|
79
79
|
readonly description: {
|
|
80
|
-
readonly description:
|
|
80
|
+
readonly description: "Human-readable description for help text.";
|
|
81
81
|
};
|
|
82
82
|
readonly enumValues: {
|
|
83
83
|
readonly description: "Allowed literal values when `kind === 'enum'`.";
|
|
@@ -86,13 +86,13 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
86
86
|
readonly description: "Element schema when `kind === 'array'`.";
|
|
87
87
|
};
|
|
88
88
|
readonly prompt: {
|
|
89
|
-
readonly description:
|
|
89
|
+
readonly description: "Interactive prompt configuration for v0.3+ resolution.";
|
|
90
90
|
};
|
|
91
91
|
readonly deprecated: {
|
|
92
|
-
readonly description:
|
|
92
|
+
readonly description: "Deprecation marker.\n\n- `undefined` — not deprecated (default)\n- `true` — deprecated with no migration message\n- `string` — deprecated with a reason/migration message\n\nWhen a deprecated flag is used, a warning is emitted to stderr.\nHelp text shows `[deprecated]` or `[deprecated: <reason>]`.";
|
|
93
93
|
};
|
|
94
94
|
readonly propagate: {
|
|
95
|
-
readonly description:
|
|
95
|
+
readonly description: "Whether this flag propagates to subcommands in nested command trees.\n\nWhen `true`, the flag is automatically available to all descendant\ncommands. A child command that defines a flag with the same name\nshadows the propagated parent flag.\n\nDefault: `false`";
|
|
96
96
|
};
|
|
97
97
|
readonly negation: {
|
|
98
98
|
readonly description: "Negation settings when `kind === 'boolean'` and `.negatable()` was\ncalled (`undefined` otherwise). See FlagNegation.";
|
|
@@ -103,13 +103,13 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
103
103
|
};
|
|
104
104
|
};
|
|
105
105
|
readonly negation: {
|
|
106
|
-
readonly description:
|
|
106
|
+
readonly description: "Negation settings for a boolean flag (set by `.negatable()`).\n\nThe negated spelling and the positive form are two spellings of ONE\nlogical flag: they share duplicate policy, and the last CLI occurrence\nwins across both. The negated spelling is presence-only — `--no-foo=x`\nis rejected.";
|
|
107
107
|
readonly properties: {
|
|
108
108
|
readonly alias: {
|
|
109
109
|
readonly description: "Explicit negated spelling without the `--` prefix (e.g. `'no-sandbox'`).\n`undefined` synthesizes `no-<flagName>` wherever the flag name is known.";
|
|
110
110
|
};
|
|
111
111
|
readonly hidden: {
|
|
112
|
-
readonly description:
|
|
112
|
+
readonly description: "Hide the negated spelling from help, completions, and suggestions.";
|
|
113
113
|
};
|
|
114
114
|
};
|
|
115
115
|
};
|
|
@@ -117,25 +117,25 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
117
117
|
readonly description: "The runtime descriptor stored inside every ArgBuilder. Consumers (parser,\nhelp generator) read this to understand the arg's shape without touching\ngenerics.";
|
|
118
118
|
readonly properties: {
|
|
119
119
|
readonly name: {
|
|
120
|
-
readonly description:
|
|
120
|
+
readonly description: "A named positional argument entry in the command schema.\n\nPairs a user-facing arg name with its ArgSchema descriptor.\nThe array ordering in CommandSchema.args determines CLI position.";
|
|
121
121
|
};
|
|
122
122
|
readonly kind: {
|
|
123
|
-
readonly description:
|
|
123
|
+
readonly description: "What kind of value this arg accepts.";
|
|
124
124
|
};
|
|
125
125
|
readonly presence: {
|
|
126
126
|
readonly description: "Presence describes whether a positional arg is guaranteed to exist when the\naction handler runs:\n\n- `'required'` — must be supplied; error if missing (default)\n- `'optional'` — may be `undefined` if not supplied\n- `'defaulted'` — always present (falls back to default value)";
|
|
127
127
|
};
|
|
128
128
|
readonly variadic: {
|
|
129
|
-
readonly description:
|
|
129
|
+
readonly description: "Whether this arg consumes all remaining positionals.";
|
|
130
130
|
};
|
|
131
131
|
readonly stdinMode: {
|
|
132
|
-
readonly description:
|
|
132
|
+
readonly description: "Whether this arg may read from stdin during resolution.\n\nDefault: `false`";
|
|
133
133
|
};
|
|
134
134
|
readonly defaultValue: {
|
|
135
|
-
readonly description:
|
|
135
|
+
readonly description: "Runtime default value (if any).";
|
|
136
136
|
};
|
|
137
137
|
readonly description: {
|
|
138
|
-
readonly description:
|
|
138
|
+
readonly description: "Human-readable description for help text.";
|
|
139
139
|
};
|
|
140
140
|
readonly envVar: {
|
|
141
141
|
readonly description: "Environment variable name for env resolution.\n\nWhen set and the CLI value is absent, the resolver reads this env var\nand coerces the string to the arg's declared kind.";
|
|
@@ -144,7 +144,7 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
144
144
|
readonly description: "Allowed literal values when `kind === 'enum'`.";
|
|
145
145
|
};
|
|
146
146
|
readonly deprecated: {
|
|
147
|
-
readonly description:
|
|
147
|
+
readonly description: "Deprecation marker.\n\n- `undefined` — not deprecated (default)\n- `true` — deprecated with no migration message\n- `string` — deprecated with a reason/migration message\n\nWhen a deprecated arg is used, a warning is emitted to stderr.\nHelp text shows `[deprecated]` or `[deprecated: <reason>]`.";
|
|
148
148
|
};
|
|
149
149
|
};
|
|
150
150
|
};
|
|
@@ -155,44 +155,44 @@ declare const definitionMetaSchemaDescriptions: {
|
|
|
155
155
|
readonly description: "The kind of interactive prompt to present.\n\n- `'confirm'` — yes/no boolean question\n- `'input'` — free-text string input\n- `'select'` — single selection from a list\n- `'multiselect'` — multiple selections from a list";
|
|
156
156
|
};
|
|
157
157
|
readonly message: {
|
|
158
|
-
readonly description:
|
|
158
|
+
readonly description: "The question displayed to the user.";
|
|
159
159
|
};
|
|
160
160
|
readonly placeholder: {
|
|
161
|
-
readonly description:
|
|
161
|
+
readonly description: "Placeholder text shown before user types (informational only).";
|
|
162
162
|
};
|
|
163
163
|
readonly choices: {
|
|
164
|
-
readonly description:
|
|
164
|
+
readonly description: "Available choices. When omitted for `enum` flags, the enum values\nfrom the flag schema are used automatically.";
|
|
165
165
|
};
|
|
166
166
|
readonly min: {
|
|
167
|
-
readonly description:
|
|
167
|
+
readonly description: "Minimum number of selections required.\n\nDefault: `0`";
|
|
168
168
|
};
|
|
169
169
|
readonly max: {
|
|
170
|
-
readonly description:
|
|
170
|
+
readonly description: "Maximum number of selections allowed.\n\nDefault: `Infinity`";
|
|
171
171
|
};
|
|
172
172
|
};
|
|
173
173
|
};
|
|
174
174
|
readonly choice: {
|
|
175
|
-
readonly description:
|
|
175
|
+
readonly description: "A selectable option for SelectPromptConfig and MultiselectPromptConfig prompts.";
|
|
176
176
|
readonly properties: {
|
|
177
177
|
readonly value: {
|
|
178
|
-
readonly description:
|
|
178
|
+
readonly description: "The value returned when this choice is selected.";
|
|
179
179
|
};
|
|
180
180
|
readonly label: {
|
|
181
|
-
readonly description:
|
|
181
|
+
readonly description: "Display label shown to the user.\n\nDefault: value";
|
|
182
182
|
};
|
|
183
183
|
readonly description: {
|
|
184
|
-
readonly description:
|
|
184
|
+
readonly description: "Optional description shown alongside the choice.";
|
|
185
185
|
};
|
|
186
186
|
};
|
|
187
187
|
};
|
|
188
188
|
readonly example: {
|
|
189
|
-
readonly description:
|
|
189
|
+
readonly description: "A single usage example shown in help text.";
|
|
190
190
|
readonly properties: {
|
|
191
191
|
readonly command: {
|
|
192
192
|
readonly description: "The command invocation (e.g. `'deploy production --force'`).";
|
|
193
193
|
};
|
|
194
194
|
readonly description: {
|
|
195
|
-
readonly description:
|
|
195
|
+
readonly description: "Optional description of what this example does.";
|
|
196
196
|
};
|
|
197
197
|
};
|
|
198
198
|
};
|