Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update JSON schema with help_header_override #622

Merged
merged 1 commit into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions schemas/bashly.json
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,15 @@
"URL to download from"
]
},
"help-header-override-property": {
"title": "help_header_override",
"description": "Bash code (or function call) that will be executed at the beginning of the help message\nhttps://bashly.dev/configuration/command/#help-header-override",
"type": "string",
"minLength": 1,
"examples": [
"generate_ascii_art_logo"
]
},
"args-property": {
"title": "args",
"description": "Arguments of the current script or sub-command\nhttps://bashly.dev/configuration/command/#args",
Expand Down Expand Up @@ -847,6 +856,9 @@
"help": {
"$ref": "#/definitions/help-property"
},
"help_header_override": {
"$ref": "#/definitions/help-header-override-property"
},
"args": {
"$ref": "#/definitions/args-property"
},
Expand Down Expand Up @@ -924,6 +936,9 @@
"help": {
"$ref": "#/definitions/help-property"
},
"help_header_override": {
"$ref": "#/definitions/help-header-override-property"
},
"args": {
"$ref": "#/definitions/args-property"
},
Expand Down
13 changes: 13 additions & 0 deletions support/schema/bashly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,15 @@ definitions:
minLength: 1
examples:
- URL to download from
help-header-override-property:
title: help_header_override
description: |-
Bash code (or function call) that will be executed at the beginning of the help message
https://bashly.dev/configuration/command/#help-header-override
type: string
minLength: 1
examples:
- generate_ascii_art_logo
args-property:
title: args
description: |-
Expand Down Expand Up @@ -739,6 +748,8 @@ definitions:
$ref: '#/definitions/sub-command-alias-property'
help:
$ref: '#/definitions/help-property'
help_header_override:
$ref: '#/definitions/help-header-override-property'
args:
$ref: '#/definitions/args-property'
flags:
Expand Down Expand Up @@ -787,6 +798,8 @@ properties:
$ref: '#/definitions/name-property'
help:
$ref: '#/definitions/help-property'
help_header_override:
$ref: '#/definitions/help-header-override-property'
args:
$ref: '#/definitions/args-property'
flags:
Expand Down