Skip to content

Commit fe7563c

Browse files
authored
Merge pull request #623 from DannyBen/update/doc
Update `bashly doc` with `command.help_header_override`
2 parents a6bf478 + b518cc0 commit fe7563c

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

lib/bashly/docs/command.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,20 @@ command.help:
289289
- name: images
290290
help: Manage images
291291
292+
command.help_header_override:
293+
help: Provide an alternative bash code (or function call) that will be executed at the beginning of the help message.
294+
295+
url: https://bashly.dev/configuration/command/#help_header_override
296+
example: |-
297+
name: font-explorer
298+
help: Font manager utility
299+
300+
help_header_override: |
301+
echo '┏┓ ┏┓ ┓ '
302+
echo '┣ ┏┓┏┓╋ ┣ ┓┏┏┓┃┏┓┏┓┏┓┏┓'
303+
echo '┻ ┗┛┛┗┗ ┗┛┛┗┣┛┗┗┛┛ ┗ ┛ '
304+
echo ' ┛ v1.0'
305+
292306
command.name:
293307
help: Specify the name of the command. This option is required.
294308
url: https://bashly.dev/configuration/command/#name

spec/approvals/cli/doc/full

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,22 @@ command.help
443443

444444
See https://bashly.dev/configuration/command/#help
445445

446+
command.help_header_override
447+
448+
Provide an alternative bash code (or function call) that will be executed at
449+
the beginning of the help message.
450+
451+
name: font-explorer
452+
help: Font manager utility
453+
454+
help_header_override: |
455+
echo '┏┓ ┏┓ ┓ '
456+
echo '┣ ┏┓┏┓╋ ┣ ┓┏┏┓┃┏┓┏┓┏┓┏┓'
457+
echo '┻ ┗┛┛┗┗ ┗┛┛┗┣┛┗┗┛┛ ┗ ┛ '
458+
echo ' ┛ v1.0'
459+
460+
See https://bashly.dev/configuration/command/#help_header_override
461+
446462
command.name
447463

448464
Specify the name of the command. This option is required.

spec/approvals/cli/doc/index

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ command.footer
2525
command.function
2626
command.group
2727
command.help
28+
command.help_header_override
2829
command.name
2930
command.private
3031
command.variables

0 commit comments

Comments
 (0)