@shell-shock/core 0.17.11 → 0.17.13

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/dist/api.d.cts CHANGED
@@ -1,4 +1,4 @@
1
1
  //#region src/api.d.ts
2
- declare const _default: (params: import("@powerlines/engine").ExecutionApiParams<import("powerlines").ExecutionOptions, "types" | "docs" | "create" | "clean" | "prepare" | "lint" | "test" | "build" | "deploy">) => Promise<void>;
2
+ declare const _default: (params: import("@powerlines/engine").ExecutionApiParams<import("powerlines").ExecutionOptions, "docs" | "types" | "prepare" | "create" | "clean" | "lint" | "test" | "build" | "deploy">) => Promise<void>;
3
3
  export = _default;
4
4
  //# sourceMappingURL=api.d.cts.map
package/dist/api.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  //#region src/api.d.ts
2
- declare const _default: (params: import("@powerlines/engine").ExecutionApiParams<import("powerlines").ExecutionOptions, "types" | "docs" | "create" | "clean" | "prepare" | "lint" | "test" | "build" | "deploy">) => Promise<void>;
2
+ declare const _default: (params: import("@powerlines/engine").ExecutionApiParams<import("powerlines").ExecutionOptions, "docs" | "types" | "prepare" | "create" | "clean" | "lint" | "test" | "build" | "deploy">) => Promise<void>;
3
3
  //#endregion
4
4
  export { _default as default };
5
5
  //# sourceMappingURL=api.d.mts.map
@@ -418,7 +418,7 @@ function ExecBuiltin(props) {
418
418
  type: "number | SpawnOptions",
419
419
  default: "300_000"
420
420
  }],
421
- returnType: "Promise<SpawnResult>",
421
+ returnType: "SpawnResult",
422
422
  children: _alloy_js_core.code`const options: SpawnOptions =
423
423
  typeof optionsOrTimeoutMs === "number"
424
424
  ? { timeoutMs: optionsOrTimeoutMs }
@@ -415,7 +415,7 @@ function ExecBuiltin(props) {
415
415
  type: "number | SpawnOptions",
416
416
  default: "300_000"
417
417
  }],
418
- returnType: "Promise<SpawnResult>",
418
+ returnType: "SpawnResult",
419
419
  children: code`const options: SpawnOptions =
420
420
  typeof optionsOrTimeoutMs === "number"
421
421
  ? { timeoutMs: optionsOrTimeoutMs }
@@ -30,7 +30,6 @@ const __ΩUsageProps = [
30
30
  function Usage(props) {
31
31
  const { command, bin, packageManager } = props;
32
32
  return [
33
- _alloy_js_core.code`$ `,
34
33
  (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Switch, { get children() {
35
34
  return [
36
35
  (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Match, {
@@ -29,7 +29,6 @@ const __ΩUsageProps = [
29
29
  function Usage(props) {
30
30
  const { command, bin, packageManager } = props;
31
31
  return [
32
- code`$ `,
33
32
  createComponent(Switch, { get children() {
34
33
  return [
35
34
  createComponent(Match, {
package/dist/config.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.cjs";
1
+ import { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.cjs";
2
2
 
3
3
  //#region src/config.d.ts
4
4
  /**
@@ -33,5 +33,5 @@ declare function defineConfig(config: UserConfigFnPromise): UserConfigFnPromise;
33
33
  declare function defineConfig(config: UserConfigFn): UserConfigFn;
34
34
  declare function defineConfig(config: UserConfigExport): UserConfigExport;
35
35
  //#endregion
36
- export { type EngineOptions, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, defineConfig };
36
+ export { type DocsOptions, type EngineOptions, type Options, type OutputConfig, type ResolvedConfig, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, defineConfig };
37
37
  //# sourceMappingURL=config.d.cts.map
package/dist/config.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.mjs";
1
+ import { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.mjs";
2
2
 
3
3
  //#region src/config.d.ts
4
4
  /**
@@ -33,5 +33,5 @@ declare function defineConfig(config: UserConfigFnPromise): UserConfigFnPromise;
33
33
  declare function defineConfig(config: UserConfigFn): UserConfigFn;
34
34
  declare function defineConfig(config: UserConfigExport): UserConfigExport;
35
35
  //#endregion
36
- export { type EngineOptions, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, defineConfig };
36
+ export { type DocsOptions, type EngineOptions, type Options, type OutputConfig, type ResolvedConfig, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, defineConfig };
37
37
  //# sourceMappingURL=config.d.mts.map
@@ -1,4 +1,5 @@
1
1
  let _stryke_path_join = require("@stryke/path/join");
2
+ let powerlines_plugin_utils = require("powerlines/plugin-utils");
2
3
 
3
4
  //#region src/helpers/docs-helpers.ts
4
5
  /**
@@ -8,7 +9,7 @@ let _stryke_path_join = require("@stryke/path/join");
8
9
  * @returns The output path for the generated documentation.
9
10
  */
10
11
  function getDocsOutputPath(context) {
11
- return (0, _stryke_path_join.joinPaths)(context.config.root, "docs", "generated");
12
+ return (0, _stryke_path_join.joinPaths)((0, powerlines_plugin_utils.getDocsOutputPath)(context.config.root), "cli");
12
13
  }
13
14
  getDocsOutputPath.__type = [
14
15
  "Context",
@@ -1,4 +1,5 @@
1
1
  import { joinPaths } from "@stryke/path/join";
2
+ import { getDocsOutputPath } from "powerlines/plugin-utils";
2
3
 
3
4
  //#region src/helpers/docs-helpers.ts
4
5
  /**
@@ -7,10 +8,10 @@ import { joinPaths } from "@stryke/path/join";
7
8
  * @param context - The Shell Shock context.
8
9
  * @returns The output path for the generated documentation.
9
10
  */
10
- function getDocsOutputPath(context) {
11
- return joinPaths(context.config.root, "docs", "generated");
11
+ function getDocsOutputPath$1(context) {
12
+ return joinPaths(getDocsOutputPath(context.config.root), "cli");
12
13
  }
13
- getDocsOutputPath.__type = [
14
+ getDocsOutputPath$1.__type = [
14
15
  "Context",
15
16
  "context",
16
17
  "getDocsOutputPath",
@@ -19,5 +20,5 @@ getDocsOutputPath.__type = [
19
20
  ];
20
21
 
21
22
  //#endregion
22
- export { getDocsOutputPath };
23
+ export { getDocsOutputPath$1 as getDocsOutputPath };
23
24
  //# sourceMappingURL=docs-helpers.mjs.map
package/dist/index.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./types/command.cjs";
2
2
  import { Context, ExecutionContext, UnresolvedContext } from "./types/context.cjs";
3
- import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.cjs";
3
+ import { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.cjs";
4
4
  import { BaseCommandOptions } from "./types/options.cjs";
5
5
  import { defineConfig } from "./config.cjs";
6
6
 
@@ -77,5 +77,5 @@ declare function defineOptions(options: Record<string, CommandOptionConfig>): Re
77
77
  */
78
78
  declare function defineArguments(args: CommandArgumentConfig[]): CommandArgumentConfig[];
79
79
  //#endregion
80
- export { type AsCommandParameterConfig, type BaseBooleanCommandParameter, type BaseCommandOptions, type BaseCommandParameter, type BaseNumberCommandParameter, type BaseSingleCommandParameter, type BaseStringCommandParameter, type BaseVariadicCommandParameter, type BooleanCommandOption, type BooleanCommandParameter, type BooleanCommandParameterConfig, type CommandArgument, type CommandArgumentConfig, type CommandBase, type CommandConfig, type CommandMetadata, type CommandModule, type CommandOption, type CommandOptionConfig, type CommandParameter, type CommandParameterConfig, type CommandParameterType, type CommandTree, type Context, type EngineOptions, type ExecutionContext, type NumberCommandParameter, type NumberCommandParameterConfig, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type SerializedCommandTree, type SingleBooleanCommandParameter, type SingleNumberCommandParameter, type SingleStringCommandParameter, type StringCommandParameter, type StringCommandParameterConfig, type UnresolvedContext, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, type VariadicBooleanCommandParameter, type VariadicNumberCommandParameter, type VariadicStringCommandParameter, defineArguments, defineConfig, defineMetadata, defineOptions };
80
+ export { type AsCommandParameterConfig, type BaseBooleanCommandParameter, type BaseCommandOptions, type BaseCommandParameter, type BaseNumberCommandParameter, type BaseSingleCommandParameter, type BaseStringCommandParameter, type BaseVariadicCommandParameter, type BooleanCommandOption, type BooleanCommandParameter, type BooleanCommandParameterConfig, type CommandArgument, type CommandArgumentConfig, type CommandBase, type CommandConfig, type CommandMetadata, type CommandModule, type CommandOption, type CommandOptionConfig, type CommandParameter, type CommandParameterConfig, type CommandParameterType, type CommandTree, type Context, type DocsOptions, type EngineOptions, type ExecutionContext, type NumberCommandParameter, type NumberCommandParameterConfig, type Options, type OutputConfig, type ResolvedConfig, type SerializedCommandTree, type SingleBooleanCommandParameter, type SingleNumberCommandParameter, type SingleStringCommandParameter, type StringCommandParameter, type StringCommandParameterConfig, type UnresolvedContext, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, type VariadicBooleanCommandParameter, type VariadicNumberCommandParameter, type VariadicStringCommandParameter, defineArguments, defineConfig, defineMetadata, defineOptions };
81
81
  //# sourceMappingURL=index.d.cts.map
package/dist/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./types/command.mjs";
2
2
  import { Context, ExecutionContext, UnresolvedContext } from "./types/context.mjs";
3
- import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.mjs";
3
+ import { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./types/config.mjs";
4
4
  import { BaseCommandOptions } from "./types/options.mjs";
5
5
  import { defineConfig } from "./config.mjs";
6
6
 
@@ -77,5 +77,5 @@ declare function defineOptions(options: Record<string, CommandOptionConfig>): Re
77
77
  */
78
78
  declare function defineArguments(args: CommandArgumentConfig[]): CommandArgumentConfig[];
79
79
  //#endregion
80
- export { type AsCommandParameterConfig, type BaseBooleanCommandParameter, type BaseCommandOptions, type BaseCommandParameter, type BaseNumberCommandParameter, type BaseSingleCommandParameter, type BaseStringCommandParameter, type BaseVariadicCommandParameter, type BooleanCommandOption, type BooleanCommandParameter, type BooleanCommandParameterConfig, type CommandArgument, type CommandArgumentConfig, type CommandBase, type CommandConfig, type CommandMetadata, type CommandModule, type CommandOption, type CommandOptionConfig, type CommandParameter, type CommandParameterConfig, type CommandParameterType, type CommandTree, type Context, type EngineOptions, type ExecutionContext, type NumberCommandParameter, type NumberCommandParameterConfig, type Options, type OutputConfig, type ReferenceOptions, type ResolvedConfig, type SerializedCommandTree, type SingleBooleanCommandParameter, type SingleNumberCommandParameter, type SingleStringCommandParameter, type StringCommandParameter, type StringCommandParameterConfig, type UnresolvedContext, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, type VariadicBooleanCommandParameter, type VariadicNumberCommandParameter, type VariadicStringCommandParameter, defineArguments, defineConfig, defineMetadata, defineOptions };
80
+ export { type AsCommandParameterConfig, type BaseBooleanCommandParameter, type BaseCommandOptions, type BaseCommandParameter, type BaseNumberCommandParameter, type BaseSingleCommandParameter, type BaseStringCommandParameter, type BaseVariadicCommandParameter, type BooleanCommandOption, type BooleanCommandParameter, type BooleanCommandParameterConfig, type CommandArgument, type CommandArgumentConfig, type CommandBase, type CommandConfig, type CommandMetadata, type CommandModule, type CommandOption, type CommandOptionConfig, type CommandParameter, type CommandParameterConfig, type CommandParameterType, type CommandTree, type Context, type DocsOptions, type EngineOptions, type ExecutionContext, type NumberCommandParameter, type NumberCommandParameterConfig, type Options, type OutputConfig, type ResolvedConfig, type SerializedCommandTree, type SingleBooleanCommandParameter, type SingleNumberCommandParameter, type SingleStringCommandParameter, type StringCommandParameter, type StringCommandParameterConfig, type UnresolvedContext, type UserConfig, type UserConfigExport, type UserConfigFn, type UserConfigFnObject, type UserConfigFnPromise, type VariadicBooleanCommandParameter, type VariadicNumberCommandParameter, type VariadicStringCommandParameter, defineArguments, defineConfig, defineMetadata, defineOptions };
81
81
  //# sourceMappingURL=index.d.mts.map
package/dist/package.cjs CHANGED
@@ -1,6 +1,6 @@
1
1
 
2
2
  //#region package.json
3
- var version = "0.17.10";
3
+ var version = "0.17.12";
4
4
 
5
5
  //#endregion
6
6
  Object.defineProperty(exports, 'version', {
package/dist/package.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  //#region package.json
2
- var version = "0.17.10";
2
+ var version = "0.17.12";
3
3
 
4
4
  //#endregion
5
5
  export { version };
@@ -31,7 +31,8 @@ function computeBin(context) {
31
31
  args: [],
32
32
  entry: { file: (0, _stryke_path_join_paths.joinPaths)(context.entryPath, "bin.ts") },
33
33
  parent: null,
34
- children: context.commands
34
+ children: context.commands,
35
+ docs: context.config.docs?.app
35
36
  };
36
37
  }
37
38
  computeBin.__type = [
@@ -31,7 +31,8 @@ function computeBin(context) {
31
31
  args: [],
32
32
  entry: { file: joinPaths(context.entryPath, "bin.ts") },
33
33
  parent: null,
34
- children: context.commands
34
+ children: context.commands,
35
+ docs: context.config.docs?.app
35
36
  };
36
37
  }
37
38
  computeBin.__type = [
package/dist/plugin.cjs CHANGED
@@ -94,15 +94,13 @@ const plugin = __assignType((options = {}) => {
94
94
  if (!this.config.env.prefix || !Array.isArray(this.config.env.prefix)) this.config.env.prefix = (0, _stryke_convert_to_array.toArray)(this.config.env.prefix);
95
95
  if (!this.config.env.prefix.includes(this.config.appSpecificEnvPrefix)) this.config.env.prefix.push(this.config.appSpecificEnvPrefix);
96
96
  this.config.bin = ((0, _stryke_type_checks_is_set_string.isSetString)(this.packageJson.bin) ? { [(0, _stryke_string_format_kebab_case.kebabCase)(this.config.name)]: this.packageJson.bin } : this.packageJson.bin) ?? { [(0, _stryke_string_format_kebab_case.kebabCase)(this.config.name)]: require_update_package_json.formatBinaryPath(this.config.output.format) };
97
- if ((0, _stryke_type_checks_is_set_string.isSetString)(this.config.reference)) if (this.config.reference.includes("{command}")) this.config.reference = {
98
- app: this.config.reference.substring(0, this.config.reference.indexOf("{command}")).replace(/\/?$/, "/"),
99
- commands: this.config.reference
100
- };
101
- else if (this.config.reference.includes("{commands}")) this.config.reference = {
102
- app: this.config.reference.substring(0, this.config.reference.indexOf("{commands}")).replace(/\/?$/, "/"),
103
- commands: this.config.reference
104
- };
105
- else this.config.reference = { app: this.config.reference };
97
+ if ((0, _stryke_type_checks_is_set_string.isSetString)(this.config.docs)) {
98
+ const docsWithoutCommandPath = this.config.docs.replace(/\/?\{(?:command|cmd)\}.*$/, "");
99
+ this.config.docs = {
100
+ commands: this.config.docs,
101
+ app: this.config.docs.endsWith("/") ? docsWithoutCommandPath.endsWith("/") ? docsWithoutCommandPath : `${docsWithoutCommandPath}/` : docsWithoutCommandPath
102
+ };
103
+ }
106
104
  this.inputs ??= [];
107
105
  this.globalOptions = Object.values(require_utilities.getGlobalOptions(this, {
108
106
  id: null,
package/dist/plugin.mjs CHANGED
@@ -89,15 +89,13 @@ const plugin = __assignType((options = {}) => {
89
89
  if (!this.config.env.prefix || !Array.isArray(this.config.env.prefix)) this.config.env.prefix = toArray(this.config.env.prefix);
90
90
  if (!this.config.env.prefix.includes(this.config.appSpecificEnvPrefix)) this.config.env.prefix.push(this.config.appSpecificEnvPrefix);
91
91
  this.config.bin = (isSetString(this.packageJson.bin) ? { [kebabCase(this.config.name)]: this.packageJson.bin } : this.packageJson.bin) ?? { [kebabCase(this.config.name)]: formatBinaryPath(this.config.output.format) };
92
- if (isSetString(this.config.reference)) if (this.config.reference.includes("{command}")) this.config.reference = {
93
- app: this.config.reference.substring(0, this.config.reference.indexOf("{command}")).replace(/\/?$/, "/"),
94
- commands: this.config.reference
95
- };
96
- else if (this.config.reference.includes("{commands}")) this.config.reference = {
97
- app: this.config.reference.substring(0, this.config.reference.indexOf("{commands}")).replace(/\/?$/, "/"),
98
- commands: this.config.reference
99
- };
100
- else this.config.reference = { app: this.config.reference };
92
+ if (isSetString(this.config.docs)) {
93
+ const docsWithoutCommandPath = this.config.docs.replace(/\/?\{(?:command|cmd)\}.*$/, "");
94
+ this.config.docs = {
95
+ commands: this.config.docs,
96
+ app: this.config.docs.endsWith("/") ? docsWithoutCommandPath.endsWith("/") ? docsWithoutCommandPath : `${docsWithoutCommandPath}/` : docsWithoutCommandPath
97
+ };
98
+ }
101
99
  this.inputs ??= [];
102
100
  this.globalOptions = Object.values(getGlobalOptions(this, {
103
101
  id: null,
@@ -117,11 +117,12 @@ applyArgsDefaults.__type = [
117
117
  ];
118
118
  function applyDefaults(ctx) {
119
119
  ctx.output.description ??= `The ${ctx.output.title.replace(/(?:c|C)ommands?$/, "").trim()} executable command-line interface.`;
120
- if ((0, _stryke_type_checks_is_set_string.isSetString)(ctx.input.context.config.reference?.commands) && ctx.input.context.config.reference.commands.includes("{command}")) ctx.output.docs ??= ctx.input.context.config.reference.commands ? ctx.input.context.config.reference.commands.replace("{command}", ctx.input.command.segments.filter(__assignType((segment) => !require_context_helpers.isDynamicPathSegment(segment), [
120
+ if (ctx.input.command.segments.length && (0, _stryke_type_checks_is_set_string.isSetString)(ctx.input.context.config.docs?.commands) && /\{(?:(?:C|c)ommands?|(?:C|c)mds?)\}/.test(ctx.input.context.config.docs.commands)) ctx.output.docs ??= ctx.input.context.config.docs.commands ? ctx.input.context.config.docs.commands.replace(/\{(?:(?:C|c)ommands?|(?:C|c)mds?)\}/, ctx.input.command.segments.filter(__assignType((segment) => !require_context_helpers.isDynamicPathSegment(segment), [
121
121
  "segment",
122
122
  "",
123
123
  "P\"2!\"/\""
124
124
  ])).join("/")) : void 0;
125
+ else if (!ctx.input.command.segments.length && (0, _stryke_type_checks_is_set_string.isSetString)(ctx.input.context.config.docs?.app)) ctx.output.docs ??= ctx.input.context.config.docs.app;
125
126
  }
126
127
  applyDefaults.__type = [
127
128
  "ResolverContext",
@@ -117,11 +117,12 @@ applyArgsDefaults.__type = [
117
117
  ];
118
118
  function applyDefaults(ctx) {
119
119
  ctx.output.description ??= `The ${ctx.output.title.replace(/(?:c|C)ommands?$/, "").trim()} executable command-line interface.`;
120
- if (isSetString(ctx.input.context.config.reference?.commands) && ctx.input.context.config.reference.commands.includes("{command}")) ctx.output.docs ??= ctx.input.context.config.reference.commands ? ctx.input.context.config.reference.commands.replace("{command}", ctx.input.command.segments.filter(__assignType((segment) => !isDynamicPathSegment(segment), [
120
+ if (ctx.input.command.segments.length && isSetString(ctx.input.context.config.docs?.commands) && /\{(?:(?:C|c)ommands?|(?:C|c)mds?)\}/.test(ctx.input.context.config.docs.commands)) ctx.output.docs ??= ctx.input.context.config.docs.commands ? ctx.input.context.config.docs.commands.replace(/\{(?:(?:C|c)ommands?|(?:C|c)mds?)\}/, ctx.input.command.segments.filter(__assignType((segment) => !isDynamicPathSegment(segment), [
121
121
  "segment",
122
122
  "",
123
123
  "P\"2!\"/\""
124
124
  ])).join("/")) : void 0;
125
+ else if (!ctx.input.command.segments.length && isSetString(ctx.input.context.config.docs?.app)) ctx.output.docs ??= ctx.input.context.config.docs.app;
125
126
  }
126
127
  applyDefaults.__type = [
127
128
  "ResolverContext",
@@ -3,6 +3,7 @@ const require_utilities = require('../helpers/utilities.cjs');
3
3
  const require_helpers = require('./helpers.cjs');
4
4
  let _powerlines_schema = require("@powerlines/schema");
5
5
  let _stryke_convert_to_array = require("@stryke/convert/to-array");
6
+ let _stryke_path_replace = require("@stryke/path/replace");
6
7
  let _stryke_string_format_constant_case = require("@stryke/string-format/constant-case");
7
8
  let _stryke_type_checks_is_set_object = require("@stryke/type-checks/is-set-object");
8
9
  let _stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
@@ -280,9 +281,9 @@ async function preprocess(input) {
280
281
  };
281
282
  if (!command.virtual) {
282
283
  if (!command.entry.input?.file || !context.fs.existsSync(command.entry.input.file)) throw new Error(`${!command.entry.input?.file ? "Missing" : "Non-existent"} command entry file for "${command.name}"`);
283
- context.debug(`Adding reflection for CLI command: ${command.id} (file: ${command.entry.input.file})`);
284
+ context.debug(`Adding reflection for CLI command: ${command.id} (file: ${(0, _stryke_path_replace.replacePath)(command.entry.input.file, context.config.cwd)})`);
284
285
  result.module = await (_powerlines_schema.resolveModule.Ω = [["CommandModule", "\"w!"]], (0, _powerlines_schema.resolveModule)(context, command.entry.input, {
285
- name: command.title || (0, _stryke_string_format_title_case.titleCase)(command.name),
286
+ name: `${command.title || (0, _stryke_string_format_title_case.titleCase)(command.name)} Command Bundler`,
286
287
  plugins: [(0, _powerlines_deepkit_esbuild_plugin.esbuildPlugin)(context, {
287
288
  reflection: "default",
288
289
  level: "all"
@@ -3,6 +3,7 @@ import { getGlobalOptions } from "../helpers/utilities.mjs";
3
3
  import { applyArgsDefaults, applyDefaults, applyOptionsDefaults, resolveVirtualCommand } from "./helpers.mjs";
4
4
  import { addProperty, extract, getPropertiesList, resolveModule } from "@powerlines/schema";
5
5
  import { toArray } from "@stryke/convert/to-array";
6
+ import { replacePath } from "@stryke/path/replace";
6
7
  import { constantCase } from "@stryke/string-format/constant-case";
7
8
  import { isSetObject } from "@stryke/type-checks/is-set-object";
8
9
  import { isSetString } from "@stryke/type-checks/is-set-string";
@@ -280,9 +281,9 @@ async function preprocess(input) {
280
281
  };
281
282
  if (!command.virtual) {
282
283
  if (!command.entry.input?.file || !context.fs.existsSync(command.entry.input.file)) throw new Error(`${!command.entry.input?.file ? "Missing" : "Non-existent"} command entry file for "${command.name}"`);
283
- context.debug(`Adding reflection for CLI command: ${command.id} (file: ${command.entry.input.file})`);
284
+ context.debug(`Adding reflection for CLI command: ${command.id} (file: ${replacePath(command.entry.input.file, context.config.cwd)})`);
284
285
  result.module = await (resolveModule.Ω = [["CommandModule", "\"w!"]], resolveModule(context, command.entry.input, {
285
- name: command.title || titleCase(command.name),
286
+ name: `${command.title || titleCase(command.name)} Command Bundler`,
286
287
  plugins: [esbuildPlugin(context, {
287
288
  reflection: "default",
288
289
  level: "all"
@@ -37,12 +37,12 @@ const __ΩExclude = [
37
37
  "Exclude",
38
38
  "l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
39
39
  ];
40
- const __ΩReferenceOptions = [
40
+ const __ΩDocsOptions = [
41
41
  "app",
42
42
  "A URL to the application documentation or reference.",
43
43
  "commands",
44
44
  "A URL to the application command specific documentation or reference.",
45
- "ReferenceOptions",
45
+ "DocsOptions",
46
46
  "P&4!?\"&4#8?$Mw%y"
47
47
  ];
48
48
  const __ΩBaseOptions = [
@@ -63,9 +63,9 @@ const __ΩBaseOptions = [
63
63
  true,
64
64
  "autoAssignEnv",
65
65
  "Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?",
66
- () => __ΩReferenceOptions,
66
+ () => __ΩDocsOptions,
67
67
  "docs",
68
- "A URL to the application documentation or reference.",
68
+ "A URL to the command-line interface application's reference documentation.",
69
69
  "BaseOptions",
70
70
  "PP\"w!FP\"w\"2#\"w$2%\"w!F/&.'J4(8?))4*8>+?,P&&FJ4-8?.P./&J408?1Pn2&J438?4Mw5y"
71
71
  ];
@@ -145,13 +145,13 @@ const __ΩResolvedConfig = [
145
145
  () => __ΩOmit,
146
146
  () => __ΩOptions,
147
147
  "bin",
148
- "reference",
148
+ "docs",
149
149
  () => __ΩRecord,
150
150
  "bin",
151
151
  "The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).",
152
- () => __ΩReferenceOptions,
153
- "reference",
154
- "The URL(s) to the application documentation or reference.",
152
+ () => __ΩDocsOptions,
153
+ "docs",
154
+ "The URL(s) to the command-line interface application's reference documentation.",
155
155
  "appSpecificEnvPrefix",
156
156
  "The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.",
157
157
  () => __ΩUserConfig,
@@ -162,10 +162,10 @@ const __ΩResolvedConfig = [
162
162
  ];
163
163
 
164
164
  //#endregion
165
+ exports.__ΩDocsOptions = __ΩDocsOptions;
165
166
  exports.__ΩEngineOptions = __ΩEngineOptions;
166
167
  exports.__ΩOptions = __ΩOptions;
167
168
  exports.__ΩOutputConfig = __ΩOutputConfig;
168
- exports.__ΩReferenceOptions = __ΩReferenceOptions;
169
169
  exports.__ΩResolvedConfig = __ΩResolvedConfig;
170
170
  exports.__ΩUserConfig = __ΩUserConfig;
171
171
  exports.__ΩUserConfigExport = __ΩUserConfigExport;
@@ -10,7 +10,7 @@ import { EngineOptions as EngineOptions$1 } from "powerlines/engine";
10
10
 
11
11
  //#region src/types/config.d.ts
12
12
  type BuildOptions = Pick<UserConfig$1, "name" | "title" | "description" | "input" | "output" | "logLevel" | "mode" | "define" | "inject" | "resolve" | "organization" | "skipCache" | "autoInstall" | "plugins" | "tsconfig" | "tsconfigRaw">;
13
- interface ReferenceOptions {
13
+ interface DocsOptions {
14
14
  /**
15
15
  * A URL to the application documentation or reference.
16
16
  */
@@ -19,7 +19,7 @@ interface ReferenceOptions {
19
19
  * A URL to the application command specific documentation or reference.
20
20
  *
21
21
  * @remarks
22
- * This URL is expected to contain the token `{command}`, which will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
22
+ * This URL is expected to contain the token `{command}` or `{cmd}`, which will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
23
23
  */
24
24
  commands?: string;
25
25
  }
@@ -52,19 +52,19 @@ interface BaseOptions {
52
52
  * Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?
53
53
  *
54
54
  * @remarks
55
- * If set to a string, Shell Shock will use the provided string as an application specific environment variable prefix, convert the option name to {@link https://stringcase.org/cases/constant/ | constant case}, and prepend the provided `string` value to determine the corresponding environment variable name. For example, if an option is named `"configPath"` and the `autoAssignEnv` is `"MY_APP_"`, Shell Shock will look for an environment variable named `"MY_APP_CONFIG_PATH"` and assign its value to the option if it exists. If set to `true`, Shell Shock will use a default environment variable prefix derived from the {@link Options.name | application name}.
55
+ * If set to a string, Shell Shock will use the provided string as an application specific environment variable prefix, convert the option name to {@link https://stringcase.org/cases/constant/ | constant case}, and prepend the provided `string` value to determine the corresponding environment variable name. For example, if an option is named `"configPath"` and the `autoAssignEnv` is `"MY_APP"`, Shell Shock will look for an environment variable named `"MY_APP_CONFIG_PATH"` and assign its value to the option if it exists. If set to `true`, Shell Shock will use a default environment variable prefix derived from the {@link Options.name | application name}.
56
56
  *
57
57
  * @see https://medium.com/chingu/an-introduction-to-environment-variables-and-how-to-use-them-f602f66d15fa
58
58
  * @see https://stringcase.org/cases/constant/
59
59
  */
60
60
  autoAssignEnv?: true | string;
61
61
  /**
62
- * A URL to the application documentation or reference.
62
+ * A URL to the command-line interface application's reference documentation.
63
63
  *
64
64
  * @remarks
65
- * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
65
+ * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` (or `{cmd}`) is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
66
66
  */
67
- docs?: ReferenceOptions | string;
67
+ docs?: DocsOptions | string;
68
68
  }
69
69
  /**
70
70
  * The plugin options for Shell Shock.
@@ -96,7 +96,7 @@ type EngineOptions = Omit<EngineOptions$1, "root" | "name" | "framework">;
96
96
  /**
97
97
  * The resolved configuration options for Shell Shock.
98
98
  */
99
- type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & AutoMDPluginResolvedConfig & NodeJsPluginResolvedConfig & Required<Omit<Options, "bin" | "reference">> & {
99
+ type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & AutoMDPluginResolvedConfig & NodeJsPluginResolvedConfig & Required<Omit<Options, "bin" | "docs">> & {
100
100
  /**
101
101
  * The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | "bin" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).
102
102
  *
@@ -109,9 +109,9 @@ type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & A
109
109
  */
110
110
  bin: Record<string, string>;
111
111
  /**
112
- * The URL(s) to the application documentation or reference.
112
+ * The URL(s) to the command-line interface application's reference documentation.
113
113
  */
114
- reference: ReferenceOptions;
114
+ docs: DocsOptions;
115
115
  /**
116
116
  * The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.
117
117
  */
@@ -122,5 +122,5 @@ type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & A
122
122
  userConfig: UserConfig;
123
123
  };
124
124
  //#endregion
125
- export { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise };
125
+ export { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise };
126
126
  //# sourceMappingURL=config.d.cts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.cts","names":[],"sources":["../../src/types/config.ts"],"mappings":";;;;;;;;;;;KAmCK,YAAA,GAAe,IAAI,CACtB,YAAA;AAAA,UAmBe,gBAAA;EApBZ;;;EAwBH,GAAA;EAvBoB;AAmBtB;;;;AAYU;EAAR,QAAQ;AAAA;AAAA,UAGA,WAAA;EAQJ;;;;;;EADJ,aAAA,GACI,aAAA,OACE,OAAA,EAAS,OAAA,OAAc,KAAA,EAAO,WAAA,KAAgB,aAAA;EAFpD;;;;;EAUA,eAAA;EARoD;;;;;;;AAuC7B;AAMzB;;EAzBE,GAAA;EAyBoB;;;;;;;;;EAdpB,aAAA;EAmBU;;;;;;EAXV,IAAA,GAAO,gBAAA;AAAA;AAkBJ;AAML;;AANK,KAZO,OAAA,GAAU,WAAA,GAAc,OAAA,CAAQ,mBAAA;;;;KAKhC,YAAA,GAAe,IAAI,CAC7B,cAAA;EAiBuB;;;EAXvB,GAAA;AAAA;;;;KAMU,UAAA,GAAa,WAAA,GACvB,YAAA,CAAa,YAAA;EAOH;;;EAHR,MAAA,GAAS,YAAA;AAAA;AAAA,KAGD,kBAAA,IACV,GAAA,EAAK,YAAA,KACF,UAAA,GAAa,UAAA;AAAA,KACN,mBAAA,IACV,GAAA,EAAK,YAAA,KACF,OAAA,CAAQ,UAAA,GAAa,UAAA;AAAA,KACd,YAAA,IACV,GAAA,EAAK,YAAA,KACF,UAAA,GAAa,UAAA,KAAe,OAAA,CAAQ,UAAA,GAAa,UAAA;AAAA,KAE1C,gBAAA,GACR,UAAA,GACA,UAAA,KACA,OAAA,CAAQ,UAAA,GAAa,UAAA,MACrB,kBAAA,GACA,mBAAA,GACA,YAAA;AAAA,KAEQ,aAAA,GAAgB,IAAI,CAC9B,eAAA;;;;KAOU,cAAA,GAAiB,0BAAA,GAC3B,yBAAA,GACA,0BAAA,GACA,0BAAA,GACA,QAAA,CAAS,IAAA,CAAK,OAAA;EA3BJ;;;;;;;;;;EAsCR,GAAA,EAAK,MAAA;EApCJ;;;EAyCD,SAAA,EAAW,gBAAA;EAzCqB;AACpC;;EA6CI,oBAAA;EA5CG;;;EAiDH,UAAA,EAAY,UAAA;AAAA"}
1
+ {"version":3,"file":"config.d.cts","names":[],"sources":["../../src/types/config.ts"],"mappings":";;;;;;;;;;;KAmCK,YAAA,GAAe,IAAI,CACtB,YAAA;AAAA,UAmBe,WAAA;EApBZ;;;EAwBH,GAAA;EAvBoB;AAmBtB;;;;AAYU;EAAR,QAAQ;AAAA;AAAA,UAGA,WAAA;EAQJ;;;;;;EADJ,aAAA,GACI,aAAA,OACE,OAAA,EAAS,OAAA,OAAc,KAAA,EAAO,WAAA,KAAgB,aAAA;EAFpD;;;;;EAUA,eAAA;EARoD;;;;;;;AAuClC;AAMpB;;EAzBE,GAAA;EAyBoB;;;;;;;;;EAdpB,aAAA;EAmBU;;;;;;EAXV,IAAA,GAAO,WAAA;AAAA;AAkBJ;AAML;;AANK,KAZO,OAAA,GAAU,WAAA,GAAc,OAAA,CAAQ,mBAAA;;;;KAKhC,YAAA,GAAe,IAAI,CAC7B,cAAA;EAiBuB;;;EAXvB,GAAA;AAAA;;;;KAMU,UAAA,GAAa,WAAA,GACvB,YAAA,CAAa,YAAA;EAOH;;;EAHR,MAAA,GAAS,YAAA;AAAA;AAAA,KAGD,kBAAA,IACV,GAAA,EAAK,YAAA,KACF,UAAA,GAAa,UAAA;AAAA,KACN,mBAAA,IACV,GAAA,EAAK,YAAA,KACF,OAAA,CAAQ,UAAA,GAAa,UAAA;AAAA,KACd,YAAA,IACV,GAAA,EAAK,YAAA,KACF,UAAA,GAAa,UAAA,KAAe,OAAA,CAAQ,UAAA,GAAa,UAAA;AAAA,KAE1C,gBAAA,GACR,UAAA,GACA,UAAA,KACA,OAAA,CAAQ,UAAA,GAAa,UAAA,MACrB,kBAAA,GACA,mBAAA,GACA,YAAA;AAAA,KAEQ,aAAA,GAAgB,IAAI,CAC9B,eAAA;;;;KAOU,cAAA,GAAiB,0BAAA,GAC3B,yBAAA,GACA,0BAAA,GACA,0BAAA,GACA,QAAA,CAAS,IAAA,CAAK,OAAA;EA3BJ;;;;;;;;;;EAsCR,GAAA,EAAK,MAAA;EApCJ;;;EAyCD,IAAA,EAAM,WAAA;EAzC0B;AACpC;;EA6CI,oBAAA;EA5CG;;;EAiDH,UAAA,EAAY,UAAA;AAAA"}
@@ -10,7 +10,7 @@ import { EngineOptions as EngineOptions$1 } from "powerlines/engine";
10
10
 
11
11
  //#region src/types/config.d.ts
12
12
  type BuildOptions = Pick<UserConfig$1, "name" | "title" | "description" | "input" | "output" | "logLevel" | "mode" | "define" | "inject" | "resolve" | "organization" | "skipCache" | "autoInstall" | "plugins" | "tsconfig" | "tsconfigRaw">;
13
- interface ReferenceOptions {
13
+ interface DocsOptions {
14
14
  /**
15
15
  * A URL to the application documentation or reference.
16
16
  */
@@ -19,7 +19,7 @@ interface ReferenceOptions {
19
19
  * A URL to the application command specific documentation or reference.
20
20
  *
21
21
  * @remarks
22
- * This URL is expected to contain the token `{command}`, which will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
22
+ * This URL is expected to contain the token `{command}` or `{cmd}`, which will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
23
23
  */
24
24
  commands?: string;
25
25
  }
@@ -52,19 +52,19 @@ interface BaseOptions {
52
52
  * Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?
53
53
  *
54
54
  * @remarks
55
- * If set to a string, Shell Shock will use the provided string as an application specific environment variable prefix, convert the option name to {@link https://stringcase.org/cases/constant/ | constant case}, and prepend the provided `string` value to determine the corresponding environment variable name. For example, if an option is named `"configPath"` and the `autoAssignEnv` is `"MY_APP_"`, Shell Shock will look for an environment variable named `"MY_APP_CONFIG_PATH"` and assign its value to the option if it exists. If set to `true`, Shell Shock will use a default environment variable prefix derived from the {@link Options.name | application name}.
55
+ * If set to a string, Shell Shock will use the provided string as an application specific environment variable prefix, convert the option name to {@link https://stringcase.org/cases/constant/ | constant case}, and prepend the provided `string` value to determine the corresponding environment variable name. For example, if an option is named `"configPath"` and the `autoAssignEnv` is `"MY_APP"`, Shell Shock will look for an environment variable named `"MY_APP_CONFIG_PATH"` and assign its value to the option if it exists. If set to `true`, Shell Shock will use a default environment variable prefix derived from the {@link Options.name | application name}.
56
56
  *
57
57
  * @see https://medium.com/chingu/an-introduction-to-environment-variables-and-how-to-use-them-f602f66d15fa
58
58
  * @see https://stringcase.org/cases/constant/
59
59
  */
60
60
  autoAssignEnv?: true | string;
61
61
  /**
62
- * A URL to the application documentation or reference.
62
+ * A URL to the command-line interface application's reference documentation.
63
63
  *
64
64
  * @remarks
65
- * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
65
+ * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` (or `{cmd}`) is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
66
66
  */
67
- docs?: ReferenceOptions | string;
67
+ docs?: DocsOptions | string;
68
68
  }
69
69
  /**
70
70
  * The plugin options for Shell Shock.
@@ -96,7 +96,7 @@ type EngineOptions = Omit<EngineOptions$1, "root" | "name" | "framework">;
96
96
  /**
97
97
  * The resolved configuration options for Shell Shock.
98
98
  */
99
- type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & AutoMDPluginResolvedConfig & NodeJsPluginResolvedConfig & Required<Omit<Options, "bin" | "reference">> & {
99
+ type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & AutoMDPluginResolvedConfig & NodeJsPluginResolvedConfig & Required<Omit<Options, "bin" | "docs">> & {
100
100
  /**
101
101
  * The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | "bin" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).
102
102
  *
@@ -109,9 +109,9 @@ type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & A
109
109
  */
110
110
  bin: Record<string, string>;
111
111
  /**
112
- * The URL(s) to the application documentation or reference.
112
+ * The URL(s) to the command-line interface application's reference documentation.
113
113
  */
114
- reference: ReferenceOptions;
114
+ docs: DocsOptions;
115
115
  /**
116
116
  * The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.
117
117
  */
@@ -122,5 +122,5 @@ type ResolvedConfig = TsdownPluginResolvedConfig & AlloyPluginResolvedConfig & A
122
122
  userConfig: UserConfig;
123
123
  };
124
124
  //#endregion
125
- export { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise };
125
+ export { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise };
126
126
  //# sourceMappingURL=config.d.mts.map
@@ -35,12 +35,12 @@ const __ΩExclude = [
35
35
  "Exclude",
36
36
  "l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
37
37
  ];
38
- const __ΩReferenceOptions = [
38
+ const __ΩDocsOptions = [
39
39
  "app",
40
40
  "A URL to the application documentation or reference.",
41
41
  "commands",
42
42
  "A URL to the application command specific documentation or reference.",
43
- "ReferenceOptions",
43
+ "DocsOptions",
44
44
  "P&4!?\"&4#8?$Mw%y"
45
45
  ];
46
46
  const __ΩBaseOptions = [
@@ -61,9 +61,9 @@ const __ΩBaseOptions = [
61
61
  true,
62
62
  "autoAssignEnv",
63
63
  "Should Shell Shock attempt to automatically assign environment variables to manipulate default values for command options based on the option name?",
64
- () => __ΩReferenceOptions,
64
+ () => __ΩDocsOptions,
65
65
  "docs",
66
- "A URL to the application documentation or reference.",
66
+ "A URL to the command-line interface application's reference documentation.",
67
67
  "BaseOptions",
68
68
  "PP\"w!FP\"w\"2#\"w$2%\"w!F/&.'J4(8?))4*8>+?,P&&FJ4-8?.P./&J408?1Pn2&J438?4Mw5y"
69
69
  ];
@@ -143,13 +143,13 @@ const __ΩResolvedConfig = [
143
143
  () => __ΩOmit,
144
144
  () => __ΩOptions,
145
145
  "bin",
146
- "reference",
146
+ "docs",
147
147
  () => __ΩRecord,
148
148
  "bin",
149
149
  "The name of the binary (the {@link https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin | \"bin\" field} in package.json) that will be used to run the application through NodeJs package managers (e.g., npm, yarn, pnpm).",
150
- () => __ΩReferenceOptions,
151
- "reference",
152
- "The URL(s) to the application documentation or reference.",
150
+ () => __ΩDocsOptions,
151
+ "docs",
152
+ "The URL(s) to the command-line interface application's reference documentation.",
153
153
  "appSpecificEnvPrefix",
154
154
  "The command-line application specific environment variable prefix used for automatically assigning environment variables to command options.",
155
155
  () => __ΩUserConfig,
@@ -160,5 +160,5 @@ const __ΩResolvedConfig = [
160
160
  ];
161
161
 
162
162
  //#endregion
163
- export { __ΩEngineOptions, __ΩOptions, __ΩOutputConfig, __ΩReferenceOptions, __ΩResolvedConfig, __ΩUserConfig, __ΩUserConfigExport, __ΩUserConfigFn, __ΩUserConfigFnObject, __ΩUserConfigFnPromise };
163
+ export { __ΩDocsOptions, __ΩEngineOptions, __ΩOptions, __ΩOutputConfig, __ΩResolvedConfig, __ΩUserConfig, __ΩUserConfigExport, __ΩUserConfigFn, __ΩUserConfigFnObject, __ΩUserConfigFnPromise };
164
164
  //# sourceMappingURL=config.mjs.map
@@ -28,13 +28,13 @@ exports.__ΩCommandParameterConfig = require_types_command.__ΩCommandParameterC
28
28
  exports.__ΩCommandParameterType = require_types_command.__ΩCommandParameterType;
29
29
  exports.__ΩCommandTree = require_types_command.__ΩCommandTree;
30
30
  exports.__ΩContext = require_types_context.__ΩContext;
31
+ exports.__ΩDocsOptions = require_types_config.__ΩDocsOptions;
31
32
  exports.__ΩEngineOptions = require_types_config.__ΩEngineOptions;
32
33
  exports.__ΩExecutionContext = require_types_context.__ΩExecutionContext;
33
34
  exports.__ΩNumberCommandParameter = require_types_command.__ΩNumberCommandParameter;
34
35
  exports.__ΩNumberCommandParameterConfig = require_types_command.__ΩNumberCommandParameterConfig;
35
36
  exports.__ΩOptions = require_types_config.__ΩOptions;
36
37
  exports.__ΩOutputConfig = require_types_config.__ΩOutputConfig;
37
- exports.__ΩReferenceOptions = require_types_config.__ΩReferenceOptions;
38
38
  exports.__ΩResolvedConfig = require_types_config.__ΩResolvedConfig;
39
39
  exports.__ΩSerializedCommandTree = require_types_command.__ΩSerializedCommandTree;
40
40
  exports.__ΩSingleBooleanCommandParameter = require_types_command.__ΩSingleBooleanCommandParameter;
@@ -1,5 +1,5 @@
1
1
  import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./command.cjs";
2
2
  import { Context, ExecutionContext, UnresolvedContext } from "./context.cjs";
3
- import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./config.cjs";
3
+ import { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./config.cjs";
4
4
  import { BaseCommandOptions } from "./options.cjs";
5
- export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandOptions, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, Context, EngineOptions, ExecutionContext, NumberCommandParameter, NumberCommandParameterConfig, Options, OutputConfig, ReferenceOptions, ResolvedConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, UnresolvedContext, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter };
5
+ export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandOptions, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, Context, DocsOptions, EngineOptions, ExecutionContext, NumberCommandParameter, NumberCommandParameterConfig, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, UnresolvedContext, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter };
@@ -1,5 +1,5 @@
1
1
  import { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter } from "./command.mjs";
2
2
  import { Context, ExecutionContext, UnresolvedContext } from "./context.mjs";
3
- import { EngineOptions, Options, OutputConfig, ReferenceOptions, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./config.mjs";
3
+ import { DocsOptions, EngineOptions, Options, OutputConfig, ResolvedConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise } from "./config.mjs";
4
4
  import { BaseCommandOptions } from "./options.mjs";
5
- export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandOptions, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, Context, EngineOptions, ExecutionContext, NumberCommandParameter, NumberCommandParameterConfig, Options, OutputConfig, ReferenceOptions, ResolvedConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, UnresolvedContext, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter };
5
+ export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandOptions, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, Context, DocsOptions, EngineOptions, ExecutionContext, NumberCommandParameter, NumberCommandParameterConfig, Options, OutputConfig, ResolvedConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, UnresolvedContext, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter };
@@ -1,6 +1,6 @@
1
1
  import { __ΩBaseCommandOptions } from "./options.mjs";
2
2
  import { __ΩAsCommandParameterConfig, __ΩBaseBooleanCommandParameter, __ΩBaseCommandParameter, __ΩBaseNumberCommandParameter, __ΩBaseSingleCommandParameter, __ΩBaseStringCommandParameter, __ΩBaseVariadicCommandParameter, __ΩBooleanCommandOption, __ΩBooleanCommandParameter, __ΩBooleanCommandParameterConfig, __ΩCommandArgument, __ΩCommandArgumentConfig, __ΩCommandBase, __ΩCommandConfig, __ΩCommandMetadata, __ΩCommandModule, __ΩCommandOption, __ΩCommandOptionConfig, __ΩCommandParameter, __ΩCommandParameterConfig, __ΩCommandParameterType, __ΩCommandTree, __ΩNumberCommandParameter, __ΩNumberCommandParameterConfig, __ΩSerializedCommandTree, __ΩSingleBooleanCommandParameter, __ΩSingleNumberCommandParameter, __ΩSingleStringCommandParameter, __ΩStringCommandParameter, __ΩStringCommandParameterConfig, __ΩVariadicBooleanCommandParameter, __ΩVariadicNumberCommandParameter, __ΩVariadicStringCommandParameter } from "./command.mjs";
3
- import { __ΩEngineOptions, __ΩOptions, __ΩOutputConfig, __ΩReferenceOptions, __ΩResolvedConfig, __ΩUserConfig, __ΩUserConfigExport, __ΩUserConfigFn, __ΩUserConfigFnObject, __ΩUserConfigFnPromise } from "./config.mjs";
3
+ import { __ΩDocsOptions, __ΩEngineOptions, __ΩOptions, __ΩOutputConfig, __ΩResolvedConfig, __ΩUserConfig, __ΩUserConfigExport, __ΩUserConfigFn, __ΩUserConfigFnObject, __ΩUserConfigFnPromise } from "./config.mjs";
4
4
  import { __ΩContext, __ΩExecutionContext, __ΩUnresolvedContext } from "./context.mjs";
5
5
 
6
- export { __ΩAsCommandParameterConfig, __ΩBaseBooleanCommandParameter, __ΩBaseCommandOptions, __ΩBaseCommandParameter, __ΩBaseNumberCommandParameter, __ΩBaseSingleCommandParameter, __ΩBaseStringCommandParameter, __ΩBaseVariadicCommandParameter, __ΩBooleanCommandOption, __ΩBooleanCommandParameter, __ΩBooleanCommandParameterConfig, __ΩCommandArgument, __ΩCommandArgumentConfig, __ΩCommandBase, __ΩCommandConfig, __ΩCommandMetadata, __ΩCommandModule, __ΩCommandOption, __ΩCommandOptionConfig, __ΩCommandParameter, __ΩCommandParameterConfig, __ΩCommandParameterType, __ΩCommandTree, __ΩContext, __ΩEngineOptions, __ΩExecutionContext, __ΩNumberCommandParameter, __ΩNumberCommandParameterConfig, __ΩOptions, __ΩOutputConfig, __ΩReferenceOptions, __ΩResolvedConfig, __ΩSerializedCommandTree, __ΩSingleBooleanCommandParameter, __ΩSingleNumberCommandParameter, __ΩSingleStringCommandParameter, __ΩStringCommandParameter, __ΩStringCommandParameterConfig, __ΩUnresolvedContext, __ΩUserConfig, __ΩUserConfigExport, __ΩUserConfigFn, __ΩUserConfigFnObject, __ΩUserConfigFnPromise, __ΩVariadicBooleanCommandParameter, __ΩVariadicNumberCommandParameter, __ΩVariadicStringCommandParameter };
6
+ export { __ΩAsCommandParameterConfig, __ΩBaseBooleanCommandParameter, __ΩBaseCommandOptions, __ΩBaseCommandParameter, __ΩBaseNumberCommandParameter, __ΩBaseSingleCommandParameter, __ΩBaseStringCommandParameter, __ΩBaseVariadicCommandParameter, __ΩBooleanCommandOption, __ΩBooleanCommandParameter, __ΩBooleanCommandParameterConfig, __ΩCommandArgument, __ΩCommandArgumentConfig, __ΩCommandBase, __ΩCommandConfig, __ΩCommandMetadata, __ΩCommandModule, __ΩCommandOption, __ΩCommandOptionConfig, __ΩCommandParameter, __ΩCommandParameterConfig, __ΩCommandParameterType, __ΩCommandTree, __ΩContext, __ΩDocsOptions, __ΩEngineOptions, __ΩExecutionContext, __ΩNumberCommandParameter, __ΩNumberCommandParameterConfig, __ΩOptions, __ΩOutputConfig, __ΩResolvedConfig, __ΩSerializedCommandTree, __ΩSingleBooleanCommandParameter, __ΩSingleNumberCommandParameter, __ΩSingleStringCommandParameter, __ΩStringCommandParameter, __ΩStringCommandParameterConfig, __ΩUnresolvedContext, __ΩUserConfig, __ΩUserConfigExport, __ΩUserConfigFn, __ΩUserConfigFnObject, __ΩUserConfigFnPromise, __ΩVariadicBooleanCommandParameter, __ΩVariadicNumberCommandParameter, __ΩVariadicStringCommandParameter };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shell-shock/core",
3
- "version": "0.17.11",
3
+ "version": "0.17.13",
4
4
  "private": false,
5
5
  "description": "A package containing the core Shell Shock functionality used to build and manage a command-line application.",
6
6
  "keywords": ["shell-shock", "powerlines", "storm-software"],
@@ -378,15 +378,15 @@
378
378
  "@alloy-js/core": "^0.23.1",
379
379
  "@alloy-js/markdown": "^0.23.0",
380
380
  "@alloy-js/typescript": "^0.23.0",
381
- "@powerlines/core": "^0.48.46",
382
- "@powerlines/deepkit": "^0.9.78",
383
- "@powerlines/engine": "^0.49.48",
384
- "@powerlines/plugin-alloy": "^0.26.217",
385
- "@powerlines/plugin-automd": "^0.1.585",
386
- "@powerlines/plugin-deepkit": "^0.11.467",
387
- "@powerlines/plugin-nodejs": "^0.1.529",
388
- "@powerlines/plugin-tsdown": "^0.1.525",
389
- "@powerlines/schema": "^0.11.106",
381
+ "@powerlines/core": "^0.48.49",
382
+ "@powerlines/deepkit": "^0.9.81",
383
+ "@powerlines/engine": "^0.49.51",
384
+ "@powerlines/plugin-alloy": "^0.26.220",
385
+ "@powerlines/plugin-automd": "^0.1.588",
386
+ "@powerlines/plugin-deepkit": "^0.11.470",
387
+ "@powerlines/plugin-nodejs": "^0.1.532",
388
+ "@powerlines/plugin-tsdown": "^0.1.528",
389
+ "@powerlines/schema": "^0.11.109",
390
390
  "@stryke/cli": "^0.13.57",
391
391
  "@stryke/convert": "^0.7.15",
392
392
  "@stryke/fs": "^0.33.85",
@@ -398,14 +398,14 @@
398
398
  "@stryke/types": "^0.12.12",
399
399
  "automd": "^0.4.3",
400
400
  "defu": "^6.1.7",
401
- "powerlines": "^0.47.124",
402
- "tsdown": "^0.22.1"
401
+ "powerlines": "^0.47.127",
402
+ "tsdown": "^0.22.2"
403
403
  },
404
404
  "devDependencies": {
405
- "@powerlines/plugin-plugin": "^0.12.536",
405
+ "@powerlines/plugin-plugin": "^0.12.539",
406
406
  "@types/node": "^25.9.1",
407
407
  "typescript": "^6.0.3"
408
408
  },
409
409
  "publishConfig": { "access": "public" },
410
- "gitHead": "9401c1de122d800040306fc89ad1835930c1a826"
410
+ "gitHead": "5e6228dd92f825a7e19988626b7b24bd0be08518"
411
411
  }