bashly-strings.yml (SchemaStore) JSON Schema

Type	object
File match	`bashly-strings.yml` `bashly-strings.yaml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/bashly-strings-yml/latest.json
Source	https://raw.githubusercontent.com/DannyBen/bashly/master/schemas/strings.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Strings of the generated script https://bashly.dev/advanced/strings/#custom-strings

Properties

usage string

The caption for the usage patterns https://bashly.dev/advanced/strings/#custom-strings

Default: "Usage:"

minLength=1

options string

The caption for the options section https://bashly.dev/advanced/strings/#custom-strings

Default: "Options:"

minLength=1

global_options string

The caption for the options section, when a command has flags and sub-commands https://bashly.dev/advanced/strings/#custom-strings

Default: "Options:"

minLength=1

arguments string

The caption for the argument section https://bashly.dev/advanced/strings/#custom-strings

Default: "Arguments:"

minLength=1

commands string

The caption for the command section https://bashly.dev/advanced/strings/#custom-strings

Default: "Commands:"

minLength=1

examples string

The caption for the examples section https://bashly.dev/advanced/strings/#custom-strings

Default: "Examples:"

minLength=1

environment_variables string

The caption for the environment variables section https://bashly.dev/advanced/strings/#custom-strings

Default: "Environment Variables:"

minLength=1

group string

The caption template for custom command groups https://bashly.dev/advanced/strings/#custom-strings

Default: "%{group} Commands:"

minLength=1

command_alias string

The string template for a command alias https://bashly.dev/advanced/strings/#custom-strings

Default: "Alias: %{alias}"

minLength=1

default_command_summary string

The string template for the summary of a default command https://bashly.dev/advanced/strings/#custom-strings

Default: "%{summary} (default)"

minLength=1

required string

The string suffix for required arguments, flags, or commands https://bashly.dev/advanced/strings/#custom-strings

Default: "(required)"

minLength=1

repeatable string

The string suffix for repeatable arguments, flags, or commands https://bashly.dev/advanced/strings/#custom-strings

Default: "(repeatable)"

minLength=1

default string

The string template for a default argument or flag https://bashly.dev/advanced/strings/#custom-strings

Default: "Default: %{value}"

minLength=1

allowed string

The string template for the list of allowed values https://bashly.dev/advanced/strings/#custom-strings

Default: "Allowed: %{values}"

minLength=1

needs string

The string template for the list of needed flags https://bashly.dev/advanced/strings/#custom-strings

Default: "Needs: %{values}"

minLength=1

conflicts string

The string template for the list of conflicting flags https://bashly.dev/advanced/strings/#custom-strings

Default: "Conflicts: %{values}"

minLength=1

help_flag_text string

The help message for --help https://bashly.dev/advanced/strings/#custom-strings

Default: "Show this help"

minLength=1

version_flag_text string

The help message for --version https://bashly.dev/advanced/strings/#custom-strings

Default: "Show version number"

minLength=1

flag_requires_an_argument string

The error message template for missing flag argument https://bashly.dev/advanced/strings/#custom-strings

Default: "%{name} requires an argument: %{usage}"

minLength=1

flag_needs_another string

The error message template for missing flag needs https://bashly.dev/advanced/strings/#custom-strings

Default: "%{name} needs %{need}"

minLength=1

invalid_argument string

The error message template for invalid argument https://bashly.dev/advanced/strings/#custom-strings

Default: "invalid argument: %s"

minLength=1

invalid_flag string

The error message template for invalid flag https://bashly.dev/advanced/strings/#custom-strings

Default: "invalid option: %s"

minLength=1

invalid_command string

The error message template for invalid command https://bashly.dev/advanced/strings/#custom-strings

Default: "invalid command: %s"

minLength=1

conflicting_flags string

The error message template for conflicting flags https://bashly.dev/advanced/strings/#custom-strings

Default: "conflicting options: %s cannot be used with %s"

minLength=1

missing_required_argument string

The error message template for missing required argument https://bashly.dev/advanced/strings/#custom-strings

Default: "missing required argument: %{arg}\nusage: %{usage}"

minLength=1

missing_required_flag string

The error message template for missing required flag https://bashly.dev/advanced/strings/#custom-strings

Default: "missing required flag: %{usage}"

minLength=1

missing_required_environment_variable string

The error message template for missing required environment variable https://bashly.dev/advanced/strings/#custom-strings

Default: "missing required environment variable: %{var}"

minLength=1

missing_dependency string

The error message template for missing dependency https://bashly.dev/advanced/strings/#custom-strings

Default: "missing dependency: %{dependency}"

minLength=1

examples_caption_on_error string

The string to show before the examples when show_examples_on_error is enabled https://bashly.dev/advanced/strings/#custom-strings

Default: "examples:"

minLength=1

disallowed_flag string

The error message template for forbidden flag https://bashly.dev/advanced/strings/#custom-strings

Default: "%{name} must be one of: %{allowed}"

minLength=1

disallowed_argument string

The error message template for forbidden argument https://bashly.dev/advanced/strings/#custom-strings

Default: "%{name} must be one of: %{allowed}"

minLength=1

disallowed_environment_variable string

The error message template for forbidden environment variable https://bashly.dev/advanced/strings/#custom-strings

Default: "%{name} environment variable must be one of: %{allowed}"

minLength=1

unsupported_bash_version string

The error message for unsupported Bash version https://bashly.dev/advanced/strings/#custom-strings

Default: "bash version 4 or higher is required"

minLength=1

validation_error string

The error message template for failed custom validation https://bashly.dev/advanced/strings/#custom-strings

Default: "validation error in %s:\n%s"

minLength=1

environment_variable_validation_error string

The error message template for failed custom validation for environment variables https://bashly.dev/advanced/strings/#custom-strings

Default: "validation error in environment variable %s:\n%s"

minLength=1