@shell-shock/core 0.5.1 → 0.7.0
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/README.md +1 -1
- package/dist/components/docs.d.cts +5 -5
- package/dist/components/docs.d.mts +5 -5
- package/dist/components/index.cjs +3 -1
- package/dist/components/index.d.cts +2 -2
- package/dist/components/index.d.mts +2 -2
- package/dist/components/index.mjs +2 -2
- package/dist/components/options-parser-logic.cjs +127 -31
- package/dist/components/options-parser-logic.cjs.map +1 -1
- package/dist/components/options-parser-logic.d.cts +37 -10
- package/dist/components/options-parser-logic.d.cts.map +1 -1
- package/dist/components/options-parser-logic.d.mts +31 -4
- package/dist/components/options-parser-logic.d.mts.map +1 -1
- package/dist/components/options-parser-logic.mjs +126 -32
- package/dist/components/options-parser-logic.mjs.map +1 -1
- package/dist/components/usage.cjs +6 -5
- package/dist/components/usage.cjs.map +1 -1
- package/dist/components/usage.d.cts +2 -4
- package/dist/components/usage.d.cts.map +1 -1
- package/dist/components/usage.d.mts +2 -4
- package/dist/components/usage.d.mts.map +1 -1
- package/dist/components/usage.mjs +7 -6
- package/dist/components/usage.mjs.map +1 -1
- package/dist/helpers/persistence.cjs +48 -3
- package/dist/helpers/persistence.cjs.map +1 -1
- package/dist/helpers/persistence.mjs +48 -3
- package/dist/helpers/persistence.mjs.map +1 -1
- package/dist/helpers/resolve-command.cjs +103 -53
- package/dist/helpers/resolve-command.cjs.map +1 -1
- package/dist/helpers/resolve-command.mjs +105 -55
- package/dist/helpers/resolve-command.mjs.map +1 -1
- package/dist/helpers/validations.cjs +20 -20
- package/dist/helpers/validations.cjs.map +1 -1
- package/dist/helpers/validations.mjs +21 -21
- package/dist/helpers/validations.mjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/plugin-utils/context-helpers.cjs +105 -4
- package/dist/plugin-utils/context-helpers.cjs.map +1 -1
- package/dist/plugin-utils/context-helpers.d.cts +89 -3
- package/dist/plugin-utils/context-helpers.d.cts.map +1 -1
- package/dist/plugin-utils/context-helpers.d.mts +89 -3
- package/dist/plugin-utils/context-helpers.d.mts.map +1 -1
- package/dist/plugin-utils/context-helpers.mjs +99 -3
- package/dist/plugin-utils/context-helpers.mjs.map +1 -1
- package/dist/plugin-utils/get-command-tree.cjs +1 -1
- package/dist/plugin-utils/get-command-tree.cjs.map +1 -1
- package/dist/plugin-utils/get-command-tree.mjs +2 -2
- package/dist/plugin-utils/get-command-tree.mjs.map +1 -1
- package/dist/plugin-utils/index.cjs +7 -2
- package/dist/plugin-utils/index.d.cts +2 -2
- package/dist/plugin-utils/index.d.mts +2 -2
- package/dist/plugin-utils/index.mjs +2 -2
- package/dist/plugin.cjs +1 -1
- package/dist/plugin.cjs.map +1 -1
- package/dist/plugin.d.cts.map +1 -1
- package/dist/plugin.d.mts.map +1 -1
- package/dist/plugin.mjs +2 -2
- package/dist/plugin.mjs.map +1 -1
- package/dist/types/command.d.cts +291 -9
- package/dist/types/command.d.cts.map +1 -1
- package/dist/types/command.d.mts +291 -9
- package/dist/types/command.d.mts.map +1 -1
- package/dist/types/index.d.cts +2 -2
- package/dist/types/index.d.mts +2 -2
- package/package.json +3 -3
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
const require_plugin_utils_context_helpers = require('../plugin-utils/context-helpers.cjs');
|
|
2
2
|
|
|
3
3
|
//#region src/helpers/validations.ts
|
|
4
|
-
function
|
|
4
|
+
function validateDynamicPathSegments(command) {
|
|
5
5
|
const failures = [];
|
|
6
6
|
if (!command.isVirtual && command.path.segments.length > 0) {
|
|
7
|
-
const
|
|
8
|
-
for (const segment of command.path.segments.filter(require_plugin_utils_context_helpers.
|
|
9
|
-
if (
|
|
10
|
-
code: "
|
|
11
|
-
details: `Duplicate
|
|
7
|
+
const dynamicPathSegmentNames = /* @__PURE__ */ new Set();
|
|
8
|
+
for (const segment of command.path.segments.filter(require_plugin_utils_context_helpers.isDynamicPathSegment) ?? []) {
|
|
9
|
+
if (dynamicPathSegmentNames.has(segment)) failures.push({
|
|
10
|
+
code: "DUPLICATE_DYNAMIC_PATH_SEGMENT_NAME",
|
|
11
|
+
details: `Duplicate dynamic path segment name "${require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment)}" found in command.`
|
|
12
12
|
});
|
|
13
|
-
|
|
13
|
+
dynamicPathSegmentNames.add(require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment));
|
|
14
14
|
}
|
|
15
|
-
if (command.path.segments.filter(require_plugin_utils_context_helpers.
|
|
16
|
-
code: "
|
|
17
|
-
details: `Mismatch between
|
|
15
|
+
if (command.path.segments.filter(require_plugin_utils_context_helpers.isDynamicPathSegment).length !== Object.keys(command.path.dynamics ?? {}).length) failures.push({
|
|
16
|
+
code: "DYNAMIC_PATH_SEGMENT_MISMATCH",
|
|
17
|
+
details: `Mismatch between dynamic path segments and defined dynamic path segments in command (found ${command.path.segments.filter(require_plugin_utils_context_helpers.isDynamicPathSegment).length} dynamic path segments in the command folder path "${command.path.segments.join("/")}", but ${Object.keys(command.path.dynamics ?? {}).length} potential dynamic path segment(s) could be determined from the command's function signature).`
|
|
18
18
|
});
|
|
19
|
-
const missing = command.path.segments.filter(require_plugin_utils_context_helpers.
|
|
19
|
+
const missing = command.path.segments.filter(require_plugin_utils_context_helpers.isDynamicPathSegment).filter((segment) => Object.prototype.hasOwnProperty.call(command.path.dynamics ?? {}, require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment)) === false);
|
|
20
20
|
if (missing.length > 0) failures.push({
|
|
21
|
-
code: "
|
|
22
|
-
details: `${missing.length}
|
|
21
|
+
code: "MISSING_DYNAMIC_PATH_SEGMENT_DEFINITION",
|
|
22
|
+
details: `${missing.length} dynamic path segment${missing.length > 1 ? "s" : ""} in the command folder path "${command.path.segments.join("/")}" do${missing.length > 1 ? "" : "es"} not have corresponding entr${missing.length > 1 ? "ies" : "y"} in the command's path dynamic segments: \n- ${missing.map((segment) => `"${require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment)}"`).join("\n- ")}`
|
|
23
23
|
});
|
|
24
24
|
else {
|
|
25
|
-
for (const varName of Object.keys(command.path.
|
|
26
|
-
code: "
|
|
27
|
-
details: `The
|
|
25
|
+
for (const varName of Object.keys(command.path.dynamics ?? {})) if (!command.path.segments.filter(require_plugin_utils_context_helpers.isDynamicPathSegment).find((segment) => require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment) === varName)) failures.push({
|
|
26
|
+
code: "UNUSED_DYNAMIC_PATH_SEGMENT",
|
|
27
|
+
details: `The dynamic path segment name "${varName}" defined in the command's path dynamic segments is not used in the command folder path "${command.path.segments.join("/")}".`
|
|
28
28
|
});
|
|
29
29
|
command.path.segments.forEach((segment, index) => {
|
|
30
|
-
if (require_plugin_utils_context_helpers.
|
|
31
|
-
code: "
|
|
32
|
-
details: `The
|
|
30
|
+
if (require_plugin_utils_context_helpers.isDynamicPathSegment(segment) && command.path.dynamics[require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment)]?.catchAll === true && index + 1 < command.path.segments.length && command.path.segments[index + 1] && command.path.dynamics[require_plugin_utils_context_helpers.getDynamicPathSegmentName(command.path.segments[index + 1])]?.catchAll === true) failures.push({
|
|
31
|
+
code: "MULTIPLE_CATCH_ALL_PATH_SEGMENTS",
|
|
32
|
+
details: `The catch-all path segment "${require_plugin_utils_context_helpers.getDynamicPathSegmentName(segment)}" in the command at path "${command.path.segments.join("/")}" is marked as catch-all, and it is followed by another catch-all dynamic path segment "${require_plugin_utils_context_helpers.getDynamicPathSegmentName(command.path.segments[index + 1])}". Only one catch-all path segment is allowed per command, and it must be the final path segment.`
|
|
33
33
|
});
|
|
34
34
|
});
|
|
35
35
|
}
|
|
@@ -57,7 +57,7 @@ function validateCommandOptions(command) {
|
|
|
57
57
|
}
|
|
58
58
|
function validateCommand(command) {
|
|
59
59
|
const results = [];
|
|
60
|
-
let failures =
|
|
60
|
+
let failures = validateDynamicPathSegments(command);
|
|
61
61
|
if (failures.length > 0) results.push(...failures);
|
|
62
62
|
failures = validateCommandOptions(command);
|
|
63
63
|
if (failures.length > 0) results.push(...failures);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validations.cjs","names":["
|
|
1
|
+
{"version":3,"file":"validations.cjs","names":["getDynamicPathSegmentName","isDynamicPathSegment","validateDynamicPathSegments","command","failures","isVirtual","path","segments","length","dynamicPathSegmentNames","Set","segment","filter","has","push","code","details","add","Object","keys","dynamics","join","missing","prototype","hasOwnProperty","call","map","varName","find","forEach","index","catchAll","validateCommandOptions","optionNames","option","values","options","name","alias","validateCommand","results"],"sources":["../../src/helpers/validations.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n getDynamicPathSegmentName,\n isDynamicPathSegment\n} from \"../plugin-utils/context-helpers\";\nimport type { CommandTree } from \"../types\";\n\nexport interface ValidationFailure {\n code: string;\n details: string;\n}\n\nexport function validateDynamicPathSegments(\n command: CommandTree\n): ValidationFailure[] {\n const failures: ValidationFailure[] = [];\n if (!command.isVirtual && command.path.segments.length > 0) {\n const dynamicPathSegmentNames = new Set<string>();\n for (const segment of command.path.segments.filter(isDynamicPathSegment) ??\n []) {\n if (dynamicPathSegmentNames.has(segment)) {\n failures.push({\n code: \"DUPLICATE_DYNAMIC_PATH_SEGMENT_NAME\",\n details: `Duplicate dynamic path segment name \"${getDynamicPathSegmentName(segment)}\" found in command.`\n });\n }\n dynamicPathSegmentNames.add(getDynamicPathSegmentName(segment));\n }\n\n if (\n command.path.segments.filter(isDynamicPathSegment).length !==\n Object.keys(command.path.dynamics ?? {}).length\n ) {\n failures.push({\n code: \"DYNAMIC_PATH_SEGMENT_MISMATCH\",\n details: `Mismatch between dynamic path segments and defined dynamic path segments in command (found ${\n command.path.segments.filter(isDynamicPathSegment).length\n } dynamic path segments in the command folder path \"${command.path.segments.join(\"/\")}\", but ${\n Object.keys(command.path.dynamics ?? {}).length\n } potential dynamic path segment(s) could be determined from the command's function signature).`\n });\n }\n\n const missing = command.path.segments\n .filter(isDynamicPathSegment)\n .filter(\n segment =>\n Object.prototype.hasOwnProperty.call(\n command.path.dynamics ?? {},\n getDynamicPathSegmentName(segment)\n ) === false\n );\n if (missing.length > 0) {\n failures.push({\n code: \"MISSING_DYNAMIC_PATH_SEGMENT_DEFINITION\",\n details: `${missing.length} dynamic path segment${missing.length > 1 ? \"s\" : \"\"} in the command folder path \"${command.path.segments.join(\n \"/\"\n )}\" do${missing.length > 1 ? \"\" : \"es\"} not have corresponding entr${\n missing.length > 1 ? \"ies\" : \"y\"\n } in the command's path dynamic segments: \\n- ${missing\n .map(segment => `\"${getDynamicPathSegmentName(segment)}\"`)\n .join(\"\\n- \")}`\n });\n } else {\n for (const varName of Object.keys(command.path.dynamics ?? {})) {\n if (\n !command.path.segments\n .filter(isDynamicPathSegment)\n .find(segment => getDynamicPathSegmentName(segment) === varName)\n ) {\n failures.push({\n code: \"UNUSED_DYNAMIC_PATH_SEGMENT\",\n details: `The dynamic path segment name \"${\n varName\n }\" defined in the command's path dynamic segments is not used in the command folder path \"${command.path.segments.join(\n \"/\"\n )}\".`\n });\n }\n }\n\n command.path.segments.forEach((segment, index) => {\n if (\n isDynamicPathSegment(segment) &&\n command.path.dynamics[getDynamicPathSegmentName(segment)]\n ?.catchAll === true &&\n index + 1 < command.path.segments.length &&\n command.path.segments[index + 1] &&\n command.path.dynamics[\n getDynamicPathSegmentName(command.path.segments[index + 1]!)\n ]?.catchAll === true\n ) {\n failures.push({\n code: \"MULTIPLE_CATCH_ALL_PATH_SEGMENTS\",\n details: `The catch-all path segment \"${getDynamicPathSegmentName(\n segment\n )}\" in the command at path \"${command.path.segments.join(\n \"/\"\n )}\" is marked as catch-all, and it is followed by another catch-all dynamic path segment \"${getDynamicPathSegmentName(\n command.path.segments[index + 1]!\n )}\". Only one catch-all path segment is allowed per command, and it must be the final path segment.`\n });\n }\n });\n }\n }\n\n return failures;\n}\n\nexport function validateCommandOptions(\n command: CommandTree\n): ValidationFailure[] {\n const failures: ValidationFailure[] = [];\n\n const optionNames = new Set<string>();\n for (const option of Object.values(command.options ?? {})) {\n if (optionNames.has(option.name)) {\n failures.push({\n code: \"DUPLICATE_OPTION_NAME\",\n details: `Duplicate option name \"${option.name}\" found in command.`\n });\n }\n optionNames.add(option.name);\n\n for (const alias of option.alias) {\n if (optionNames.has(alias)) {\n failures.push({\n code: \"DUPLICATE_OPTION_ALIAS\",\n details: `Duplicate option name \"${alias}\" (an alias of \"${\n option.name\n }\") found in command.`\n });\n }\n optionNames.add(alias);\n }\n }\n\n return failures;\n}\n\nexport function validateCommand(command: CommandTree): ValidationFailure[] {\n const results: ValidationFailure[] = [];\n\n let failures = validateDynamicPathSegments(command);\n if (failures.length > 0) {\n results.push(...failures);\n }\n\n failures = validateCommandOptions(command);\n if (failures.length > 0) {\n results.push(...failures);\n }\n\n return results;\n}\n"],"mappings":";;;AA6BA,SAAgBE,4BACdC,SACqB;CACrB,MAAMC,WAAgC,EAAE;AACxC,KAAI,CAACD,QAAQE,aAAaF,QAAQG,KAAKC,SAASC,SAAS,GAAG;EAC1D,MAAMC,0CAA0B,IAAIC,KAAa;AACjD,OAAK,MAAMC,WAAWR,QAAQG,KAAKC,SAASK,OAAOX,0DAAqB,IACtE,EAAE,EAAE;AACJ,OAAIQ,wBAAwBI,IAAIF,QAAQ,CACtCP,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,wCAAwChB,+DAA0BW,QAAQ,CAAA;IACpF,CAAC;AAEJF,2BAAwBQ,IAAIjB,+DAA0BW,QAAQ,CAAC;;AAGjE,MACER,QAAQG,KAAKC,SAASK,OAAOX,0DAAqB,CAACO,WACnDU,OAAOC,KAAKhB,QAAQG,KAAKc,YAAY,EAAE,CAAC,CAACZ,OAEzCJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,8FACPb,QAAQG,KAAKC,SAASK,OAAOX,0DAAqB,CAACO,OAAM,qDACLL,QAAQG,KAAKC,SAASc,KAAK,IAAI,CAAA,SACnFH,OAAOC,KAAKhB,QAAQG,KAAKc,YAAY,EAAE,CAAC,CAACZ,OAAM;GAElD,CAAC;EAGJ,MAAMc,UAAUnB,QAAQG,KAAKC,SAC1BK,OAAOX,0DAAqB,CAC5BW,QACCD,YACEO,OAAOK,UAAUC,eAAeC,KAC9BtB,QAAQG,KAAKc,YAAY,EAAE,EAC3BpB,+DAA0BW,QAC5B,CAAC,KAAK,MACT;AACH,MAAIW,QAAQd,SAAS,EACnBJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,GAAGM,QAAQd,OAAM,uBAAwBc,QAAQd,SAAS,IAAI,MAAM,GAAE,+BAAgCL,QAAQG,KAAKC,SAASc,KACnI,IACD,CAAA,MAAOC,QAAQd,SAAS,IAAI,KAAK,KAAI,8BACpCc,QAAQd,SAAS,IAAI,QAAQ,IAAG,+CACcc,QAC7CI,KAAIf,YAAW,IAAIX,+DAA0BW,QAAQ,CAAA,GAAI,CACzDU,KAAK,OAAO;GAChB,CAAC;OACG;AACL,QAAK,MAAMM,WAAWT,OAAOC,KAAKhB,QAAQG,KAAKc,YAAY,EAAE,CAAC,CAC5D,KACE,CAACjB,QAAQG,KAAKC,SACXK,OAAOX,0DAAqB,CAC5B2B,MAAKjB,YAAWX,+DAA0BW,QAAQ,KAAKgB,QAAQ,CAElEvB,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,kCACPW,QAAO,2FACmFxB,QAAQG,KAAKC,SAASc,KAChH,IACD,CAAA;IACF,CAAC;AAINlB,WAAQG,KAAKC,SAASsB,SAASlB,SAASmB,UAAU;AAChD,QACE7B,0DAAqBU,QAAQ,IAC7BR,QAAQG,KAAKc,SAASpB,+DAA0BW,QAAQ,GACpDoB,aAAa,QACjBD,QAAQ,IAAI3B,QAAQG,KAAKC,SAASC,UAClCL,QAAQG,KAAKC,SAASuB,QAAQ,MAC9B3B,QAAQG,KAAKc,SACXpB,+DAA0BG,QAAQG,KAAKC,SAASuB,QAAQ,GAAI,GAC3DC,aAAa,KAEhB3B,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,+BAA+BhB,+DACtCW,QACD,CAAA,4BAA6BR,QAAQG,KAAKC,SAASc,KAClD,IACD,CAAA,0FAA2FrB,+DAC1FG,QAAQG,KAAKC,SAASuB,QAAQ,GAC/B,CAAA;KACF,CAAC;KAEJ;;;AAIN,QAAO1B;;AAGT,SAAgB4B,uBACd7B,SACqB;CACrB,MAAMC,WAAgC,EAAE;CAExC,MAAM6B,8BAAc,IAAIvB,KAAa;AACrC,MAAK,MAAMwB,UAAUhB,OAAOiB,OAAOhC,QAAQiC,WAAW,EAAE,CAAC,EAAE;AACzD,MAAIH,YAAYpB,IAAIqB,OAAOG,KAAK,CAC9BjC,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,0BAA0BkB,OAAOG,KAAI;GAC/C,CAAC;AAEJJ,cAAYhB,IAAIiB,OAAOG,KAAK;AAE5B,OAAK,MAAMC,SAASJ,OAAOI,OAAO;AAChC,OAAIL,YAAYpB,IAAIyB,MAAM,CACxBlC,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,0BAA0BsB,MAAK,kBACtCJ,OAAOG,KAAI;IAEd,CAAC;AAEJJ,eAAYhB,IAAIqB,MAAM;;;AAI1B,QAAOlC;;AAGT,SAAgBmC,gBAAgBpC,SAA2C;CACzE,MAAMqC,UAA+B,EAAE;CAEvC,IAAIpC,WAAWF,4BAA4BC,QAAQ;AACnD,KAAIC,SAASI,SAAS,EACpBgC,SAAQ1B,KAAK,GAAGV,SAAS;AAG3BA,YAAW4B,uBAAuB7B,QAAQ;AAC1C,KAAIC,SAASI,SAAS,EACpBgC,SAAQ1B,KAAK,GAAGV,SAAS;AAG3B,QAAOoC"}
|
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { getDynamicPathSegmentName, isDynamicPathSegment } from "../plugin-utils/context-helpers.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/helpers/validations.ts
|
|
4
|
-
function
|
|
4
|
+
function validateDynamicPathSegments(command) {
|
|
5
5
|
const failures = [];
|
|
6
6
|
if (!command.isVirtual && command.path.segments.length > 0) {
|
|
7
|
-
const
|
|
8
|
-
for (const segment of command.path.segments.filter(
|
|
9
|
-
if (
|
|
10
|
-
code: "
|
|
11
|
-
details: `Duplicate
|
|
7
|
+
const dynamicPathSegmentNames = /* @__PURE__ */ new Set();
|
|
8
|
+
for (const segment of command.path.segments.filter(isDynamicPathSegment) ?? []) {
|
|
9
|
+
if (dynamicPathSegmentNames.has(segment)) failures.push({
|
|
10
|
+
code: "DUPLICATE_DYNAMIC_PATH_SEGMENT_NAME",
|
|
11
|
+
details: `Duplicate dynamic path segment name "${getDynamicPathSegmentName(segment)}" found in command.`
|
|
12
12
|
});
|
|
13
|
-
|
|
13
|
+
dynamicPathSegmentNames.add(getDynamicPathSegmentName(segment));
|
|
14
14
|
}
|
|
15
|
-
if (command.path.segments.filter(
|
|
16
|
-
code: "
|
|
17
|
-
details: `Mismatch between
|
|
15
|
+
if (command.path.segments.filter(isDynamicPathSegment).length !== Object.keys(command.path.dynamics ?? {}).length) failures.push({
|
|
16
|
+
code: "DYNAMIC_PATH_SEGMENT_MISMATCH",
|
|
17
|
+
details: `Mismatch between dynamic path segments and defined dynamic path segments in command (found ${command.path.segments.filter(isDynamicPathSegment).length} dynamic path segments in the command folder path "${command.path.segments.join("/")}", but ${Object.keys(command.path.dynamics ?? {}).length} potential dynamic path segment(s) could be determined from the command's function signature).`
|
|
18
18
|
});
|
|
19
|
-
const missing = command.path.segments.filter(
|
|
19
|
+
const missing = command.path.segments.filter(isDynamicPathSegment).filter((segment) => Object.prototype.hasOwnProperty.call(command.path.dynamics ?? {}, getDynamicPathSegmentName(segment)) === false);
|
|
20
20
|
if (missing.length > 0) failures.push({
|
|
21
|
-
code: "
|
|
22
|
-
details: `${missing.length}
|
|
21
|
+
code: "MISSING_DYNAMIC_PATH_SEGMENT_DEFINITION",
|
|
22
|
+
details: `${missing.length} dynamic path segment${missing.length > 1 ? "s" : ""} in the command folder path "${command.path.segments.join("/")}" do${missing.length > 1 ? "" : "es"} not have corresponding entr${missing.length > 1 ? "ies" : "y"} in the command's path dynamic segments: \n- ${missing.map((segment) => `"${getDynamicPathSegmentName(segment)}"`).join("\n- ")}`
|
|
23
23
|
});
|
|
24
24
|
else {
|
|
25
|
-
for (const varName of Object.keys(command.path.
|
|
26
|
-
code: "
|
|
27
|
-
details: `The
|
|
25
|
+
for (const varName of Object.keys(command.path.dynamics ?? {})) if (!command.path.segments.filter(isDynamicPathSegment).find((segment) => getDynamicPathSegmentName(segment) === varName)) failures.push({
|
|
26
|
+
code: "UNUSED_DYNAMIC_PATH_SEGMENT",
|
|
27
|
+
details: `The dynamic path segment name "${varName}" defined in the command's path dynamic segments is not used in the command folder path "${command.path.segments.join("/")}".`
|
|
28
28
|
});
|
|
29
29
|
command.path.segments.forEach((segment, index) => {
|
|
30
|
-
if (
|
|
31
|
-
code: "
|
|
32
|
-
details: `The
|
|
30
|
+
if (isDynamicPathSegment(segment) && command.path.dynamics[getDynamicPathSegmentName(segment)]?.catchAll === true && index + 1 < command.path.segments.length && command.path.segments[index + 1] && command.path.dynamics[getDynamicPathSegmentName(command.path.segments[index + 1])]?.catchAll === true) failures.push({
|
|
31
|
+
code: "MULTIPLE_CATCH_ALL_PATH_SEGMENTS",
|
|
32
|
+
details: `The catch-all path segment "${getDynamicPathSegmentName(segment)}" in the command at path "${command.path.segments.join("/")}" is marked as catch-all, and it is followed by another catch-all dynamic path segment "${getDynamicPathSegmentName(command.path.segments[index + 1])}". Only one catch-all path segment is allowed per command, and it must be the final path segment.`
|
|
33
33
|
});
|
|
34
34
|
});
|
|
35
35
|
}
|
|
@@ -57,7 +57,7 @@ function validateCommandOptions(command) {
|
|
|
57
57
|
}
|
|
58
58
|
function validateCommand(command) {
|
|
59
59
|
const results = [];
|
|
60
|
-
let failures =
|
|
60
|
+
let failures = validateDynamicPathSegments(command);
|
|
61
61
|
if (failures.length > 0) results.push(...failures);
|
|
62
62
|
failures = validateCommandOptions(command);
|
|
63
63
|
if (failures.length > 0) results.push(...failures);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validations.mjs","names":["
|
|
1
|
+
{"version":3,"file":"validations.mjs","names":["getDynamicPathSegmentName","isDynamicPathSegment","validateDynamicPathSegments","command","failures","isVirtual","path","segments","length","dynamicPathSegmentNames","Set","segment","filter","has","push","code","details","add","Object","keys","dynamics","join","missing","prototype","hasOwnProperty","call","map","varName","find","forEach","index","catchAll","validateCommandOptions","optionNames","option","values","options","name","alias","validateCommand","results"],"sources":["../../src/helpers/validations.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n getDynamicPathSegmentName,\n isDynamicPathSegment\n} from \"../plugin-utils/context-helpers\";\nimport type { CommandTree } from \"../types\";\n\nexport interface ValidationFailure {\n code: string;\n details: string;\n}\n\nexport function validateDynamicPathSegments(\n command: CommandTree\n): ValidationFailure[] {\n const failures: ValidationFailure[] = [];\n if (!command.isVirtual && command.path.segments.length > 0) {\n const dynamicPathSegmentNames = new Set<string>();\n for (const segment of command.path.segments.filter(isDynamicPathSegment) ??\n []) {\n if (dynamicPathSegmentNames.has(segment)) {\n failures.push({\n code: \"DUPLICATE_DYNAMIC_PATH_SEGMENT_NAME\",\n details: `Duplicate dynamic path segment name \"${getDynamicPathSegmentName(segment)}\" found in command.`\n });\n }\n dynamicPathSegmentNames.add(getDynamicPathSegmentName(segment));\n }\n\n if (\n command.path.segments.filter(isDynamicPathSegment).length !==\n Object.keys(command.path.dynamics ?? {}).length\n ) {\n failures.push({\n code: \"DYNAMIC_PATH_SEGMENT_MISMATCH\",\n details: `Mismatch between dynamic path segments and defined dynamic path segments in command (found ${\n command.path.segments.filter(isDynamicPathSegment).length\n } dynamic path segments in the command folder path \"${command.path.segments.join(\"/\")}\", but ${\n Object.keys(command.path.dynamics ?? {}).length\n } potential dynamic path segment(s) could be determined from the command's function signature).`\n });\n }\n\n const missing = command.path.segments\n .filter(isDynamicPathSegment)\n .filter(\n segment =>\n Object.prototype.hasOwnProperty.call(\n command.path.dynamics ?? {},\n getDynamicPathSegmentName(segment)\n ) === false\n );\n if (missing.length > 0) {\n failures.push({\n code: \"MISSING_DYNAMIC_PATH_SEGMENT_DEFINITION\",\n details: `${missing.length} dynamic path segment${missing.length > 1 ? \"s\" : \"\"} in the command folder path \"${command.path.segments.join(\n \"/\"\n )}\" do${missing.length > 1 ? \"\" : \"es\"} not have corresponding entr${\n missing.length > 1 ? \"ies\" : \"y\"\n } in the command's path dynamic segments: \\n- ${missing\n .map(segment => `\"${getDynamicPathSegmentName(segment)}\"`)\n .join(\"\\n- \")}`\n });\n } else {\n for (const varName of Object.keys(command.path.dynamics ?? {})) {\n if (\n !command.path.segments\n .filter(isDynamicPathSegment)\n .find(segment => getDynamicPathSegmentName(segment) === varName)\n ) {\n failures.push({\n code: \"UNUSED_DYNAMIC_PATH_SEGMENT\",\n details: `The dynamic path segment name \"${\n varName\n }\" defined in the command's path dynamic segments is not used in the command folder path \"${command.path.segments.join(\n \"/\"\n )}\".`\n });\n }\n }\n\n command.path.segments.forEach((segment, index) => {\n if (\n isDynamicPathSegment(segment) &&\n command.path.dynamics[getDynamicPathSegmentName(segment)]\n ?.catchAll === true &&\n index + 1 < command.path.segments.length &&\n command.path.segments[index + 1] &&\n command.path.dynamics[\n getDynamicPathSegmentName(command.path.segments[index + 1]!)\n ]?.catchAll === true\n ) {\n failures.push({\n code: \"MULTIPLE_CATCH_ALL_PATH_SEGMENTS\",\n details: `The catch-all path segment \"${getDynamicPathSegmentName(\n segment\n )}\" in the command at path \"${command.path.segments.join(\n \"/\"\n )}\" is marked as catch-all, and it is followed by another catch-all dynamic path segment \"${getDynamicPathSegmentName(\n command.path.segments[index + 1]!\n )}\". Only one catch-all path segment is allowed per command, and it must be the final path segment.`\n });\n }\n });\n }\n }\n\n return failures;\n}\n\nexport function validateCommandOptions(\n command: CommandTree\n): ValidationFailure[] {\n const failures: ValidationFailure[] = [];\n\n const optionNames = new Set<string>();\n for (const option of Object.values(command.options ?? {})) {\n if (optionNames.has(option.name)) {\n failures.push({\n code: \"DUPLICATE_OPTION_NAME\",\n details: `Duplicate option name \"${option.name}\" found in command.`\n });\n }\n optionNames.add(option.name);\n\n for (const alias of option.alias) {\n if (optionNames.has(alias)) {\n failures.push({\n code: \"DUPLICATE_OPTION_ALIAS\",\n details: `Duplicate option name \"${alias}\" (an alias of \"${\n option.name\n }\") found in command.`\n });\n }\n optionNames.add(alias);\n }\n }\n\n return failures;\n}\n\nexport function validateCommand(command: CommandTree): ValidationFailure[] {\n const results: ValidationFailure[] = [];\n\n let failures = validateDynamicPathSegments(command);\n if (failures.length > 0) {\n results.push(...failures);\n }\n\n failures = validateCommandOptions(command);\n if (failures.length > 0) {\n results.push(...failures);\n }\n\n return results;\n}\n"],"mappings":";;;AA6BA,SAAgBE,4BACdC,SACqB;CACrB,MAAMC,WAAgC,EAAE;AACxC,KAAI,CAACD,QAAQE,aAAaF,QAAQG,KAAKC,SAASC,SAAS,GAAG;EAC1D,MAAMC,0CAA0B,IAAIC,KAAa;AACjD,OAAK,MAAMC,WAAWR,QAAQG,KAAKC,SAASK,OAAOX,qBAAqB,IACtE,EAAE,EAAE;AACJ,OAAIQ,wBAAwBI,IAAIF,QAAQ,CACtCP,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,wCAAwChB,0BAA0BW,QAAQ,CAAA;IACpF,CAAC;AAEJF,2BAAwBQ,IAAIjB,0BAA0BW,QAAQ,CAAC;;AAGjE,MACER,QAAQG,KAAKC,SAASK,OAAOX,qBAAqB,CAACO,WACnDU,OAAOC,KAAKhB,QAAQG,KAAKc,YAAY,EAAE,CAAC,CAACZ,OAEzCJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,8FACPb,QAAQG,KAAKC,SAASK,OAAOX,qBAAqB,CAACO,OAAM,qDACLL,QAAQG,KAAKC,SAASc,KAAK,IAAI,CAAA,SACnFH,OAAOC,KAAKhB,QAAQG,KAAKc,YAAY,EAAE,CAAC,CAACZ,OAAM;GAElD,CAAC;EAGJ,MAAMc,UAAUnB,QAAQG,KAAKC,SAC1BK,OAAOX,qBAAqB,CAC5BW,QACCD,YACEO,OAAOK,UAAUC,eAAeC,KAC9BtB,QAAQG,KAAKc,YAAY,EAAE,EAC3BpB,0BAA0BW,QAC5B,CAAC,KAAK,MACT;AACH,MAAIW,QAAQd,SAAS,EACnBJ,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,GAAGM,QAAQd,OAAM,uBAAwBc,QAAQd,SAAS,IAAI,MAAM,GAAE,+BAAgCL,QAAQG,KAAKC,SAASc,KACnI,IACD,CAAA,MAAOC,QAAQd,SAAS,IAAI,KAAK,KAAI,8BACpCc,QAAQd,SAAS,IAAI,QAAQ,IAAG,+CACcc,QAC7CI,KAAIf,YAAW,IAAIX,0BAA0BW,QAAQ,CAAA,GAAI,CACzDU,KAAK,OAAO;GAChB,CAAC;OACG;AACL,QAAK,MAAMM,WAAWT,OAAOC,KAAKhB,QAAQG,KAAKc,YAAY,EAAE,CAAC,CAC5D,KACE,CAACjB,QAAQG,KAAKC,SACXK,OAAOX,qBAAqB,CAC5B2B,MAAKjB,YAAWX,0BAA0BW,QAAQ,KAAKgB,QAAQ,CAElEvB,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,kCACPW,QAAO,2FACmFxB,QAAQG,KAAKC,SAASc,KAChH,IACD,CAAA;IACF,CAAC;AAINlB,WAAQG,KAAKC,SAASsB,SAASlB,SAASmB,UAAU;AAChD,QACE7B,qBAAqBU,QAAQ,IAC7BR,QAAQG,KAAKc,SAASpB,0BAA0BW,QAAQ,GACpDoB,aAAa,QACjBD,QAAQ,IAAI3B,QAAQG,KAAKC,SAASC,UAClCL,QAAQG,KAAKC,SAASuB,QAAQ,MAC9B3B,QAAQG,KAAKc,SACXpB,0BAA0BG,QAAQG,KAAKC,SAASuB,QAAQ,GAAI,GAC3DC,aAAa,KAEhB3B,UAASU,KAAK;KACZC,MAAM;KACNC,SAAS,+BAA+BhB,0BACtCW,QACD,CAAA,4BAA6BR,QAAQG,KAAKC,SAASc,KAClD,IACD,CAAA,0FAA2FrB,0BAC1FG,QAAQG,KAAKC,SAASuB,QAAQ,GAC/B,CAAA;KACF,CAAC;KAEJ;;;AAIN,QAAO1B;;AAGT,SAAgB4B,uBACd7B,SACqB;CACrB,MAAMC,WAAgC,EAAE;CAExC,MAAM6B,8BAAc,IAAIvB,KAAa;AACrC,MAAK,MAAMwB,UAAUhB,OAAOiB,OAAOhC,QAAQiC,WAAW,EAAE,CAAC,EAAE;AACzD,MAAIH,YAAYpB,IAAIqB,OAAOG,KAAK,CAC9BjC,UAASU,KAAK;GACZC,MAAM;GACNC,SAAS,0BAA0BkB,OAAOG,KAAI;GAC/C,CAAC;AAEJJ,cAAYhB,IAAIiB,OAAOG,KAAK;AAE5B,OAAK,MAAMC,SAASJ,OAAOI,OAAO;AAChC,OAAIL,YAAYpB,IAAIyB,MAAM,CACxBlC,UAASU,KAAK;IACZC,MAAM;IACNC,SAAS,0BAA0BsB,MAAK,kBACtCJ,OAAOG,KAAI;IAEd,CAAC;AAEJJ,eAAYhB,IAAIqB,MAAM;;;AAI1B,QAAOlC;;AAGT,SAAgBmC,gBAAgBpC,SAA2C;CACzE,MAAMqC,UAA+B,EAAE;CAEvC,IAAIpC,WAAWF,4BAA4BC,QAAQ;AACnD,KAAIC,SAASI,SAAS,EACpBgC,SAAQ1B,KAAK,GAAGV,SAAS;AAG3BA,YAAW4B,uBAAuB7B,QAAQ;AAC1C,KAAIC,SAASI,SAAS,EACpBgC,SAAQ1B,KAAK,GAAGV,SAAS;AAG3B,QAAOoC"}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BaseCommandArgument, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandParameter, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, SerializedCommandDynamicSegment, SerializedCommandOption, SerializedCommandParameter, SerializedCommandTree, SerializedCommandTreePath, StringCommandArgument, StringCommandOption, StringCommandParameter } from "./types/command.cjs";
|
|
2
2
|
import { Context, UnresolvedContext } from "./types/context.cjs";
|
|
3
3
|
import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./types/config.cjs";
|
|
4
4
|
import { ShellShockAPI, createShellShock } from "./api.cjs";
|
|
@@ -6,4 +6,4 @@ import { defineConfig } from "./config.cjs";
|
|
|
6
6
|
import { BaseCommandOptions } from "./types/options.cjs";
|
|
7
7
|
import "./types/index.cjs";
|
|
8
8
|
import plugin from "./plugin.cjs";
|
|
9
|
-
export {
|
|
9
|
+
export { BaseCommandArgument, BaseCommandOptions, BaseConfig, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandParameter, CommandPath, CommandTree, CommandTreePath, Context, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, Options, OutputConfig, ResolvedConfig, SerializedCommandDynamicSegment, SerializedCommandOption, SerializedCommandParameter, SerializedCommandTree, SerializedCommandTreePath, ShellShockAPI, ShellShockAPI as default, StringCommandArgument, StringCommandOption, StringCommandParameter, UnresolvedContext, UserConfig, createShellShock, defineConfig, plugin, plugin as shellShock };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BaseCommandArgument, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandParameter, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, SerializedCommandDynamicSegment, SerializedCommandOption, SerializedCommandParameter, SerializedCommandTree, SerializedCommandTreePath, StringCommandArgument, StringCommandOption, StringCommandParameter } from "./types/command.mjs";
|
|
2
2
|
import { Context, UnresolvedContext } from "./types/context.mjs";
|
|
3
3
|
import { BaseConfig, Options, OutputConfig, ResolvedConfig, UserConfig } from "./types/config.mjs";
|
|
4
4
|
import { ShellShockAPI, createShellShock } from "./api.mjs";
|
|
@@ -6,4 +6,4 @@ import { defineConfig } from "./config.mjs";
|
|
|
6
6
|
import { BaseCommandOptions } from "./types/options.mjs";
|
|
7
7
|
import "./types/index.mjs";
|
|
8
8
|
import plugin from "./plugin.mjs";
|
|
9
|
-
export {
|
|
9
|
+
export { BaseCommandArgument, BaseCommandOptions, BaseConfig, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandParameter, CommandPath, CommandTree, CommandTreePath, Context, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, Options, OutputConfig, ResolvedConfig, SerializedCommandDynamicSegment, SerializedCommandOption, SerializedCommandParameter, SerializedCommandTree, SerializedCommandTreePath, ShellShockAPI, ShellShockAPI as default, StringCommandArgument, StringCommandOption, StringCommandParameter, UnresolvedContext, UserConfig, createShellShock, defineConfig, plugin, plugin as shellShock };
|
|
@@ -59,28 +59,129 @@ function getAppBin(context) {
|
|
|
59
59
|
/**
|
|
60
60
|
* Determines if a given command path segment is variable (enclosed in square brackets).
|
|
61
61
|
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```typescript
|
|
64
|
+
* isDynamicPathSegment("[user]"); // true
|
|
65
|
+
* isDynamicPathSegment("user"); // false
|
|
66
|
+
* isDynamicPathSegment("[[...user]]"); // true
|
|
67
|
+
* isDynamicPathSegment("[...user]"); // true
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
62
70
|
* @param path - The command path segment to check.
|
|
63
71
|
* @returns True if the path is variable, false otherwise.
|
|
64
72
|
*/
|
|
65
|
-
function
|
|
73
|
+
function isDynamicPathSegment(path) {
|
|
66
74
|
return path.startsWith("[") && path.endsWith("]");
|
|
67
75
|
}
|
|
68
76
|
/**
|
|
77
|
+
* Determines if a given command path segment is an optional catch-all segment (enclosed in square brackets with a leading ellipsis).
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```typescript
|
|
81
|
+
* isOptionalCatchAllPathSegment("[[...user]]"); // true
|
|
82
|
+
* isOptionalCatchAllPathSegment("[...user]"); // false
|
|
83
|
+
* isOptionalCatchAllPathSegment("[user]"); // false
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* @param path - The command path segment to check.
|
|
87
|
+
* @returns True if the path is an optional catch-all segment, false otherwise.
|
|
88
|
+
*/
|
|
89
|
+
function isOptionalCatchAllPathSegment(path) {
|
|
90
|
+
return path.startsWith("[[...") && path.endsWith("]]");
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Determines if a given command path segment is an optional catch-all segment (enclosed in square brackets with a leading ellipsis).
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```typescript
|
|
97
|
+
* isCatchAllPathSegment("[[...user]]"); // true
|
|
98
|
+
* isCatchAllPathSegment("[...user]"); // true
|
|
99
|
+
* isCatchAllPathSegment("[user]"); // false
|
|
100
|
+
* ```
|
|
101
|
+
*
|
|
102
|
+
* @param path - The command path segment to check.
|
|
103
|
+
* @returns True if the path is a catch-all segment, false otherwise.
|
|
104
|
+
*/
|
|
105
|
+
function isCatchAllPathSegment(path) {
|
|
106
|
+
return path.startsWith("[...") && path.endsWith("]") || isOptionalCatchAllPathSegment(path);
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
69
109
|
* Extracts the variable name from a command path segment by removing enclosing square brackets.
|
|
70
110
|
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```typescript
|
|
113
|
+
* getDynamicPathSegmentName("[user]"); // "user"
|
|
114
|
+
* getDynamicPathSegmentName("[[...user]]"); // "user"
|
|
115
|
+
* getDynamicPathSegmentName("[...user]"); // "user"
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
71
118
|
* @param path - The command path segment.
|
|
72
119
|
* @returns The variable name without square brackets.
|
|
73
120
|
*/
|
|
74
|
-
function
|
|
121
|
+
function getDynamicPathSegmentName(path) {
|
|
75
122
|
return path.replaceAll(/^\[+(?:\.\.\.)*/g, "").replaceAll(/\]+$/g, "");
|
|
76
123
|
}
|
|
124
|
+
/**
|
|
125
|
+
* Determines if a given command path segment is a path segment group (enclosed in parentheses).
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```typescript
|
|
129
|
+
* isPathSegmentGroup("(user)"); // true
|
|
130
|
+
* isPathSegmentGroup("[[...user]]"); // false
|
|
131
|
+
* isPathSegmentGroup("[...user]"); // false
|
|
132
|
+
* isPathSegmentGroup("[user]"); // false
|
|
133
|
+
* isPathSegmentGroup("user"); // false
|
|
134
|
+
* ```
|
|
135
|
+
*
|
|
136
|
+
* @param path - The command path segment to check.
|
|
137
|
+
* @returns True if the path is a path segment group, false otherwise.
|
|
138
|
+
*/
|
|
139
|
+
function isPathSegmentGroup(path) {
|
|
140
|
+
return path.startsWith("(") && path.endsWith(")");
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Extracts the group name from a command path segment by removing enclosing parentheses.
|
|
144
|
+
*
|
|
145
|
+
* @example
|
|
146
|
+
* ```typescript
|
|
147
|
+
* getPathSegmentGroupName("(admin)"); // "admin"
|
|
148
|
+
* getPathSegmentGroupName("((group))"); // "group"
|
|
149
|
+
* ```
|
|
150
|
+
*
|
|
151
|
+
* @param path - The command path segment.
|
|
152
|
+
* @returns The group name without parentheses.
|
|
153
|
+
*/
|
|
154
|
+
function getPathSegmentGroupName(path) {
|
|
155
|
+
return path.replaceAll(/^\(+/g, "").replaceAll(/\)+$/g, "");
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Extracts the variable name from a command path segment by removing enclosing square brackets.
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* ```typescript
|
|
162
|
+
* getDynamicPathSegmentName("[user]"); // "user"
|
|
163
|
+
* getDynamicPathSegmentName("[[...user]]"); // "user"
|
|
164
|
+
* getDynamicPathSegmentName("[...user]"); // "user"
|
|
165
|
+
* ```
|
|
166
|
+
*
|
|
167
|
+
* @param path - The command path segment.
|
|
168
|
+
* @returns The variable name without square brackets.
|
|
169
|
+
*/
|
|
170
|
+
function getPathSegmentName(path) {
|
|
171
|
+
return getPathSegmentGroupName(getDynamicPathSegmentName(path));
|
|
172
|
+
}
|
|
77
173
|
|
|
78
174
|
//#endregion
|
|
79
175
|
exports.getAppBin = getAppBin;
|
|
80
176
|
exports.getAppDescription = getAppDescription;
|
|
81
177
|
exports.getAppName = getAppName;
|
|
82
178
|
exports.getAppTitle = getAppTitle;
|
|
83
|
-
exports.
|
|
84
|
-
exports.
|
|
179
|
+
exports.getDynamicPathSegmentName = getDynamicPathSegmentName;
|
|
180
|
+
exports.getPathSegmentGroupName = getPathSegmentGroupName;
|
|
181
|
+
exports.getPathSegmentName = getPathSegmentName;
|
|
182
|
+
exports.isCatchAllPathSegment = isCatchAllPathSegment;
|
|
183
|
+
exports.isDynamicPathSegment = isDynamicPathSegment;
|
|
184
|
+
exports.isOptionalCatchAllPathSegment = isOptionalCatchAllPathSegment;
|
|
185
|
+
exports.isPathSegmentGroup = isPathSegmentGroup;
|
|
85
186
|
exports.sortArgAliases = sortArgAliases;
|
|
86
187
|
//# sourceMappingURL=context-helpers.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"context-helpers.cjs","names":["kebabCase","titleCase","isSetObject","isSetString","sortArgAliases","aliases","length","result","filter","alias","push","sort","a","b","localeCompare","getAppName","context","config","name","bin","Array","isArray","packageJson","Error","getAppTitle","title","getAppDescription","description","getAppBin","Object","keys","isPositionalCommandOption","path","startsWith","endsWith","getPositionalCommandOptionName","replaceAll"],"sources":["../../src/plugin-utils/context-helpers.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport type { Context, UnresolvedContext } from \"../types\";\n\n/**\n * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.\n *\n * @param aliases - An array of argument aliases to sort.\n * @returns A new array of sorted aliases.\n */\nexport function sortArgAliases(aliases: string[]): string[] {\n if (aliases.length === 0) {\n return [];\n }\n\n const result = aliases.filter(alias => alias.length === 1);\n result.push(...aliases.filter(alias => alias.length > 1));\n\n return result.sort((a, b) => a.localeCompare(b));\n}\n\n/**\n * Retrieves the application name from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application name in kebab-case format.\n * @throws An error if no valid application name is found.\n */\nexport function getAppName(context: UnresolvedContext | Context): string {\n const result =\n context.config.name ||\n (isSetString(context.config.bin) ||\n (Array.isArray(context.config.bin) &&\n context.config.bin.length > 0 &&\n isSetString(context.config.bin[0]))\n ? isSetString(context.config.bin)\n ? context.config.bin\n : context.config.bin[0]\n : context.packageJson?.name);\n if (!isSetString(result)) {\n throw new Error(\n \"No application name found. Please provide a 'bin' option in the configuration or ensure the package.json has a valid 'name' field.\"\n );\n }\n\n return kebabCase(result);\n}\n\n/**\n * Retrieves the application title from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application title in title-case format.\n */\nexport function getAppTitle(context: UnresolvedContext | Context): string {\n return (\n context.config.title ||\n titleCase(context.config.name || getAppName(context))\n );\n}\n\n/**\n * Retrieves the application description from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application description.\n */\nexport function getAppDescription(\n context: UnresolvedContext | Context\n): string {\n return (\n context.config.description ||\n context.packageJson?.description ||\n `The ${getAppTitle(context)} command-line interface application.`\n );\n}\n\n/**\n * Retrieves the primary binary name for the application.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The primary binary name as a string.\n */\nexport function getAppBin(context: Context): string {\n return isSetObject(context.config.bin)\n ? Object.keys(context.config.bin)[0]!\n : kebabCase(getAppName(context));\n}\n\n/**\n * Determines if a given command path segment is variable (enclosed in square brackets).\n *\n * @param path - The command path segment to check.\n * @returns True if the path is variable, false otherwise.\n */\nexport function isPositionalCommandOption(path: string): boolean {\n return path.startsWith(\"[\") && path.endsWith(\"]\");\n}\n\n/**\n * Extracts the variable name from a command path segment by removing enclosing square brackets.\n *\n * @param path - The command path segment.\n * @returns The variable name without square brackets.\n */\nexport function getPositionalCommandOptionName(path: string): string {\n return path.replaceAll(/^\\[+(?:\\.\\.\\.)*/g, \"\").replaceAll(/\\]+$/g, \"\");\n}\n"],"mappings":";;;;;;;;;;;;;AA8BA,SAAgBI,eAAeC,SAA6B;AAC1D,KAAIA,QAAQC,WAAW,EACrB,QAAO,EAAE;CAGX,MAAMC,SAASF,QAAQG,QAAOC,UAASA,MAAMH,WAAW,EAAE;AAC1DC,QAAOG,KAAK,GAAGL,QAAQG,QAAOC,UAASA,MAAMH,SAAS,EAAE,CAAC;AAEzD,QAAOC,OAAOI,MAAMC,GAAGC,MAAMD,EAAEE,cAAcD,EAAE,CAAC;;;;;;;;;AAUlD,SAAgBE,WAAWC,SAA8C;CACvE,MAAMT,SACJS,QAAQC,OAAOC,6DACFF,QAAQC,OAAOE,IAAI,IAC/BC,MAAMC,QAAQL,QAAQC,OAAOE,IAAI,IAChCH,QAAQC,OAAOE,IAAIb,SAAS,yDAChBU,QAAQC,OAAOE,IAAI,GAAI,uDACrBH,QAAQC,OAAOE,IAAI,GAC7BH,QAAQC,OAAOE,MACfH,QAAQC,OAAOE,IAAI,KACrBH,QAAQM,aAAaJ;AAC3B,KAAI,qDAAaX,OAAO,CACtB,OAAM,IAAIgB,MACR,qIACD;AAGH,yDAAiBhB,OAAO;;;;;;;;AAS1B,SAAgBiB,YAAYR,SAA8C;AACxE,QACEA,QAAQC,OAAOQ,0DACLT,QAAQC,OAAOC,QAAQH,WAAWC,QAAQ,CAAC;;;;;;;;AAUzD,SAAgBU,kBACdV,SACQ;AACR,QACEA,QAAQC,OAAOU,eACfX,QAAQM,aAAaK,eACrB,OAAOH,YAAYR,QAAQ,CAAA;;;;;;;;AAU/B,SAAgBY,UAAUZ,SAA0B;AAClD,4DAAmBA,QAAQC,OAAOE,IAAI,GAClCU,OAAOC,KAAKd,QAAQC,OAAOE,IAAI,CAAC,sDACtBJ,WAAWC,QAAQ,CAAC;;;;;;;;AASpC,SAAgBe,0BAA0BC,MAAuB;AAC/D,QAAOA,KAAKC,WAAW,IAAI,IAAID,KAAKE,SAAS,IAAI;;;;;;;;AASnD,SAAgBC,+BAA+BH,MAAsB;AACnE,QAAOA,KAAKI,WAAW,oBAAoB,GAAG,CAACA,WAAW,SAAS,GAAG"}
|
|
1
|
+
{"version":3,"file":"context-helpers.cjs","names":["kebabCase","titleCase","isSetObject","isSetString","sortArgAliases","aliases","length","result","filter","alias","push","sort","a","b","localeCompare","getAppName","context","config","name","bin","Array","isArray","packageJson","Error","getAppTitle","title","getAppDescription","description","getAppBin","Object","keys","isDynamicPathSegment","path","startsWith","endsWith","isOptionalCatchAllPathSegment","isCatchAllPathSegment","getDynamicPathSegmentName","replaceAll","isPathSegmentGroup","getPathSegmentGroupName","getPathSegmentName"],"sources":["../../src/plugin-utils/context-helpers.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport type { Context, UnresolvedContext } from \"../types\";\n\n/**\n * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.\n *\n * @param aliases - An array of argument aliases to sort.\n * @returns A new array of sorted aliases.\n */\nexport function sortArgAliases(aliases: string[]): string[] {\n if (aliases.length === 0) {\n return [];\n }\n\n const result = aliases.filter(alias => alias.length === 1);\n result.push(...aliases.filter(alias => alias.length > 1));\n\n return result.sort((a, b) => a.localeCompare(b));\n}\n\n/**\n * Retrieves the application name from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application name in kebab-case format.\n * @throws An error if no valid application name is found.\n */\nexport function getAppName(context: UnresolvedContext | Context): string {\n const result =\n context.config.name ||\n (isSetString(context.config.bin) ||\n (Array.isArray(context.config.bin) &&\n context.config.bin.length > 0 &&\n isSetString(context.config.bin[0]))\n ? isSetString(context.config.bin)\n ? context.config.bin\n : context.config.bin[0]\n : context.packageJson?.name);\n if (!isSetString(result)) {\n throw new Error(\n \"No application name found. Please provide a 'bin' option in the configuration or ensure the package.json has a valid 'name' field.\"\n );\n }\n\n return kebabCase(result);\n}\n\n/**\n * Retrieves the application title from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application title in title-case format.\n */\nexport function getAppTitle(context: UnresolvedContext | Context): string {\n return (\n context.config.title ||\n titleCase(context.config.name || getAppName(context))\n );\n}\n\n/**\n * Retrieves the application description from the context and configuration.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The application description.\n */\nexport function getAppDescription(\n context: UnresolvedContext | Context\n): string {\n return (\n context.config.description ||\n context.packageJson?.description ||\n `The ${getAppTitle(context)} command-line interface application.`\n );\n}\n\n/**\n * Retrieves the primary binary name for the application.\n *\n * @param context - The build context containing workspace and package information.\n * @returns The primary binary name as a string.\n */\nexport function getAppBin(context: Context): string {\n return isSetObject(context.config.bin)\n ? Object.keys(context.config.bin)[0]!\n : kebabCase(getAppName(context));\n}\n\n/**\n * Determines if a given command path segment is variable (enclosed in square brackets).\n *\n * @example\n * ```typescript\n * isDynamicPathSegment(\"[user]\"); // true\n * isDynamicPathSegment(\"user\"); // false\n * isDynamicPathSegment(\"[[...user]]\"); // true\n * isDynamicPathSegment(\"[...user]\"); // true\n * ```\n *\n * @param path - The command path segment to check.\n * @returns True if the path is variable, false otherwise.\n */\nexport function isDynamicPathSegment(path: string): boolean {\n return path.startsWith(\"[\") && path.endsWith(\"]\");\n}\n\n/**\n * Determines if a given command path segment is an optional catch-all segment (enclosed in square brackets with a leading ellipsis).\n *\n * @example\n * ```typescript\n * isOptionalCatchAllPathSegment(\"[[...user]]\"); // true\n * isOptionalCatchAllPathSegment(\"[...user]\"); // false\n * isOptionalCatchAllPathSegment(\"[user]\"); // false\n * ```\n *\n * @param path - The command path segment to check.\n * @returns True if the path is an optional catch-all segment, false otherwise.\n */\nexport function isOptionalCatchAllPathSegment(path: string): boolean {\n return path.startsWith(\"[[...\") && path.endsWith(\"]]\");\n}\n\n/**\n * Determines if a given command path segment is an optional catch-all segment (enclosed in square brackets with a leading ellipsis).\n *\n * @example\n * ```typescript\n * isCatchAllPathSegment(\"[[...user]]\"); // true\n * isCatchAllPathSegment(\"[...user]\"); // true\n * isCatchAllPathSegment(\"[user]\"); // false\n * ```\n *\n * @param path - The command path segment to check.\n * @returns True if the path is a catch-all segment, false otherwise.\n */\nexport function isCatchAllPathSegment(path: string): boolean {\n return (\n (path.startsWith(\"[...\") && path.endsWith(\"]\")) ||\n isOptionalCatchAllPathSegment(path)\n );\n}\n\n/**\n * Extracts the variable name from a command path segment by removing enclosing square brackets.\n *\n * @example\n * ```typescript\n * getDynamicPathSegmentName(\"[user]\"); // \"user\"\n * getDynamicPathSegmentName(\"[[...user]]\"); // \"user\"\n * getDynamicPathSegmentName(\"[...user]\"); // \"user\"\n * ```\n *\n * @param path - The command path segment.\n * @returns The variable name without square brackets.\n */\nexport function getDynamicPathSegmentName(path: string): string {\n return path.replaceAll(/^\\[+(?:\\.\\.\\.)*/g, \"\").replaceAll(/\\]+$/g, \"\");\n}\n\n/**\n * Determines if a given command path segment is a path segment group (enclosed in parentheses).\n *\n * @example\n * ```typescript\n * isPathSegmentGroup(\"(user)\"); // true\n * isPathSegmentGroup(\"[[...user]]\"); // false\n * isPathSegmentGroup(\"[...user]\"); // false\n * isPathSegmentGroup(\"[user]\"); // false\n * isPathSegmentGroup(\"user\"); // false\n * ```\n *\n * @param path - The command path segment to check.\n * @returns True if the path is a path segment group, false otherwise.\n */\nexport function isPathSegmentGroup(path: string): boolean {\n return path.startsWith(\"(\") && path.endsWith(\")\");\n}\n\n/**\n * Extracts the group name from a command path segment by removing enclosing parentheses.\n *\n * @example\n * ```typescript\n * getPathSegmentGroupName(\"(admin)\"); // \"admin\"\n * getPathSegmentGroupName(\"((group))\"); // \"group\"\n * ```\n *\n * @param path - The command path segment.\n * @returns The group name without parentheses.\n */\nexport function getPathSegmentGroupName(path: string): string {\n return path.replaceAll(/^\\(+/g, \"\").replaceAll(/\\)+$/g, \"\");\n}\n\n/**\n * Extracts the variable name from a command path segment by removing enclosing square brackets.\n *\n * @example\n * ```typescript\n * getDynamicPathSegmentName(\"[user]\"); // \"user\"\n * getDynamicPathSegmentName(\"[[...user]]\"); // \"user\"\n * getDynamicPathSegmentName(\"[...user]\"); // \"user\"\n * ```\n *\n * @param path - The command path segment.\n * @returns The variable name without square brackets.\n */\nexport function getPathSegmentName(path: string): string {\n return getPathSegmentGroupName(getDynamicPathSegmentName(path));\n}\n"],"mappings":";;;;;;;;;;;;;AA8BA,SAAgBI,eAAeC,SAA6B;AAC1D,KAAIA,QAAQC,WAAW,EACrB,QAAO,EAAE;CAGX,MAAMC,SAASF,QAAQG,QAAOC,UAASA,MAAMH,WAAW,EAAE;AAC1DC,QAAOG,KAAK,GAAGL,QAAQG,QAAOC,UAASA,MAAMH,SAAS,EAAE,CAAC;AAEzD,QAAOC,OAAOI,MAAMC,GAAGC,MAAMD,EAAEE,cAAcD,EAAE,CAAC;;;;;;;;;AAUlD,SAAgBE,WAAWC,SAA8C;CACvE,MAAMT,SACJS,QAAQC,OAAOC,6DACFF,QAAQC,OAAOE,IAAI,IAC/BC,MAAMC,QAAQL,QAAQC,OAAOE,IAAI,IAChCH,QAAQC,OAAOE,IAAIb,SAAS,yDAChBU,QAAQC,OAAOE,IAAI,GAAI,uDACrBH,QAAQC,OAAOE,IAAI,GAC7BH,QAAQC,OAAOE,MACfH,QAAQC,OAAOE,IAAI,KACrBH,QAAQM,aAAaJ;AAC3B,KAAI,qDAAaX,OAAO,CACtB,OAAM,IAAIgB,MACR,qIACD;AAGH,yDAAiBhB,OAAO;;;;;;;;AAS1B,SAAgBiB,YAAYR,SAA8C;AACxE,QACEA,QAAQC,OAAOQ,0DACLT,QAAQC,OAAOC,QAAQH,WAAWC,QAAQ,CAAC;;;;;;;;AAUzD,SAAgBU,kBACdV,SACQ;AACR,QACEA,QAAQC,OAAOU,eACfX,QAAQM,aAAaK,eACrB,OAAOH,YAAYR,QAAQ,CAAA;;;;;;;;AAU/B,SAAgBY,UAAUZ,SAA0B;AAClD,4DAAmBA,QAAQC,OAAOE,IAAI,GAClCU,OAAOC,KAAKd,QAAQC,OAAOE,IAAI,CAAC,sDACtBJ,WAAWC,QAAQ,CAAC;;;;;;;;;;;;;;;;AAiBpC,SAAgBe,qBAAqBC,MAAuB;AAC1D,QAAOA,KAAKC,WAAW,IAAI,IAAID,KAAKE,SAAS,IAAI;;;;;;;;;;;;;;;AAgBnD,SAAgBC,8BAA8BH,MAAuB;AACnE,QAAOA,KAAKC,WAAW,QAAQ,IAAID,KAAKE,SAAS,KAAK;;;;;;;;;;;;;;;AAgBxD,SAAgBE,sBAAsBJ,MAAuB;AAC3D,QACGA,KAAKC,WAAW,OAAO,IAAID,KAAKE,SAAS,IAAI,IAC9CC,8BAA8BH,KAAK;;;;;;;;;;;;;;;AAiBvC,SAAgBK,0BAA0BL,MAAsB;AAC9D,QAAOA,KAAKM,WAAW,oBAAoB,GAAG,CAACA,WAAW,SAAS,GAAG;;;;;;;;;;;;;;;;;AAkBxE,SAAgBC,mBAAmBP,MAAuB;AACxD,QAAOA,KAAKC,WAAW,IAAI,IAAID,KAAKE,SAAS,IAAI;;;;;;;;;;;;;;AAenD,SAAgBM,wBAAwBR,MAAsB;AAC5D,QAAOA,KAAKM,WAAW,SAAS,GAAG,CAACA,WAAW,SAAS,GAAG;;;;;;;;;;;;;;;AAgB7D,SAAgBG,mBAAmBT,MAAsB;AACvD,QAAOQ,wBAAwBH,0BAA0BL,KAAK,CAAC"}
|
|
@@ -42,17 +42,103 @@ declare function getAppBin(context: Context): string;
|
|
|
42
42
|
/**
|
|
43
43
|
* Determines if a given command path segment is variable (enclosed in square brackets).
|
|
44
44
|
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```typescript
|
|
47
|
+
* isDynamicPathSegment("[user]"); // true
|
|
48
|
+
* isDynamicPathSegment("user"); // false
|
|
49
|
+
* isDynamicPathSegment("[[...user]]"); // true
|
|
50
|
+
* isDynamicPathSegment("[...user]"); // true
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
45
53
|
* @param path - The command path segment to check.
|
|
46
54
|
* @returns True if the path is variable, false otherwise.
|
|
47
55
|
*/
|
|
48
|
-
declare function
|
|
56
|
+
declare function isDynamicPathSegment(path: string): boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Determines if a given command path segment is an optional catch-all segment (enclosed in square brackets with a leading ellipsis).
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```typescript
|
|
62
|
+
* isOptionalCatchAllPathSegment("[[...user]]"); // true
|
|
63
|
+
* isOptionalCatchAllPathSegment("[...user]"); // false
|
|
64
|
+
* isOptionalCatchAllPathSegment("[user]"); // false
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param path - The command path segment to check.
|
|
68
|
+
* @returns True if the path is an optional catch-all segment, false otherwise.
|
|
69
|
+
*/
|
|
70
|
+
declare function isOptionalCatchAllPathSegment(path: string): boolean;
|
|
71
|
+
/**
|
|
72
|
+
* Determines if a given command path segment is an optional catch-all segment (enclosed in square brackets with a leading ellipsis).
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```typescript
|
|
76
|
+
* isCatchAllPathSegment("[[...user]]"); // true
|
|
77
|
+
* isCatchAllPathSegment("[...user]"); // true
|
|
78
|
+
* isCatchAllPathSegment("[user]"); // false
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
81
|
+
* @param path - The command path segment to check.
|
|
82
|
+
* @returns True if the path is a catch-all segment, false otherwise.
|
|
83
|
+
*/
|
|
84
|
+
declare function isCatchAllPathSegment(path: string): boolean;
|
|
49
85
|
/**
|
|
50
86
|
* Extracts the variable name from a command path segment by removing enclosing square brackets.
|
|
51
87
|
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```typescript
|
|
90
|
+
* getDynamicPathSegmentName("[user]"); // "user"
|
|
91
|
+
* getDynamicPathSegmentName("[[...user]]"); // "user"
|
|
92
|
+
* getDynamicPathSegmentName("[...user]"); // "user"
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* @param path - The command path segment.
|
|
96
|
+
* @returns The variable name without square brackets.
|
|
97
|
+
*/
|
|
98
|
+
declare function getDynamicPathSegmentName(path: string): string;
|
|
99
|
+
/**
|
|
100
|
+
* Determines if a given command path segment is a path segment group (enclosed in parentheses).
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```typescript
|
|
104
|
+
* isPathSegmentGroup("(user)"); // true
|
|
105
|
+
* isPathSegmentGroup("[[...user]]"); // false
|
|
106
|
+
* isPathSegmentGroup("[...user]"); // false
|
|
107
|
+
* isPathSegmentGroup("[user]"); // false
|
|
108
|
+
* isPathSegmentGroup("user"); // false
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @param path - The command path segment to check.
|
|
112
|
+
* @returns True if the path is a path segment group, false otherwise.
|
|
113
|
+
*/
|
|
114
|
+
declare function isPathSegmentGroup(path: string): boolean;
|
|
115
|
+
/**
|
|
116
|
+
* Extracts the group name from a command path segment by removing enclosing parentheses.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```typescript
|
|
120
|
+
* getPathSegmentGroupName("(admin)"); // "admin"
|
|
121
|
+
* getPathSegmentGroupName("((group))"); // "group"
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* @param path - The command path segment.
|
|
125
|
+
* @returns The group name without parentheses.
|
|
126
|
+
*/
|
|
127
|
+
declare function getPathSegmentGroupName(path: string): string;
|
|
128
|
+
/**
|
|
129
|
+
* Extracts the variable name from a command path segment by removing enclosing square brackets.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```typescript
|
|
133
|
+
* getDynamicPathSegmentName("[user]"); // "user"
|
|
134
|
+
* getDynamicPathSegmentName("[[...user]]"); // "user"
|
|
135
|
+
* getDynamicPathSegmentName("[...user]"); // "user"
|
|
136
|
+
* ```
|
|
137
|
+
*
|
|
52
138
|
* @param path - The command path segment.
|
|
53
139
|
* @returns The variable name without square brackets.
|
|
54
140
|
*/
|
|
55
|
-
declare function
|
|
141
|
+
declare function getPathSegmentName(path: string): string;
|
|
56
142
|
//#endregion
|
|
57
|
-
export { getAppBin, getAppDescription, getAppName, getAppTitle,
|
|
143
|
+
export { getAppBin, getAppDescription, getAppName, getAppTitle, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCatchAllPathSegment, isDynamicPathSegment, isOptionalCatchAllPathSegment, isPathSegmentGroup, sortArgAliases };
|
|
58
144
|
//# sourceMappingURL=context-helpers.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"context-helpers.d.cts","names":[],"sources":["../../src/plugin-utils/context-helpers.ts"],"sourcesContent":[],"mappings":";;;;;;;;AA8BA;AAkBA;AA0BA;AAagB,iBAzDA,cAAA,CA0DL,OAAA,EAAA,MAAA,EAAoB,CAAA,EAAA,MAAO,EAAA;AAetC;
|
|
1
|
+
{"version":3,"file":"context-helpers.d.cts","names":[],"sources":["../../src/plugin-utils/context-helpers.ts"],"sourcesContent":[],"mappings":";;;;;;;;AA8BA;AAkBA;AA0BA;AAagB,iBAzDA,cAAA,CA0DL,OAAA,EAAA,MAAA,EAAoB,CAAA,EAAA,MAAO,EAAA;AAetC;AAoBA;AAiBA;AAiBA;AAoBA;AAmBA;AAgBA;AAiBgB,iBArLA,UAAA,CAqLkB,OAAA,EArLE,iBAqLF,GArLsB,OAqLtB,CAAA,EAAA,MAAA;;;;;;;iBA3JlB,WAAA,UAAqB,oBAAoB;;;;;;;iBAazC,iBAAA,UACL,oBAAoB;;;;;;;iBAef,SAAA,UAAmB;;;;;;;;;;;;;;;iBAoBnB,oBAAA;;;;;;;;;;;;;;iBAiBA,6BAAA;;;;;;;;;;;;;;iBAiBA,qBAAA;;;;;;;;;;;;;;iBAoBA,yBAAA;;;;;;;;;;;;;;;;iBAmBA,kBAAA;;;;;;;;;;;;;iBAgBA,uBAAA;;;;;;;;;;;;;;iBAiBA,kBAAA"}
|