schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
ansible-navigator.json
time-zone
Specify the IANA time zone to use or 'local' to use the system time zone
{"default": "UTC", "type": "string"}
aliases.json
An alias of the current directory https://github.com/sebglazebrook/aliases#usage
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "patternProperties": {"^[^ ]+$": {"type": "object", "required": ["command"], "properties": {"command": {"type": "string", "minLength": 1, "examples": ["ls"]}, "confirm": {"type": "boolean", "default": false}, "confirmation_message": {"type": "string", "minLength": 1, "examples": ["Do you want to execute this command?"]}, "conditional": {"type": "string", "minLength": 1, "examples": ["/bin/true"]}, "backout_seconds": {"type": "integer", "minimum": 0}, "unit_test": {"type": "string", "minLength": 1, "examples": ["[ true = true ]"]}, "quiet": {"type": "boolean", "default": false}}, "additionalProperties": false}}, "type": "object"}
aliases.json
^[^ ]+$
An alias of the current directory https://github.com/sebglazebrook/aliases#usage
{"type": "object", "required": ["command"], "properties": {"command": {"type": "string", "minLength": 1, "examples": ["ls"]}, "confirm": {"type": "boolean", "default": false}, "confirmation_message": {"type": "string", "minLength": 1, "examples": ["Do you want to execute this command?"]}, "conditional": {"type": "string", "minLength": 1, "examples": ["/bin/true"]}, "backout_seconds": {"type": "integer", "minimum": 0}, "unit_test": {"type": "string", "minLength": 1, "examples": ["[ true = true ]"]}, "quiet": {"type": "boolean", "default": false}}, "additionalProperties": false}
aliases.json
command
A command of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "string", "minLength": 1, "examples": ["ls"]}
aliases.json
confirm
Whether to confirm a command execution of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "boolean", "default": false}
aliases.json
confirmation_message
A confirmation message of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "string", "minLength": 1, "examples": ["Do you want to execute this command?"]}
aliases.json
conditional
A conditional of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "string", "minLength": 1, "examples": ["/bin/true"]}
aliases.json
backout_seconds
A backout of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "integer", "minimum": 0}
aliases.json
unit_test
A unit test of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "string", "minLength": 1, "examples": ["[ true = true ]"]}
aliases.json
quiet
Whether to display a command before execution of the current alias https://github.com/sebglazebrook/aliases#usage
{"type": "boolean", "default": false}
blueprint-spec2-schema.json
description
In the relevant UI field, enter a description to be displayed to the user.
{"type": "string"}
safebox-schema-v1.0.0.json
Configuration for safebox to deploy parameters to various parameter stores
{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/safebox-schema-v1.0.0.json", "properties": {"service": {"type": "string"}, "provider": {"type": "string", "enum": ["ssm", "secrets-manager"]}, "region": {"anyOf": [{"enum": ["us-east-2", "us-east-1", "us-west-1", "us-west-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-3", "ap-southeast-4", "ap-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-south-1", "eu-west-3", "eu-south-2", "eu-north-1", "eu-central-2", "me-south-1", "me-central-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1"]}, {"type": "string"}]}, "prefix": {"type": "string", "default": "/<stage>/<service>/"}, "generate": {"type": "array", "items": {"type": "object", "required": ["type", "path"], "properties": {"type": {"enum": ["json", "yaml", "dotenv", "types-node"]}, "path": {"type": "string"}}}}, "cloudformation-stacks": {"type": "array", "items": {"type": "string"}}, "config": {"type": "object", "properties": {"defaults": {"type": "object"}, "shared": {"type": "object"}}}, "secret": {"type": "object", "properties": {"defaults": {"type": "object"}, "shared": {"type": "object"}}}}, "required": ["service", "provider"], "type": "object"}
safebox-schema-v1.0.0.json
service
Name of the service. parameters will be prefixed by the value provided
{"type": "string"}
safebox-schema-v1.0.0.json
provider
Deploy parameters to the given provider. Eg. ssm, secrets-manager
{"type": "string", "enum": ["ssm", "secrets-manager"]}
safebox-schema-v1.0.0.json
region
Region to deploy the parameters to. Eg. us-east-1
{"anyOf": [{"enum": ["us-east-2", "us-east-1", "us-west-1", "us-west-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-3", "ap-southeast-4", "ap-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-south-1", "eu-west-3", "eu-south-2", "eu-north-1", "eu-central-2", "me-south-1", "me-central-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1"]}, {"type": "string"}]}
safebox-schema-v1.0.0.json
prefix
Prefix to apply to all parameters. Does not apply for shared
{"type": "string", "default": "/<stage>/<service>/"}
safebox-schema-v1.0.0.json
generate
Generate different files based on the parameter name and values
{"type": "array", "items": {"type": "object", "required": ["type", "path"], "properties": {"type": {"enum": ["json", "yaml", "dotenv", "types-node"]}, "path": {"type": "string"}}}}
safebox-schema-v1.0.0.json
type
Type of file to generate
{"enum": ["json", "yaml", "dotenv", "types-node"]}
safebox-schema-v1.0.0.json
path
Full path with filename for writing the output
{"type": "string"}
safebox-schema-v1.0.0.json
cloudformation-stacks
Cloudformation stack names. Any output values from the stacks can be interpolated. Eg. DB_NAME: "{{.myDbName}}" myDbName is the output of one of the cloudformation stacks
{"type": "array", "items": {"type": "string"}}
safebox-schema-v1.0.0.json
config
Parameters to deploy as non secret. You can also specify stage specific key value pairs. Same key in the defaults will be ignored and stage specific value will be used.
{"type": "object", "properties": {"defaults": {"type": "object"}, "shared": {"type": "object"}}}
safebox-schema-v1.0.0.json
defaults
parameter name and value. Output is /<stage>/<service>/<param name>
{"type": "object"}
safebox-schema-v1.0.0.json
shared
Params that are to be shared between multiple services. The parameter name wont be prefixed by service name. Output is /<stage>/shared/<param name>
{"type": "object"}
safebox-schema-v1.0.0.json
secret
Parameters to deploy as secret. You cannot specify stage specific key value pairs. Value is the description. You will need to run safebox deploy in prompt mode to provide the actual value.
{"type": "object", "properties": {"defaults": {"type": "object"}, "shared": {"type": "object"}}}
safebox-schema-v1.0.0.json
defaults
parameter name and value. Output is /<stage>/<service>/<param name>
{"type": "object"}
safebox-schema-v1.0.0.json
shared
Params that are to be shared between multiple services. The parameter name wont be prefixed by service name. Output is /<stage>/shared/<param name>
{"type": "object"}
npm-badges.json
An object hash containing an `items` array and optionally a `config` object
{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "id": "https://json.schemastore.org/npm-badges.json", "properties": {"list": {"type": "array", "items": {"enum": ["---", "npmversion", "npmdownloads", "daviddm", "daviddmdev", "nodeico", "saucelabsbm", "saucelabs", "travisci", "githubworkflow", "codeship", "coveralls", "codeclimate", "bithound", "waffle", "sixtydevstips", "patreon", "opencollective", "gratipay", "flattr", "paypal", "bitcoin", "wishlist", "slackinscript", "slackin", "gabeacon", "googleplusone", "redditsubmit", "hackernewssubmit", "facebooklike", "facebookfollow", "twittertweet", "twitterfollow", "githubfollow", "githubstar", "quorafollow"]}}, "config": {"type": "object", "additionalProperties": false, "properties": {"npmPackageName": {"type": "string"}, "saucelabsUsername": {"type": "string"}, "saucelabsAuthToken": {"type": "string"}, "travisTLD": {"type": "string"}, "codeshipProjectUUID": {"type": "string"}, "codeshipProjectID": {"type": "string"}, "githubSlug": {"type": "string"}, "githubWorkflow": {"type": "string"}, "githubBranch": {"type": "string"}, "githubEvent": {"type": "string"}, "nodeicoQueryString": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"compact": {"enum": [true]}, "mini": {"enum": [true]}, "downloads": {"enum": [true]}, "downloadRank": {"enum": [true]}, "stars": {"enum": [true]}, "months": {"type": "integer"}, "height": {"enum": [1, 2, 3]}}}]}, "sixtydevstipsID": {"type": "string"}, "sixtydevstipsURL": {"type": "string"}, "patreonUsername": {"type": "string"}, "patreonURL": {"type": "string"}, "opencollectiveUsername": {"type": "string"}, "opencollectiveURL": {"type": "string"}, "gratipayUsername": {"type": "string"}, "flattrUsername": {"type": "string"}, "paypalURL": {"type": "string"}, "paypalButtonID": {"type": "string"}, "paypalUsername": {"type": "string"}, "bitcoinURL": {"type": "string"}, "wishlistURL": {"type": "string"}, "slackinURL": {"type": "string"}, "gaTrackingID": {"type": "string"}, "homepage": {"type": "string"}, "facebookApplicationID": {"type": "string"}, "facebookUsername": {"type": "string"}, "twitterUsername": {"type": "string"}, "githubUsername": {"type": "string"}, "quoraUsername": {"type": "string"}, "quoraRealname": {"type": "string"}}}}, "type": "object"}
npm-badges.json
list
Array of badges. Use "---" to denote a separation.
{"type": "array", "items": {"enum": ["---", "npmversion", "npmdownloads", "daviddm", "daviddmdev", "nodeico", "saucelabsbm", "saucelabs", "travisci", "githubworkflow", "codeship", "coveralls", "codeclimate", "bithound", "waffle", "sixtydevstips", "patreon", "opencollective", "gratipay", "flattr", "paypal", "bitcoin", "wishlist", "slackinscript", "slackin", "gabeacon", "googleplusone", "redditsubmit", "hackernewssubmit", "facebooklike", "facebookfollow", "twittertweet", "twitterfollow", "githubfollow", "githubstar", "quorafollow"]}}
npm-badges.json
config
Configuration object
{"type": "object", "additionalProperties": false, "properties": {"npmPackageName": {"type": "string"}, "saucelabsUsername": {"type": "string"}, "saucelabsAuthToken": {"type": "string"}, "travisTLD": {"type": "string"}, "codeshipProjectUUID": {"type": "string"}, "codeshipProjectID": {"type": "string"}, "githubSlug": {"type": "string"}, "githubWorkflow": {"type": "string"}, "githubBranch": {"type": "string"}, "githubEvent": {"type": "string"}, "nodeicoQueryString": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"compact": {"enum": [true]}, "mini": {"enum": [true]}, "downloads": {"enum": [true]}, "downloadRank": {"enum": [true]}, "stars": {"enum": [true]}, "months": {"type": "integer"}, "height": {"enum": [1, 2, 3]}}}]}, "sixtydevstipsID": {"type": "string"}, "sixtydevstipsURL": {"type": "string"}, "patreonUsername": {"type": "string"}, "patreonURL": {"type": "string"}, "opencollectiveUsername": {"type": "string"}, "opencollectiveURL": {"type": "string"}, "gratipayUsername": {"type": "string"}, "flattrUsername": {"type": "string"}, "paypalURL": {"type": "string"}, "paypalButtonID": {"type": "string"}, "paypalUsername": {"type": "string"}, "bitcoinURL": {"type": "string"}, "wishlistURL": {"type": "string"}, "slackinURL": {"type": "string"}, "gaTrackingID": {"type": "string"}, "homepage": {"type": "string"}, "facebookApplicationID": {"type": "string"}, "facebookUsername": {"type": "string"}, "twitterUsername": {"type": "string"}, "githubUsername": {"type": "string"}, "quoraUsername": {"type": "string"}, "quoraRealname": {"type": "string"}}}
npm-badges.json
npmPackageName
The npm package name
{"type": "string"}
npm-badges.json
saucelabsUsername
The username of the SauceLabs account
{"type": "string"}
npm-badges.json
saucelabsAuthToken
SauceLabs auth token, should probably not be used. Use `SAUCELABS_AUTH_TOKEN` env var instead.
{"type": "string"}
npm-badges.json
travisTLD
The TLD to use for Travis CI. Use "com" if you have moved to travis-ci.com
{"type": "string"}
npm-badges.json
codeshipProjectUUID
The UUID for the project, available in the General tab of your project setting.
{"type": "string"}
npm-badges.json
codeshipProjectID
The ID for the project, available in the URL for the codeship project.
{"type": "string"}
npm-badges.json
githubSlug
The Github slug of the project (e.g., SchemaStore/schemastore)
{"type": "string"}
npm-badges.json
githubWorkflow
The name or location of the workflow file to show the badge for.
{"type": "string"}
npm-badges.json
githubBranch
The branch to constrain the badge to.
{"type": "string"}
npm-badges.json
githubEvent
The event to constrain the badge to.
{"type": "string"}
npm-badges.json
nodeicoQueryString
Either a query string as a string, or an object containing the options. See https://nodei.co for details
{"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"compact": {"enum": [true]}, "mini": {"enum": [true]}, "downloads": {"enum": [true]}, "downloadRank": {"enum": [true]}, "stars": {"enum": [true]}, "months": {"type": "integer"}, "height": {"enum": [1, 2, 3]}}}]}
npm-badges.json
sixtydevstipsID
The 60devs username to donate to.
{"type": "string"}
npm-badges.json
sixtydevstipsURL
The URL to the 60devs donate page.
{"type": "string"}
npm-badges.json
patreonUsername
The Patreon username to donate to.
{"type": "string"}
npm-badges.json
patreonURL
The URL to the Patreon donate page.
{"type": "string"}
npm-badges.json
opencollectiveUsername
The Open Collective username to donate to.
{"type": "string"}
npm-badges.json
opencollectiveURL
The URL to the Open Collective donate page.
{"type": "string"}
npm-badges.json
homepage
The home page URL
{"type": "string"}
npm-badges.json
twitterUsername
The twitter username to tweet at
{"type": "string"}
npm-badges.json
githubUsername
The Github username to use
{"type": "string"}
yamllint.json
yamllint uses a set of rules to check source files for problems.
{"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"toggle": {"type": "string", "enum": ["enable", "disable"]}, "ignore": {"properties": {"ignore": {"type": "string"}}}, "allRules": {"properties": {"level": {"type": "string", "default": "warning"}}}}, "id": "https://json.schemastore.org/yamllint.json", "properties": {"extends": {"type": "string"}, "yaml-files": {"type": "array", "items": {"type": "string"}, "default": ["*.yaml", "*.yml", ".yamllint"]}, "locale": {"type": "string"}, "rules": {"properties": {"braces": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["non-empty"]}], "default": false}, "min-spaces-inside": {"type": "number", "default": 0}, "max-spaces-inside": {"type": "number", "default": 0}, "min-spaces-inside-empty": {"type": "number", "default": -1}, "max-spaces-inside-empty": {"type": "number", "default": -1}}}], "default": "enable"}, "brackets": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["non-empty"]}], "default": false}, "min-spaces-inside": {"type": "number", "default": 0}, "max-spaces-inside": {"type": "number", "default": 0}, "min-spaces-inside-empty": {"type": "number", "default": -1}, "max-spaces-inside-empty": {"type": "number", "default": -1}}}], "default": "enable"}, "colons": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max-spaces-before": {"type": "number", "default": 0}, "max-spaces-after": {"type": "number", "default": 1}}}], "default": "enable"}, "commas": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max-spaces-before": {"type": "number", "default": 0}, "min-spaces-after": {"type": "number", "default": 1}, "max-spaces-after": {"type": "number", "default": 1}}}], "default": "enable"}, "comments": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"require-starting-space": {"type": "boolean", "default": true}, "ignore-shebangs": {"type": "boolean", "default": true}, "min-spaces-from-content": {"type": "number", "default": 2}}}], "default": {"level": "warning"}}, "comments-indentation": {"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": {"level": "warning"}}, "document-end": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"present": {"type": "boolean", "default": true}}}], "default": "disable"}, "document-start": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"present": {"type": "boolean", "default": true}}}], "default": {"level": "warning"}}, "empty-lines": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max": {"type": "number", "default": 2}, "max-start": {"type": "number", "default": 0}, "max-end": {"type": "number", "default": 0}}}], "default": "enable"}, "empty-values": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid-in-block-mappings": {"type": "boolean", "default": true}, "forbid-in-flow-mappings": {"type": "boolean", "default": true}}}], "default": "disable"}, "hyphens": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max-spaces-after": {"type": "number", "default": 1}}}], "default": "enable"}, "indentation": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"spaces": {"anyOf": [{"type": "number"}, {"type": "string", "enum": ["consistent"]}], "default": "consistent"}, "indent-sequences": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["whatever", "consistent"]}], "default": true}, "check-multi-line-strings": {"type": "boolean", "default": false}}}], "default": "enable"}, "key-duplicates": {"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "enable"}, "key-ordering": {"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "disable"}, "line-length": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max": {"type": "number", "default": 80}, "allow-non-breakable-words": {"type": "boolean", "default": true}, "allow-non-breakable-inline-mappings": {"type": "boolean", "default": true}}}], "default": "enable"}, "new-line-at-end-of-file": {"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "enable"}, "new-lines": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["unix", "dos", "platform"], "default": "unix"}}}], "default": "enable"}, "octal-values": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid-implicit-octal": {"type": "boolean", "default": true}, "forbid-explicit-octal": {"type": "boolean", "default": true}}}], "default": "disable"}, "quoted-strings": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"quote-type": {"type": "string", "enum": ["single", "double", "any"], "default": "any"}, "required": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["only-when-needed"]}], "default": true}, "extra-required": {"type": "array", "items": {"type": "string"}, "default": []}, "extra-allowed": {"type": "array", "items": {"type": "string"}, "default": []}}}], "default": "disable"}, "trailing-spaces": {"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "enable"}, "truthy": {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"allowed-values": {"type": "array", "items": {"type": "string", "enum": ["TRUE", "True", "true", "FALSE", "False", "false", "YES", "Yes", "yes", "NO", "No", "no", "ON", "On", "on", "OFF", "Off", "off"]}, "default": ["true", "false"]}, "check-keys": {"type": "boolean", "default": true}}}], "default": {"level": "warning"}}}}}, "type": "object"}
yamllint.json
ignore
Ignore files, so that the linter doesn't process them.
{"type": "string"}
yamllint.json
locale
This is passed to Python's locale.setlocale.
{"type": "string"}
yamllint.json
braces
Use this rule to control the use of flow mappings or number of spaces inside braces ({ and }).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["non-empty"]}], "default": false}, "min-spaces-inside": {"type": "number", "default": 0}, "max-spaces-inside": {"type": "number", "default": 0}, "min-spaces-inside-empty": {"type": "number", "default": -1}, "max-spaces-inside-empty": {"type": "number", "default": -1}}}], "default": "enable"}
yamllint.json
forbid
Used to forbid the use of flow mappings which are denoted by surrounding braces ({ and }).
{"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["non-empty"]}], "default": false}
yamllint.json
min-spaces-inside
Defines the minimal number of spaces required inside braces.
{"type": "number", "default": 0}
yamllint.json
max-spaces-inside
Defines the maximal number of spaces allowed inside braces.
{"type": "number", "default": 0}
yamllint.json
min-spaces-inside-empty
Defines the minimal number of spaces required inside empty braces.
{"type": "number", "default": -1}
yamllint.json
max-spaces-inside-empty
Defines the maximal number of spaces allowed inside empty braces.
{"type": "number", "default": -1}
yamllint.json
brackets
Use this rule to control the use of flow sequences or the number of spaces inside brackets ([ and ]).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["non-empty"]}], "default": false}, "min-spaces-inside": {"type": "number", "default": 0}, "max-spaces-inside": {"type": "number", "default": 0}, "min-spaces-inside-empty": {"type": "number", "default": -1}, "max-spaces-inside-empty": {"type": "number", "default": -1}}}], "default": "enable"}
yamllint.json
forbid
Used to forbid the use of flow sequences which are denoted by surrounding brackets ([ and ]).
{"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["non-empty"]}], "default": false}
yamllint.json
min-spaces-inside
Defines the minimal number of spaces required inside brackets.
{"type": "number", "default": 0}
yamllint.json
max-spaces-inside
Defines the maximal number of spaces allowed inside brackets.
{"type": "number", "default": 0}
yamllint.json
min-spaces-inside-empty
Defines the minimal number of spaces required inside empty brackets.
{"type": "number", "default": -1}
yamllint.json
max-spaces-inside-empty
Defines the maximal number of spaces allowed inside empty brackets.
{"type": "number", "default": -1}
yamllint.json
colons
Use this rule to control the number of spaces before and after colons (:).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max-spaces-before": {"type": "number", "default": 0}, "max-spaces-after": {"type": "number", "default": 1}}}], "default": "enable"}
yamllint.json
max-spaces-before
Defines the maximal number of spaces allowed before colons (use -1 to disable).
{"type": "number", "default": 0}
yamllint.json
max-spaces-after
Defines the maximal number of spaces allowed after colons (use -1 to disable).
{"type": "number", "default": 1}
yamllint.json
commas
Use this rule to control the number of spaces before and after commas (,).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max-spaces-before": {"type": "number", "default": 0}, "min-spaces-after": {"type": "number", "default": 1}, "max-spaces-after": {"type": "number", "default": 1}}}], "default": "enable"}
yamllint.json
max-spaces-before
Defines the maximal number of spaces allowed before commas (use -1 to disable).
{"type": "number", "default": 0}
yamllint.json
min-spaces-after
Defines the minimal number of spaces required after commas.
{"type": "number", "default": 1}
yamllint.json
max-spaces-after
Defines the maximal number of spaces allowed after commas (use -1 to disable).
{"type": "number", "default": 1}
yamllint.json
comments
Use this rule to control the position and formatting of comments.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"require-starting-space": {"type": "boolean", "default": true}, "ignore-shebangs": {"type": "boolean", "default": true}, "min-spaces-from-content": {"type": "number", "default": 2}}}], "default": {"level": "warning"}}
yamllint.json
require-starting-space
Require a space character right after the #.
{"type": "boolean", "default": true}
yamllint.json
ignore-shebangs
Ignore a shebang at the beginning of the file when require-starting-space is set.
{"type": "boolean", "default": true}
yamllint.json
min-spaces-from-content
Used to visually separate inline comments from content.
{"type": "number", "default": 2}
yamllint.json
comments-indentation
Use this rule to force comments to be indented like content.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": {"level": "warning"}}
yamllint.json
document-end
Use this rule to require or forbid the use of document end marker (...).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"present": {"type": "boolean", "default": true}}}], "default": "disable"}
yamllint.json
present
True when the document end marker is required, or to false when it is forbidden.
{"type": "boolean", "default": true}
yamllint.json
document-start
Use this rule to require or forbid the use of document start marker (---).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"present": {"type": "boolean", "default": true}}}], "default": {"level": "warning"}}
yamllint.json
present
True when the document start marker is required, or to false when it is forbidden.
{"type": "boolean", "default": true}
yamllint.json
empty-lines
Use this rule to set a maximal number of allowed consecutive blank lines.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max": {"type": "number", "default": 2}, "max-start": {"type": "number", "default": 0}, "max-end": {"type": "number", "default": 0}}}], "default": "enable"}
yamllint.json
max
Defines the maximal number of empty lines allowed in the document.
{"type": "number", "default": 2}
yamllint.json
max-start
Defines the maximal number of empty lines allowed at the beginning of the file.
{"type": "number", "default": 0}
yamllint.json
max-end
{"type": "number", "default": 0}
yamllint.json
empty-values
Use this rule to prevent nodes with empty content, that implicitly result in null values.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid-in-block-mappings": {"type": "boolean", "default": true}, "forbid-in-flow-mappings": {"type": "boolean", "default": true}}}], "default": "disable"}
yamllint.json
forbid-in-block-mappings
Prevent empty values in block mappings.
{"type": "boolean", "default": true}
yamllint.json
forbid-in-flow-mappings
Prevent empty values in flow mappings.
{"type": "boolean", "default": true}
yamllint.json
hyphens
Use this rule to control the number of spaces after hyphens (-).
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max-spaces-after": {"type": "number", "default": 1}}}], "default": "enable"}
yamllint.json
max-spaces-after
Defines the maximal number of spaces allowed after hyphens.
{"type": "number", "default": 1}
yamllint.json
indentation
Use this rule to control the indentation.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"spaces": {"anyOf": [{"type": "number"}, {"type": "string", "enum": ["consistent"]}], "default": "consistent"}, "indent-sequences": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["whatever", "consistent"]}], "default": true}, "check-multi-line-strings": {"type": "boolean", "default": false}}}], "default": "enable"}
yamllint.json
spaces
Defines the indentation width, in spaces.
{"anyOf": [{"type": "number"}, {"type": "string", "enum": ["consistent"]}], "default": "consistent"}
yamllint.json
indent-sequences
Defines whether block sequences should be indented or not (when in a mapping, this indentation is not mandatory – some people perceive the - as part of the indentation).
{"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["whatever", "consistent"]}], "default": true}
yamllint.json
check-multi-line-strings
Defines whether to lint indentation in multi-line strings.
{"type": "boolean", "default": false}
yamllint.json
key-duplicates
Use this rule to prevent multiple entries with the same key in mappings.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "enable"}
yamllint.json
key-ordering
Use this rule to enforce alphabetical ordering of keys in mappings.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "disable"}
yamllint.json
line-length
Use this rule to set a limit to lines length.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"max": {"type": "number", "default": 80}, "allow-non-breakable-words": {"type": "boolean", "default": true}, "allow-non-breakable-inline-mappings": {"type": "boolean", "default": true}}}], "default": "enable"}
yamllint.json
max
Defines the maximal (inclusive) length of lines.
{"type": "number", "default": 80}
yamllint.json
allow-non-breakable-words
Used to allow non breakable words (without spaces inside) to overflow the limit.
{"type": "boolean", "default": true}
yamllint.json
allow-non-breakable-inline-mappings
Implies allow-non-breakable-words and extends it to also allow non-breakable words in inline mappings.
{"type": "boolean", "default": true}
yamllint.json
new-line-at-end-of-file
Use this rule to require a new line character ( ) at the end of files.
{"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "enable"}