accelerator.json

title: choices

description: A list of predefined choices

title: text

description: The displayed text

title: value

description: The value that the form returns for this choice

title: choices

const: string

const: number

const: boolean

title: dataType

description: The option data type

title: defaultValue

description: The value used to pre-populate the option

$ref: #/definitions/DependsOn

title: dependsOn

description: The dependency that controls this options visibility

title: description

description: A tooltip to accompany the input

enum: text textarea checkbox select radio

title: inputType

description: The HTML input type used to display the option

title: label

description: A human-readable version of the name identifying the option

title: name

description: A unique, camelCase name

title: required

description: Whether the user is required to enter a value in the UI

$ref: #/definitions/Pattern

title: validationRegex

description: A regex that validates the string representation of the option value when set

title: applyTo

description: The path patterns used to filter which files to apply the Transforms to

title: applyTo

$ref: #/definitions/Expression

title: condition

description: The SpEL expression that determines if this Transform should execute

title: name

description: The transform name

title: transformations

description: A list of child Transforms to apply sequentially

const: Chain

title: applyTo

title: applyTo

title: chain

title: condition

title: exclude

description: The path patterns used to filter which files to exclude

title: exclude

title: include

description: The path patterns used to filter which files to include

title: include

title: let

description: A list of additional variables and their values

$ref: #/definitions/DerivedSymbol

title: let

title: merge

description: A list of child Transforms to be executed in parallel

title: name

description: The transform name

$ref: #/definitions/ConflictResolution

title: onConflict

description: How conflict is handled when an operation produces multiple files at the same path

const: Combo

enum: Fail UseFirst UseLast Append FavorOwn FavorForeign NWayDiff

title: name

description: The options name

title: value

description: The desired options value to compare against

title: expression

description: The SpEL expression to evaluate to compute the symbol value

title: name

description: The name under which the new symbol will be added

title: condition

title: name

description: The transform name

title: patterns

title: patterns

const: Exclude

title: condition

title: name

description: The transform name

title: patterns

title: patterns

const: Include

title: anchor

title: condition

title: let

title: let

title: name

description: The transform name

title: reference

title: condition

title: name

description: The transform name

title: noShadow

description: Whether shadowing should be turned off

title: symbols

title: symbols

title: condition

title: index

description: The variable's name to be assigned to the index of the current element on each iteration

title: name

description: The transform name

title: on

description: A SpEL expression that evaluates a list that contains the elements to be iterated over

title: var

description: The name of the variable to be assigned to the current element on each iteration

title: condition

title: name

description: The transform name

title: sources

title: condition

title: name

description: The transform name

title: options

description: Keys and values that depend on the class of the recipe

title: parseOrFail

title: recipe

description: Full qualified classname of the recipe

title: condition

title: name

description: The transform name

title: condition

title: name

description: The transform name

title: pattern

description: The regular expression that determines text that will be replaced

title: with

description: The SpEL expression that evaluates to the text that will replace the previous string

title: regex

description: The replacement rule using a single regular expression

title: substitutions

description: The replacement rules using literal text tokens

title: text

description: The text that will be replaced

title: with

title: substitutions

title: condition

title: matchOrFail

description: Whether an error should occur if the regex doesn't match

title: name

description: The transform name

title: regex

description: The regular expression used to match each input files path

title: rewriteTo

description: The SpEL expression of the location that the file will be rewritten to

title: condition

title: name

description: The transform name

title: strategy

title: condition

title: encoding

description: The encuding to use, as recognized by the java java.nio.charset.Charset class

title: name

description: The transform name

title: allowList

description: A list of variable names that are allowed to be passed to YTT

title: allowList

title: condition

title: denyList

description: A list of variable names that are denied from being passed to YTT

title: denyList

title: extraArgs

description: A list of SpEL expressions whose results are additional command line arguments

title: extraArgs

title: name

description: The transform name

title: description

description: A more detailed description

title: displayName

description: A human-readable name

title: iconUrl

description: A URL pointing to an icon image

title: imports

description: The list of fragment to import

title: expose

description: The list of fragment options to make available as accelerator options

title: as

description: The alias to use as the name of the option

title: dependsOn

title: name

description: The original name of the option

title: expose

title: exposeTypes

description: The list of fragment types to make available as accelerator types

title: as

description: The alias to use as the name of the type

title: name

description: The original name of the type

title: exposeTypes

title: name

description: The name of the fragment to import

title: imports

title: options

description: The list of options passed to the UI to create input text boxes

title: options

title: tags

description: A list of tags used to filter accelerators

title: tags

title: types

description: The definitions of custom types

title: name

description: The capitalized name of this custom type

title: struct

description: A sequence of option definitions

title: struct

title: types

title: accelerator

description: The metadata (non-behavioral) part of an App Accelerator's accelerator.yaml file


helm-testsuite.json

type: object

description: A helm test suite is a collection of tests with the same purpose and scope defined in one single file.

type: string

description: The suite name to show on test result output.

markdownDescription:
**suite** (string) _optional_

The suite name to show on test result output.

$ref: #/definitions/values

$ref: #/definitions/templates

$ref: #/definitions/release

$ref: #/definitions/capabilities

$ref: #/definitions/chart

type: array

description: Where you define your test jobs to run

markdownDescription:
**tests** (array<object>) _required_

Where you define your test jobs to run

description: Define the name of the test with TDD style or any message you like.

markdownDescription:
**it** (string) _recommended_

Define the name of the test with TDD style or any message you like.

description: The values files used to renders the chart, think it as the -f, --values options of helm install. The file path should be the relative path from the test suite file itself.

markdownDescription:
**values** (array<string>) _optional_

The values files used to renders the chart, think it as the `-f, --values` options of `helm install`. The file path should be the relative path from the test suite file itself.

description: Set the values directly in the suite file. The key is the value path with the format just like --set option of helm install, for example image.pullPolicy. The value is anything you want to set to the path specified by the key, which can be even an array or an object.

markdownDescription:
**set** (object) _optional_

Set the values directly in the suite file. The key is the value path with the format just like `--set` option of `helm install`, for example `image.pullPolicy`.

The value is anything you want to set to the path specified by the key, which can be even an array or an object.

markdownDescription:
**template** (string) _optional_

The template file(s) which render the manifest to be tested, default to the list of template file defined in templates of suite file, unless template is defined in the assertion(s).

$ref: #/definitions/documentIndex

description: The assertions to validate the rendered chart.

markdownDescription:
**asserts** (array<object>) _required_

The assertions to validate the rendered chart.

type: boolean

description: Set to true to assert contrarily, default to false.

markdownDescription:
**not** (boolean) _optional_

Set to `true` to assert contrarily, default to `false`.

description: The template file which render the manifest to be asserted, default to the list of template files defined in templates of the suite file, unless the template is in the testjob.

markdownDescription:
**template** (string) _optional_

The template file which render the manifest to be asserted, default to the list of template files defined in `templates` of the suite file, unless the template is in the testjob.

description: Assert the value of the specified path is equal to the value.

markdownDescription:
**equal** (object)

Assert the value of the specified path is equal to the value.

required: path value

$ref: #/definitions/assertion/path

description: The expected value.

markdownDescription:
**value** (object) _requried_

The expected value.

description: Decode the base64 before checking.

markdownDescription:
**decodeBase64** (boolean) _optional_

Decode the base64 before checking.

description: Assert equal to the raw value.

markdownDescription:
**equal** (object)

Assert equal to the raw value.

description: Assert the expected value in a NOTES.txt file.

markdownDescription:
**value** (string) _required_

Assert the expected value in a `NOTES.txt` file.

description: Assert if the specified path exists.

markdownDescription:
**exists** (object)

Assert if the specified path `exists`.

description: Assert if the specified path NOT exists.

markdownDescription:
**notExists** (object)

Assert if the specified path NOT `exists`.

description: Assert the value of specified path NOT equal to the value.

markdownDescription:
**notEqual** (object)

Assert the value of specified path NOT equal to the value.

description: The value expected not to be.

markdownDescription:
**value** (object) _required_

The value expected not to be.

description: Decode the base64 before checking.

description: Assert equal NOT to the value.

markdownDescription:
**notEqualRaw** (object)

Assert equal NOT to the value.

description: Assert the expected value in a NOTES.txt file not to be.

markdownDescription:
**value** (string) _required_

Assert the expected value in a `NOTES.txt` file not to be.

description: Assert the value of specified path match pattern.

markdownDescription:
**matchRegex** (object)

Assert the value of specified path match pattern.

required: path pattern

description: The regex pattern to match (without quoting /).

markdownDescription:
**pattern** (string) _required_

The regex pattern to match (without quoting `/`).

description: Decode the base64 before checking.

description: Assert the value match pattern.

markdownDescription:
**matchRegexRaw** (object)

Assert the value match pattern.

description: The regex pattern to match (without quoting /) in a NOTES.txt file.

markdownDescription:
**pattern** (string) _required_

The regex pattern to match (without quoting `/`) in a `NOTES.txt` file.

description: Assert the value of specified path NOT match pattern.

markdownDescription:
**notMatchRegex** (object)

Assert the value of specified path NOT match pattern.

description: The regex pattern NOT to match (without quoting /).

markdownDescription:
**pattern** (string) _required_

The regex pattern NOT to match (without quoting `/`).

description: Decode the base64 before checking.

description: Assert the value NOT match pattern.

markdownDescription:
**notMatchRegexRaw** (object)

Assert the value NOT match pattern.

description: The regex pattern NOT to match (without quoting /) in a NOTES.txt file.

markdownDescription:
**pattern** (string) _required_

The regex pattern NOT to match (without quoting `/`) in a `NOTES.txt` file.

description: Assert the array as the value of specified path contains the content.

markdownDescription:
**contains** (object)

Assert the array as the value of specified path contains the content.

required: path content

description: The content to be contained.

markdownDescription:
**content** (object) _required_

The content to be contained.

type: integer

description: The count of content to be contained.

markdownDescription:
**count** (integer) _optional_

The count of content to be contained.

description: Ignores any other values within the found content.

markdownDescription:
**any** (boolean) _optional_

Ignores any other values within the found content.

description: Assert the array as the value of specified path NOT contains the content.

markdownDescription:
**notContains** (object)

Assert the array as the value of specified path NOT contains the content.

description: The content NOT to be contained.

markdownDescription:
**content** (object) _required_

The content NOT to be contained.

description: Assert the value of specified path is null or empty (null, "", 0, [], {}).

markdownDescription:
**isNullOrEmpty** (object)

Assert the value of specified path is null or empty (`null`, `""`, `0`, `[]`, `{}`).

description: Assert the value of specified path is NOT null or empty (null, "", 0, [], {}).

markdownDescription:
**isEmpty** (object)

Assert the value of specified path is NOT null or empty (`null`, `""`, `0`, `[]`, `{}`).

description: Assert the kind value of manifest.

markdownDescription:
**isKind** (object)

Assert the `kind` value of manifest.

description: Expected kind of manifest.

markdownDescription:
**of** (string) _required_

Expected `kind` of manifest.

description: Assert the apiVersion value of manifest.

markdownDescription:
**isAPIVersion** (object)

Assert the `apiVersion` value of manifest.

description: Expected apiVersion of manifest.

markdownDescription:
**of** (string) _required_

Expected `apiVersion` of manifest.

description: Assert the object as the value of specified path that contains the content.

markdownDescription:
**isSubset** (object)

Assert the object as the value of specified path that contains the content.

description: The content to be contained.

markdownDescription:
**isNotSubset** (object)

Assert the object as the value of specified path that NOT contains the content.

description: The content NOT to be contained.

description: Assert the documents count rendered by the template specified. The documentIndex option is ignored here.

markdownDescription:
**hasDocuments** (object)

Assert the documents count rendered by the `template` specified. The `documentIndex` option is ignored here.

description: Expected count of documents rendered.

markdownDescription:
**count** (integer) _required_

Expected count of documents rendered.

markdownDescription:
**lengthEqual** (object)

Assert the spec count rendered by the `path|paths` specified.

description: Expected count of spec rendered.

markdownDescription:
**count** (integer) _required_

Expected count of spec rendered.

$ref: #/definitions/assertion/paths

description: Assert the count rendered by the template specified to be equal. The documentIndex option is ignored here.

markdownDescription:
**notLengthEqual** (object)

Assert the spec count rendered by the `path|paths` specified NOT to be equal.

description: Expected count of spec rendered.

description: Asserts the documents rendered by the kind and apiVersion specified.

markdownDescription:
**containsDocument** (object)

Asserts the documents rendered by the `kind` and `apiVersion` specified.

description: Expected kind of manifest.

markdownDescription:
**kind** (string) _required_

Expected `kind` of manifest.

description: Expected apiVersion of manifest.

markdownDescription:
**apiVersion** (string) _required_

Expected `apiVersion` of manifest.

description: The value of the metadata.name.

markdownDescription:
**name** (string) _optional_

The value of the `metadata.name`.

description: The value of the metadata.namespace.

markdownDescription:
**namespace** (string) _optional_

The value of the `metadata.namespace`.

description: Assert the value of path is the same as snapshotted last time.

markdownDescription:
**matchSnapshot** (object)

Assert the value of `path` is the same as snapshotted last time.

description: Assert the value in the NOTES.txt is the same as snapshotted last time.

markdownDescription:
**matchSnapshotRaw**

Assert the value in the NOTES.txt is the same as snapshotted last time.

description: Assert the value of errorMessage is the same as the human readable template error.

markdownDescription:
**failedTemplate** (object)

Assert the value of `errorMessage` is the same as the human readable template error.

description: The (human readable) errorMessage that should occur.

markdownDescription:
**failedTemplate** (string) _required_

The (human readable) `errorMessage` that should occur.

description: Assert that no failure occurs while templating.

markdownDescription:
**notFailedTemplate** (object)

Assert that no failure occurs while templating.

description: The set of paths to assert.Map keys in path containing periods (.) are supported with the use of a jq-like syntax.

markdownDescription:
**templates** (array<string>) _optional_
. List of specs for length comparison.

description: The set path to assert. Map keys in path containing periods (.) are supported with the use of a jq-like syntax.

markdownDescription:
**path** (string) _required_

The `set` path to assert.

Map keys in path containing periods (.) are supported with the use of a jq-like syntax.

description: Define the {{ .Capabilities }} object.

markdownDescription:
**capabilities** (object) _optional_

Define the `{{ .Capabilities }}` object.

markdownDescription:
**majorVersion** (string) _optional_

The kubernetes major version, default to the major version which is set by helm.

markdownDescription:
**minorVersion** (string) _optional_

The kubernetes minor version, default to the minor version which is set by helm.

markdownDescription:
**apiVersions** (array<string>) _optional_

A set of versions, default to the versionset used by the defined kubernetes version.

description: Define the {{ .Chart }} object.

markdownDescription:
**chart** (object) _optional_

Define the `{{ .Chart }}` object.

description: The semantic version of the chart, default to the version set in the Chart.

markdownDescription:
**version** (string) _optional_

The semantic version of the chart, default to the version set in the Chart.

description: The app-version of the chart, default to the app-version set in the Chart.

markdownDescription:
**appVersion** (string) _optional_

The app-version of the chart, default to the app-version set in the Chart.

markdownDescription:
**documentIndex** (integer) _optional_

The index of rendered documents (divided by ---) to be tested, default to -1, which results in asserting all documents (see Assertion).

Generally you can ignored this field if the template file render only one document.

description: Define the {{ .Release }} object.

markdownDescription:
**release** (object) _optional_

Define the `{{ .Release }}` object.

description: The release name, default to "RELEASE-NAME".

markdownDescription:
**name** (string) _optional_

The release name, default to `"RELEASE-NAME"`.

description: The namespace which release be installed to, default to "NAMESPACE".

markdownDescription:
**namespace** (string) _optional_

The namespace which release be installed to, default to `"NAMESPACE"`.

description: The revision of current build, default to 0.

markdownDescription:
**revision** (string) _optional_

The revision of current build, default to `0`.

description: Whether the build is an upgrade, default to false.

markdownDescription:
**upgrade** (boolean) _optional_

Whether the build is an upgrade, default to `false`.

description: The template files scope to test in this suite. The full chart will be rendered, however only the listed templates are filtered for validation. Template files that are put in a templates sub-folder can be addressed with a linux path separator. Also the templates/ can be omitted. Partial templates (which are prefixed with and _) are added automatically even if it is in a templates sub-folder, you don't need to add them again.

markdownDescription:
**templates** (array<string>) _recommended_

The template files scope to test in this suite. The full chart will be rendered, however only the listed templates are filtered for validation.

 Template files that are put in a templates sub-folder can be addressed with a linux path separator. Also the `templates/` can be omitted.

Partial templates (which are prefixed with and _) are added automatically even if it is in a templates sub-folder, you don't need to add them again.

description: The test values to apply for rendering of this chart.

markdownDescription:
**values** (array<string>) _recommended_

.The test values to apply for rendering of this chart.


aerleon-definitions.schema.json

title: Aerleon Network & Service Definitions

title: Network Definition Section

description: Policy files can reference the networks in this section by name. A network is a list of IP addresses or CIDR IP address ranges and may contain other networks.

$ref: #/$defs/networkDefinition

$ref: #/$defs/token

title: Service Definition Section

description: Policy files can reference the services in this section by name. A service is a list of port/protocol pairs (e.g. port: 80, protocol: tcp) and can include port ranges. A service can include other services.

$ref: #/$defs/serviceDefinition

description: Attach a comment directly to a value. This comment may be included in generated output on platforms that support it.

description: Specifies an IP address or CIDR IP address range expression.

description: Specifies a fully qualified domain name with two or more labels.

description: Specifies a port or port range.

description: Specifies a protocol by name or number.

title: Network Definition

description:
Defines a named network, composed of IP addresses, IP address ranges, and references to other networks.
An object with the "address" property adds that address or address range to the network.
An object with the "name" property includes the contents of that network into this one.
A single string also includes the content of that network into this one.

title: Network Reference

description: Include another network by name.

$ref: #/$defs/address

$ref: #/$defs/comment

$ref: #/$defs/fqdn

title: Network Reference

description: Include another network by name.

title: Service Definition

description: Defines a named service, composed of portocol, port pairs and/or references to other services.

required: port protocol

$ref: #/$defs/port

$ref: #/$defs/protocol

title: Service Reference

description: Include another service by name.

description: Include another service by name.


spacefile.schema.json

$ref: #/definitions/spacefile

title: Spacefile

description: Space app configuration

description: Version number of the Spacefile

description: Path to an icon image file (PNG or WebP file of 512x512 pixels)

description: Display name of the app

description: List of Micros in the app

$ref: #/definitions/micro

required: v micros

title: Micro

description: Micro configuration

description: Name of the Micro

description: Relative path to the root directory of the Micro

description: Runtime engine for the Micro

enum: static react svelte vue next nuxt svelte-kit python3.9 python3.8 nodejs16 custom

description: If the Micro should be the entry point for the app

description: Path relative to the hostname this Micro should receive requests on

description: Directory path relative to the Micro's path that should be served for the static Micro

description: Commands to run before packaging the Micro

description: Files and directories in the Micro's source directory that should be part of the final app package

description: Command to start the Micro

description: Command to start the Micro in development mode

$ref: #/definitions/presets

description: Routes that will be available publicly

description: If the Micro should be available to the public

description: Tasks that run on triggers like a schedule

$ref: #/definitions/action

required: name src engine

$comment: If engine is static, then serve is required

const: static

$comment: public and public_routes are mutually exclusive

$comment: If engine is static or static-like, then include is not allowed, otherwise serve is not allowed

enum: static react vue svelte

title: Presets

description: Presets to use for the Micro

description: Environment variables that the user can set for a Micro

$ref: #/definitions/env

description: Enable the use of API keys to access private routes of a Micro

title: Env

description: Environment variable

description: Name of the environment variable

description: Human readable description

description: Default value of the environment variable

title: Action

description: Action configuration

description: Unique identifier for the action (needs to be unique across the app)

description: Human readable name for the action (needs to be unique across the app)

description: Human readable description for the action

description: Trigger for the action

default: schedule

description: Interval at which the schedule will run

description: Path of the Micro that will handle the action request

required: id name trigger default_interval


bounded-context.json

title: Bounded Context Configuration

description: The bounded context configuration

description: The application id that represents the application that this bounded context is a part of

description: The bounded context id that represents this bounded context

description: The bounded context name that represents the name of this bounded context

$ref: #/definitions/coreConfiguration

description: A list of configurations for the interaction layers that this bounded context exposes

description: A map of describing the resource type implementation mapping of resource types

required: readModels eventStore

required: application boundedContext boundedContextName core interaction resources

description: A configuration describing the Core of this bounded context

$comment: This schema definition allows only a set of core languages by hard coding it here in the enum property. Can probably be done better

description: Describes which programming language the Core is written in

$comment: This property is optional. The default value is "Core"

description: The entry point of the bounded context's Core.  A relative path to the folder

format: uri-reference

description: The configuration of an interaction layer

$comment: This schema definition allows only a set of types by hard coding it here in the enum property. Can probably be done better

description: The type of the interaction layer

description: The programming language of the interaction layer

description: The entry point of the interaction layer. A relative path to the folder

$comment: This schema definition allows only a set of frameworks by hard coding it here in the enum property. Can probably be done better

description: The framework of the interaction layer

enum: react aurelia

required: type language entryPoint

description: Resource type implementation configuration

required: production development


pre-commit-config.json

default: meta

default: local

description:
A list of local hooks
https://pre-commit.com/#2-add-a-pre-commit-configuration

required: id name entry language

description:
A repository url
https://pre-commit.com/#2-add-a-pre-commit-configuration

description:
A revision or tag to clone at
https://pre-commit.com/#2-add-a-pre-commit-configuration

description:
A list of hook mappings
https://pre-commit.com/#pre-commit-configyaml---hooks.

description:
An identifier of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
An additional identifier of the current hook for `pre-commit run <hookid>`
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A name of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A language version of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A pattern to include files to run on of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A pattern to exclude files from `files` to run on of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A list of file types to run on combined via logical `and` of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A list of file types to run on combined via logical `or` of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A list of file types to exclude of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
List of additional parameters to pass to the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A stage of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A list of additional_dependencies of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
Run the current hook when no files matched
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
Display an output of the current hook even it passes
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
A command of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks

description: A log file of the current hook

description:
A language the current hook is written in
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
Whether to pass filenames to the current hook or not
https://pre-commit.com/#pre-commit-configyaml---hooks

description:
pre-commit.ci specific settings
https://pre-commit.ci/#configuration

description:
A commit message for pull request autofixes
https://pre-commit.ci/#configuration

default:
[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

description:
Whether to autofix pull requests
https://pre-commit.ci/#configuration

description:
A branch to send pull request's autoupdate to
https://pre-commit.ci/#configuration

description:
A commit message for autoupdate pull requests
https://pre-commit.ci/#configuration

default: [pre-commit.ci] pre-commit autoupdate

description:
An autoupdate frequency
https://pre-commit.ci/#configuration

default: weekly

enum: weekly monthly quarterly

description:
List of skipped hook's ids
https://pre-commit.ci/#configuration

description:
Whether to recursively check out submodules
https://pre-commit.ci/#configuration

description:
Repository mappings of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level

description:
Mappings for the default language versions of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level

description:
The default stages of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level

description:
A file include pattern of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level

description:
A file exclude pattern of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level

description:
Whether stop running hooks after a first failure
https://pre-commit.com/#pre-commit-configyaml---top-level

description:
A minimum version of pre-commit
https://pre-commit.com/#pre-commit-configyaml---top-level

title: JSON schema for .pre-commit-config.yaml


lefthook.json

description: Skip all or specific commands and scripts

description: Force the command, script, or hook to execute only in certain conditions. This acts like the opposite of skip.

description: Specify tags for commands and scripts, useful for excluding

description: Specify environment variables for the command or script.

description: Text to show when the command or script fails.

description: Only for the 'pre-commit' hooks, this automatically calls 'git add' after running the command or script.

description: Whether to use interactive mode and provide a STDIN for a command or script.

$ref: #/definitions/Skip

$ref: #/definitions/Only

description: A custom git command for files to be referenced in {files} template.

description: Whether run commands and scripts concurrently.

description: Whether run commands and scripts sequentially. Will stop execution if one of the commands/scripts fail.

description: Follow the STDOUT of the running commands and scripts.

description: Tags or command names that you want to exclude.

description: Commands to be executed for the hook.

$ref: #/definitions/Command

description: Scripts to be executed for the hook.

$ref: #/definitions/Script

description: The command that is executed for the hook

$ref: #/definitions/Tags

description: Set a glob to filter files for your command.

description: Custom Git commit for files to be referenced in {files} template for the 'run' setting.

$ref: #/definitions/Env

description: Change the CWD for the command you execute.

description: Provide a regular expression to exclude some files from being passed to the 'run' command.

$ref: #/definitions/FailText

$ref: #/definitions/StageFixed

$ref: #/definitions/Interactive

description: Whether enable or disable colorful output of Lefthook.

type: number

description: Whether hide spinner and other interactive things.

description: Specify files to extend config with.

description: Specify a minimum version for the lefthook binary.

description: Manage verbosity by skipping the printing of output of some steps.

enum: meta success failure summary execution execution_out execution_info skips

description: Change a directory for script files. Directory for script files contains folders with git hook names which contain script files.

default: .lefthook/

description: Change a directory for local script files (not stored in VCS).

default: .lefthook-local/

description: Provide an rc file, which is actually a simple sh script

description: Remote configs enable sharing of lefthook configuration across many projects.

description: A URL to Git repository. It will be accessed with priveleges of the machine lefthook runs on.

description: An optional branch or tag name.

description: An optional config path from remote's root.

$ref: #/definitions/GitHook


title: transcend.yml

description: Define personal data schema in code using Transcend.

required: title output-identifiers

required: name value

required: name type

enum: MULTI_SELECT SINGLE_SELECT TEXT EMAIL TELEPHONE URL ASSESSMENT

enum: actionItem dataSilo subDataPoint airgapCookie airgapDataFlow request vendor businessEntity dataSubCategory processingPurposeSubCategory

enum: EU AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO VG BN BG BF BI KH CM CA CV BQ KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE SZ ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF KP MK MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS KR SS ES LK BL SH KN LC MF PM VC SD SR SJ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UM VI UG UA AE GB US UY UZ VU VA VE VN WF EH YE ZM ZW

required: key values

enum: DISABLED AUTO FORM

enum: ESSENTIAL ADDITIONAL_FUNCTIONALITY ADVERTISING MARKETING ANALYTICS PERSONALIZATION OPERATION_SECURITY LEGAL TRANSFER SALE HR OTHER UNSPECIFIED

enum: FINANCIAL HEALTH CONTACT LOCATION DEMOGRAPHIC ID ONLINE_ACTIVITY USER_PROFILE SOCIAL_MEDIA CONNECTION TRACKING DEVICE SURVEY OTHER UNSPECIFIED NOT_PERSONAL_DATA

enum: QuickOptions QuickOptions3 AcceptAll AcceptAllRejectAllToggle AcceptAllOrMoreChoices AcceptOrRejectAll AcceptOrRejectAllOrMoreChoices AcceptOrRejectAnalytics AcceptOrRejectAdvertising NoticeAndDoNotSell DoNotSellExplainer PrivacyPolicyNotice CompleteOptions CompleteOptionsInverted Hidden

enum: om ab aa af sq am ar-DZ ar-BH ar-EG ar-IQ ar-JO ar-KW ar-LB ar-LY ar-MA ar-OM ar-QA ar-SA ar-SY ar-TN ar-AE ar-YE ar hy as ay az ba eu be bn dz bh bi br bg-BG bg my km ca zh-CN zh-HK zh-MO zh-SG zh-TW zh co hr-HR hr cs-CZ cs da-DK da div nl-BE nl-NL nl en-AU en-BZ en-CA en-IE en-JM en-NZ en-PH en-ZA en-CH en-TT en-GB en-US en-ZW us eo et et-EE fo fa fj fi-FI fi fr-BE fr-CA fr-FR fr-LU fr-MC fr-CH fr fy mk gd gl ka de-AT de-DE de-LI de-LU de-CH de el-GR el kl gn gu ha iw hi hu-HU hu is is-IS in ia ie ik ga ga-IE it-IT it-CH it ja jw kn ks kk rw ky rn kok ko ku kz lo la lv lv-LV ln lt-LT lt mg ms ml mt mt-MT mi mr mo mn na ne no nb nn no-NO nb-NO nn-NO oc or ps pl-PL pl pt-BR pt-PT pt-CH pt pa qu rm ro-MD ro-RO ro ru-MD ru sm sg sa sr sh st sn sd si ss sk sk-SK sl sl-SI so sb es-AR es-BO es-CL es-CO es-CR es-DO es-EC es-SV es-ES es-GT es-HN es-MX es-NI es-PA es-PY es-PE es-PR es-US es-UY es-VE es su sx sw sv-FI sv-SE sv gsw gsw-LI gsw-CH syr tl tg ta tt te th bo ti to ts tn tr tk tw uk ur uz vi vo cy wo xh yi yo zu

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/La_Rioja America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Fort_Nelson America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Monticello America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Colombo Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Hebron Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Katmandu Asia/Khandyga Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ulaanbaatar Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/Perth Australia/Sydney Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis


vim-addon-info.json

format: uri

enum: hg git svn bzr

description: Info for the plugin itself. Describes where the canonical copy of the plugin can be fetched from.

$ref: #/definitions/repoType

$ref: #/definitions/url

description: For a deprecated plugin, a deprecation message to be shown to any user who installs the plugin.

description: Info about a plugin/repository outside this one.

$comment: Empty repository info. Used to declare plugin with the given name is required without specifying any explicit details about how to fetch it (e.g., if name can be looked up in a predefined package index).

$comment: Repository with empty type and url pointing to local path.

description: Script ID number of the target plugin on www.vim.org, if any.

enum:
color scheme
ftplugin
game
indent
syntax
utility
patch

$comment: Explicit remote repository.

required: type url

description: Primary homepage of the plugin.

$comment: Addon information for the other plugin in case it does not supply its own addon-info file.

description: The name of the plugin. Used by plugin managers and some introspection tools. Generally corresponds to the name of the repository but without "vim" prefix/suffix.

examples: surround.vim nerdtree maktaba

description: Dotted version number of the plugin, generally in semantic versioning scheme.

description: Short description of the plugin and what it does (a sentence or two)

description: Primary homepage of the plugin.

description: Name of the person or organization that created the plugin

examples:
Priya Exampleton
Example Industries

description: Name of the person who maintains the plugin

$ref: #/definitions/selfRepository

description: Plugins that are strictly required for the plugin to work, where keys are plugin names and values may describe where plugins can be fetched from.

$ref: #/definitions/otherRepository

title: JSON schema for vim plugin addon-info.json metadata files


gpc.json

description: Configuration for GPC, so a site can convey its support for the Global Privacy Control.

title: Global Privacy Control

description: Indicates that the server intends to abide by GPC requests.

title: Version

title: Last Update

description: This indicates the time at which the statement of support was made, such that later changes to the meaning of the GPC standard should not affect the interpretation of the resource for legal purposes. If the member is not in a valid ISO 8601 format, the last update date and time is unknown.

title: Global Privacy Control


settings.job.json

description: The graceful shutdown period for an Azure Webjob. The time specified in seconds.

description: Specify if the Webjob should be treated as a singleton. If true, the Webjob will not scale on multiple Azure Website instances like the web application itself.

title: JSON schema for Azure Webjob settings.job files


appsemblerc.schema.json

title: .appsemblerc.yaml

description: A .appsemblerc.yaml file may be used to configure either an app or a block.

description: The name of a block. By default the name in package.json is used.

description: A short description of the block. By default the description in package.json is used.

description: A semantic version of the block representation of the block version. By default the version in package.json is used.

description: The long description of the block. Markdown is supported. By default the content of README.md is used.

description: The type of layout to be used for the block.

default: static

description: Where to read build output from.

description: The path to the webpack configuration file relative to the block project directory. By default a file named webpack.config.js is used, with a fallback to the webpack configuration from @appsemble/webpack-config.

description: An object describing the names of the events the block can listen and emit to. By default this is extracted from the block’s TypeScript module augmentations.

description: The events the block listens on.

description: The events the block may emit.

description: An object which describes the actions a block can trigger. This will be used to validate app definitions. By default this is extracted from the block’s TypeScript module augmentations.

description: A JSON schema which describes the block parameters. By default this is extracted from the block’s TypeScript module augmentations.

description: The background color to use for maskable icons.

description: A context which can be specified using the --context command line parameter.

description: If remote is specified, this will override --remote passed by the command line.

description: If organization is specified, this will override --organization passed by the command line when creating an app.

description: A path to the app icon to use

description: A path to the maskable app icon to use

description: If id is specified, this will override --id passed by the command line when updating an app.

description:
Determine the app visibility of the app in the Appsemble app store.

This doesn’t affect whether or not the app can be accessed on its own domain.

- **public**: The app is publicly listed in the Appsemble app store.,
- **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the Appsemble app store.
- **private**: The app is only visible to people who are part of the organization.

default: unlisted

enum: public unlisted private

description: Whether or not people who have access to the app may see the app definition.

description: If template is specified, this will override --template passed on the command line.

description: A custom Sentry DSN to use for the app.

description: A custom Sentry environment to use for the app.


$ref: #/$defs/ruleProperties


circleciconfig.json

description:
https://circleci.com/docs/configuration-reference#logic-statements

A logical statement to be used in dynamic configuration

type: string boolean integer number

description:
https://circleci.com/docs/configuration-reference#logic-statements

Logical and: true when all statements in the list are true

$ref: #/definitions/logical

description:
https://circleci.com/docs/configuration-reference#logic-statements

Logical or: true when at least one statements in the list is true

description:
https://circleci.com/docs/configuration-reference#logic-statements

Logical not: true when statement is false

description:
https://circleci.com/docs/configuration-reference#logic-statements

True when all elements in the list are equal

description:
https://circleci.com/docs/configuration-reference#logic-statements

True when value matches the pattern

description: A map defining rules for execution on specific branches

description: Either a single branch specifier, or a list of branch specifiers

description:
https://circleci.com/docs/configuration-reference#orbs-requires-version-21

Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.

description:
https://circleci.com/docs/creating-orbs#semantic-versioning-in-orbs

An orb to depend on and its semver range, or volatile for the most recent release.

description:
https://circleci.com/docs/creating-orbs#creating-inline-orbs

Inline orbs can be handy during development of an orb or as a convenience for name-spacing jobs and commands in lengthy configurations, particularly if you later intend to share the orb with others.

$ref: #/definitions/orbs

$ref: #/definitions/commands

$ref: #/definitions/executors

$ref: #/definitions/jobs

description:
https://circleci.com/docs/configuration-reference#commands-requires-version-21

A command definition defines a sequence of steps as a map to be executed in a job, enabling you to reuse a single command definition across multiple jobs.

description:
https://circleci.com/docs/configuration-reference#commands-requires-version-21

Definition of a custom command.

description: A sequence of steps run inside the calling job of the command.

$ref: #/definitions/step

description:
https://circleci.com/docs/reusing-config#using-the-parameters-declaration

A map of parameter keys.

description:
https://circleci.com/docs/reusing-config#string

A string parameter.

description:
https://circleci.com/docs/reusing-config#boolean

A boolean parameter.

description:
https://circleci.com/docs/reusing-config#integer

An integer parameter.

description:
https://circleci.com/docs/reusing-config#enum

The `enum` parameter may be a list of any values. Use the `enum` parameter type when you want to enforce that the value must be one from a specific set of string values.

required: type enum

description:
https://circleci.com/docs/reusing-config#executor

Use an `executor` parameter type to allow the invoker of a job to decide what executor it will run on.

description:
https://circleci.com/docs/reusing-config#steps

Steps are used when you have a job or command that needs to mix predefined and user-defined steps. When passed in to a command or job invocation, the steps passed as parameters are always defined as a sequence, even if only one step is provided.

description:
https://circleci.com/docs/reusing-config#environment-variable-name

The environment variable name parameter is a string that must match a POSIX_NAME regexp (e.g. no spaces or special characters) and is a more meaningful parameter type that enables additional checks to be performed.

description: A string that describes the purpose of the command.

description: Options for the [docker executor](https://circleci.com/docs/configuration-reference#docker)

description: The name of a custom docker image to use

description: The name the container is reachable by. By default, container services are accessible through `localhost`

description: The command used as executable when launching the container

description: The command used as pid 1 (or args for entrypoint) when launching the container

description: Which user to run the command as

description: A map of environment variable names and values

type: string number boolean

description: Authentication for registries using standard `docker login` credentials

description: Authentication for AWS EC2 Container Registry (ECR)

description: Options for the [machine executor](https://circleci.com/docs/configuration-reference#machine)

description: The VM image to use. View [available images](https://circleci.com/docs/configuration-reference#available-machine-images). **Note:** This key is **not** supported on the installable CircleCI. For information about customizing machine executor images on CircleCI installed on your servers, see our [VM Service documentation](https://circleci.com/docs/vm-service).

description: Set to `true` to enable [Docker Layer Caching](https://circleci.com/docs/docker-layer-caching). Note: If you haven't already, you must open a support ticket to have a CircleCI Sales representative contact you about enabling this feature on your account for an additional fee.

default: true

description: Options for the [macOS executor](https://circleci.com/docs/configuration-reference#macos)

description: The version of Xcode that is installed on the virtual machine, see the [Supported Xcode Versions section of the Testing iOS](https://circleci.com/docs/testing-ios#supported-xcode-versions) document for the complete list.

$ref: #/definitions/dockerExecutor

$ref: #/definitions/machineExecutor

description: Use the default machine executor image

$ref: #/definitions/macosExecutor

description: Executors define the environment in which the steps of a job will be run, allowing you to reuse a single executor definition across multiple jobs.

$ref: #/definitions/executorChoice

description: Amount of CPU and RAM allocated to each container in a job. Note: A performance plan is required to access this feature.

default: medium

description: Shell to use for execution command in all steps. Can be overridden by shell in each step (default: See [Default Shell Options](https://circleci.com/docs/configuration-reference#default-shell-options)

description: In which directory to run the steps.

description: A map of environment variable names and values.

type: string number

description:
https://circleci.com/docs/configuration-reference#run

Used for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the `command` and `name`. Run commands are executed using non-login shells by default, so you must explicitly source any dotfiles as part of the command.

description:
https://circleci.com/docs/configuration-reference#checkout

Special step used to check out source code to the configured `path` (defaults to the `working_directory`). The reason this is a special step is because it is more of a helper function designed to make checking out code easy for you. If you require doing git over HTTPS you should not use this step as it configures git to checkout over ssh.

description:
https://circleci.com/docs/configuration-reference#setup_remote_docker

Creates a remote Docker environment configured to execute Docker commands.

description:
https://circleci.com/docs/configuration-reference#save_cache

Generates and stores a cache of a file or directory of files such as dependencies or source code in our object storage. Later jobs can restore this cache using the `restore_cache` step.

description:
https://circleci.com/docs/configuration-reference#restore_cache

Restores a previously saved cache based on a `key`. Cache needs to have been saved first for this key using the `save_cache` step.

description:
https://circleci.com/docs/configuration-reference#deploy

Special step for deploying artifacts. `deploy` uses the same configuration map and semantics as run step. Jobs may have more than one deploy step. In general deploy step behaves just like run with two exceptions:
* In a job with parallelism, the deploy step will only be executed by node #0 and only if all nodes succeed. Nodes other than #0 will skip this step.
* In a job that runs with SSH, the deploy step will not execute

description:
https://circleci.com/docs/configuration-reference#store_artifacts

Step to store artifacts (for example logs, binaries, etc) to be available in the web app or through the API.

description:
https://circleci.com/docs/configuration-reference#storetestresults

Special step used to upload test results so they display in builds' Test Summary section and can be used for timing analysis. To also see test result as build artifacts, please use the `store_artifacts` step.

description:
https://circleci.com/docs/configuration-reference#persist_to_workspace

Special step used to persist a temporary file to be used by another job in the workflow

description:
https://circleci.com/docs/configuration-reference#attach_workspace

Special step used to attach the workflow's workspace to the current container. The full contents of the workspace are downloaded and copied into the directory the workspace is being attached at.

description:
https://circleci.com/docs/configuration-reference#add_ssh_keys

Special step that adds SSH keys from a project's settings to a container. Also configures SSH to use these keys.

description:
https://circleci.com/docs/configuration-reference#the-when-step-requires-version-21

Conditional step to run on custom conditions (determined at config-compile time) that are checked before a workflow runs

description:
https://circleci.com/docs/configuration-reference#the-when-step-requires-version-21

Conditional step to run when custom conditions aren't met (determined at config-compile time) that are checked before a workflow runs

description: Command to run via the shell

description: Title of the step to be shown in the CircleCI UI (default: full `command`)

description: Shell to use for execution command

description: Additional environmental variables, locally scoped to command

description: Whether or not this step should run in the background (default: false)

description: In which directory to run this step (default: `working_directory` of the job

description: Elapsed time the command can run without output. The string is a decimal with unit suffix, such as "20m", "1.25h", "5s" (default: 10 minutes)

description: Specify when to enable or disable the step. Takes the following values: `always`, `on_success`, `on_fail` (default: `on_success`)

description: Title of the step to be shown in the CircleCI UI

description: Checkout directory (default: job's `working_directory`)

description: When `docker_layer_caching` is set to `true`, CircleCI will try to reuse Docker Images (layers) built during a previous job or workflow (Paid feature)

description: If your build requires a specific docker image, you can set it as an image attribute

description: List of directories which should be added to the cache

description: Unique identifier for this cache

description: Title of the step to be shown in the CircleCI UI (default: 'Saving Cache')

description: Single cache key to restore

description: Title of the step to be shown in the CircleCI UI (default: 'Restoring Cache')

description: List of cache keys to lookup for a cache to restore. Only first existing key will be restored.

description: Directory in the primary container to save as job artifacts

description: Prefix added to the artifact paths in the artifacts API (default: the directory of the file specified in `path`)

description: Path (absolute, or relative to your `working_directory`) to directory containing subdirectories of JUnit XML or Cucumber JSON test metadata files

description: Either an absolute path or a path relative to `working_directory`

description: Glob identifying file(s), or a non-glob path to a directory to add to the shared workspace. Interpreted as relative to the workspace root. Must not be the workspace root itself.

description: Directory to attach the workspace to

description: Directory to attach the workspace to

description: A list of steps to be performed

description: A list of steps to be performed

description:
https://circleci.com/docs/reusing-config#invoking-reusable-commands

A custom command defined via the top level commands key

description:
https://circleci.com/docs/using-orbs#commands

A custom command defined via an orb.

description: Run a job as part of this workflow

description: Jobs are run in parallel by default, so you must explicitly require any dependencies by their job name.

description: The name key can be used to ensure build numbers are not appended when invoking the same job multiple times (e.g., sayhello-1, sayhello-2). The name assigned needs to be unique, otherwise numbers will still be appended to the job name

description: Either a single context name, or a list of contexts. The default name is `org-global`

description: A job may have a `type` of `approval` indicating it must be manually approved before downstream jobs may proceed.

description:
https://circleci.com/docs/configuration-reference#matrix-requires-version-21

The matrix stanza allows you to run a parameterized job multiple times with different arguments.

description: A map of parameter names to every value the job should be called with

description: A list of argument maps that should be excluded from the matrix

description: An alias for the matrix, usable from another job's requires stanza. Defaults to the name of the job being executed

description: Jobs are collections of steps. All of the steps in the job are executed in a single unit, either within a fresh container or VM.

description: The name of the executor to use (defined via the top level executors map).

description: Executor stanza to use for the job

description: A list of steps to be performed

description: In which directory to run the steps. (default: `~/project`. `project` is a literal string, not the name of the project.) You can also refer the directory with `$CIRCLE_WORKING_DIRECTORY` environment variable.

description: Number of parallel instances of this job to run (default: 1)

description: A map of environment variable names and variables (NOTE: these will override any environment variables you set in the CircleCI web interface).

description: A map defining rules for whitelisting/blacklisting execution of specific branches for a single job that is **not** in a workflow (default: all whitelisted). See Workflows for configuring branch execution for jobs in a workflow.

description: The version field is intended to be used in order to issue warnings for deprecation or breaking changes.

description: Used for orchestrating all jobs. Each workflow consists of the workflow name as a key and a map as a value

description: The Workflows `version` field is used to issue warnings for deprecation or breaking changes during v2 Beta. It is deprecated as of CircleCI v2.1

description: Specifies which triggers will cause this workflow to be executed. Default behavior is to trigger the workflow when pushing to a branch.

description: A workflow may have a schedule indicating it runs at a certain time, for example a nightly build that runs every day at 12am UTC:

description: See the [crontab man page](http://pubs.opengroup.org/onlinepubs/7908799/xcu/crontab.html)

description: Specify when to run the workflow.

description: Specify when *not* to run the workflow.

title: JSON schema for CircleCI configuration files


clangd.json

description:
A path pattern
https://clangd.llvm.org/config.html#if

description:
A flag
https://clangd.llvm.org/config.html#compileflags

$ref: #/definitions/clangTidyCheck

description:
A diagnostic
https://clangd.llvm.org/config.html#clangtidy

title: conditions

description:
Conditions
https://clangd.llvm.org/config.html#if

description:
Path patterns
https://clangd.llvm.org/config.html#pathmatch

$ref: #/definitions/oneOrMorePath

description:
An exclude path pattern
https://clangd.llvm.org/config.html#pathexclude

title: compilation flags

description:
Flag lists to be added or removed
https://clangd.llvm.org/config.html#compileflags

description:
Flags to be added to the compile command
https://clangd.llvm.org/config.html#add

$ref: #/definitions/oneOrMoreFlags

examples: -xc++ -Wall

description:
Flags to be removed from the compile command
https://clangd.llvm.org/config.html#remove

description:
A directory to search for compilation database
https://clangd.llvm.org/config.html#compilationdatabase

description:
An `argv[0]` replacement
https://clangd.llvm.org/config.html#compiler

title: code interpretation

description: Code interpretation outside of the current file

description:
Whether to produce a project index from files built in the background
https://clangd.llvm.org/config.html#background

enum: Build Skip

default: Build

title: index source

description:
An external index source
https://clangd.llvm.org/config.html#external

pattern: [nN][oO][nN][eE]

description:
A file
https://clangd.llvm.org/config.html#external

description:
A server
https://clangd.llvm.org/config.html#external

description:
A mount point
https://clangd.llvm.org/config.html#external

description:
Whether to index a standard library
https://clangd.llvm.org/config.html#standardlibrary

enum: Yes No

title: style

description:
A code base style
https://clangd.llvm.org/config.html#style

description:
List of fully qualified namespaces
https://clangd.llvm.org/config.html#fullyqualifiednamespaces

title: diagnostics

description:
Diagnostics
https://clangd.llvm.org/config.html#diagnostics

description:
Diagnostic codes that to be suppressed
https://clangd.llvm.org/config.html#suppress

description:
A diagnostic code that to be suppressed
https://clangd.llvm.org/config.html#suppress

title: clangtidy options

description:
Clang-Tidy options
https://clangd.llvm.org/config.html#clangtidy

description:
Checks to enable
https://clangd.llvm.org/config.html#add-1

$ref: #/definitions/oneOrMoreDiagnostics

description:
Checks to disable
https://clangd.llvm.org/config.html#remove-1

description:
Check's options
https://clangd.llvm.org/config.html#checkoptions

readability-identifier-naming.VariableCase: CamelCase

description:
Whether to enable Include Cleaner's unused includes diagnostics
https://clangd.llvm.org/config.html#unusedincludes

title: completion options

description:
Completion options
https://clangd.llvm.org/config.html#completion

description:
Whether to include suggestions from scopes that are not visible
https://clangd.llvm.org/config.html#allscopes

title: inlay-hint options

description:
Inlay-hints options
https://clangd.llvm.org/config.html#inlayhints

description:
Whether to enable inlay-hints
https://clangd.llvm.org/config.html#enabled

description:
Whether to enable inlay-hints for parameter names in function calls
https://clangd.llvm.org/config.html#parameternames

description:
Whether to enable inlay-hints for deduced types
https://clangd.llvm.org/config.html#deducedtypes

description:
Whether to enable inlay-hints for designators in aggregate initialization
https://clangd.llvm.org/config.html#designators

title: hover options

description:
Hover card's options
https://clangd.llvm.org/config.html#hover

description:
Whether to display desugared types
https://clangd.llvm.org/config.html#showaka


JSON schema for IDE template host files


title: dprint configuration file

description: Schema for a dprint configuration file.

description: The JSON schema reference. Normally you shouldn't bother to provide this as the dprint vscode editor extension will handle constructing the schema for you based on the plugins provided.

description: Whether to format files only when they change.

description: Configurations to extend.

description: A file path or url to a configuration file to extend.

description: A collection of file paths and/or urls to configuration files to extend.

description: The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

description: The number of characters for an indent.

description: Whether to use tabs (true) or spaces (false) for indentation.

description: The kind of newline to use.

const: auto

description: For each file, uses the newline kind found at the end of the last line.

const: crlf

description: Uses carriage return, line feed.

const: lf

description: Uses line feed.

const: system

description: Uses the system standard (ex. crlf on Windows).

description: Array of patterns (globs) to use to find files to format.

description: Array of patterns (globs) to exclude files or directories to format.

description: Array of plugin URLs to format files.

description: Plugin configuration.


catalogue-entry-schema.json

title: Catalogue entry

required: description primaryContact filters searchTags

title: Primary contact

description: Contact details for the owner of the asset, i.e. the Product Owner.These details will be used when customers make enquiries or request access to the asset through the portal.

description: must end with `gov.uk`

Jo Doe

role: PO

title: Technical documentation

description: Allows you to provide paths to technical documentation to be published to the portal.

description: Path to the technical documentation, relative to the current working directory.

title: Filters

description: A list of filtering options to improve searchability on the portal. Please check the README file to check the valid combinations of `lifecycle`, `profile`, and `access`.

required: asset_type owner categories visibility lifecycle profile access

enum:
In Development
Pre-Prod
Prod

enum: Strategic Transitional

enum: Open Closed

enum: Deprecated Removed

const: Legacy

const: Closed

enum:
REST API
SOAP API
Event
Datasets

enum:
AME Payments
Citizen Income
Citizen Information
Document Repository Services
Integration
Legacy Bridge
Notifications Platform
Personal Independence Payment
Reference Data Service
Retirement, Bereavement & Care
Common Capabilities
Other

title: Categories

enum:
Address
Awards
Citizen
Data
Document Services
Financial
GUID
SMS
Other

enum: Internal Public

enum:
In Development
Pre-Prod
Prod
Deprecated
Removed

title: The profile Schema

enum: Strategic Transitional Legacy

asset_type: REST API

owner: Integration

visibility: Internal

lifecycle: Prod

profile: Transitional

access: Open

description: Tags to label the asset in order to increase discoverability. Minimum of 3 in CSV format.

title: Related assets

description: A list of other assets that are related to the asset being published. Must match the Asset ID on the related asset's business documentation page on the portal at https://gitlab.com/dwp/integration/api-exchange/exchange-content/-/tree/main/output/dwp/portal/workspaces/primary/content/_catalogueEntries.

description: This is an example service

lifecycle: Pre-Prod

access: Closed


servicehub.service.schema.json

description: The name of the host that should activate the service.

description: A non-empty value will cause this service to be activated on a dedicated host with this ID. All services with the same host / hostId combination will run in the same host process such that they may share global data. If unspecified or empty, a service will share its host process with other services that require the same host and also leave this field empty. If specified, the value must not have spaces in it.

description: A value of 'true' will allow a client to specify a host group when requesting this service.

description: Host-specific parameters that describe how to activate this service.

required: assemblyPath fullClassName

description: The path to the assembly that carries the service entrypoint class, relative to this file.

description: The full name of the class to instantiate (that accepts a Stream in its constructor) when a new client requests this service.

description: The path that the AppDomain hosting the service should be configured to consider the ApplicationBase, relative to this file.

description: The config file used to initialize the service's AppDomain. It may be omitted if the config file has the same name (+.config) as the service assembly, and resides in the same directory. It is also possible to have the service without the config file.

required: scriptPath constructorFunction

description: The path to the .js file to 'require', relative to this file.

description: The name of the constructor function to use (that accepts a stream) when a new client requests this service.

description: Defines the version of the service.

required: host entryPoint

title: Microsoft ServiceHub Service


title: CrowdSec Parser

$ref: #/$defs/data

description: If node is successful and onsuccess equals next_stage, event is moved to the next stage

description: If true, enables the debug. Default is false.

description:
nodes is a list of parser nodes, allowing you to build
trees. Each subnode must be valid, and if any of the subnodes
succeed, the whole node is considered successful.

$ref: #/$defs/statics

description: description of the parser usage

$ref: #/$defs/stash

$ref: #/$defs/grok

description:
Non mandatory format version for the parser. configuration
file. New features, may not be understood by old crowdsec
version, filling this correctly ensures that crowdsec supports
all the required parser features.

description:
The mandatory name of the node. If not present, node will be
skipped at runtime. It is used for example in debug log to help
you track things.

description:
filter must be a valid expr expression that will be evaluated
against the event.  If filter evaluation returns true or is
absent, node will be processed.  If filter returns false or a
non-boolean, node won't be processed.

description:
A valid grok pattern can be set up using the "pattern" field, or
a named grok used through the name "field". This applies either
on an valid expr "expression" or on directly on a field
"apply_on"

description: Duration after which cache elements expire

description: Maximum size of the cache

pattern: ^(string|regexp)$

description:
The type is mandatory if you want to evaluate the data in
the file, and should be regex for valid (re2) regular
expression per line or string for string per line. The
regexps will be compiled, the strings will be loaded into
a list and both will be kept in memory. Without specifying
a type, the file will be downloaded and stored as file and
not in memory.

description: destination to store the downloaded file to

pattern: ^(LRU|LFU|ARC)$

description: Strategy for cache behavior. See https://pkg.go.dev/github.com/bluele/gcache

description: url to download file from

description:
data allows user to specify an external source of data. This
section is only relevant when cscli is used to install parser
from hub, as it will download the source_url and store it to
dest_file. When the parser is not installed from the hub,
CrowdSec won't download the URL, but the file must exist for the
parser to be loaded correctly.

description:
pattern_syntax allows user to define named capture group
expressions for future use in grok patterns. Regexp must be a
valid RE2 expression.

required: name key value

description: The caching strategy to be used : LFU, LRU or ARC (see gcache doc for details). Defaults to LRU.

pattern: ^(LFU|LRU|ARC)$

description: The expression that defines the string that will be used as a key.

description: The name of the stash. Distinct parsers can manipulate the same cache

description: The time to leave of items. Default strategy is LRU.

description: The maximum size of the cache.

description:
The stash section allows a parser to capture data, that can be
later accessed/populated via GetFromStash and SetInStash expr
helpers. Each list item defines a capture directive that is
stored in a separate cache (string:string), with its own maximum
size, eviction rules etc.

description:
Statics is a list of directives that will be evaluated when the
node is considered successful. Each entry of the list is
composed of a target (where to write) and a source (what data to
write).


web-manifest-combined.json

JSON schema for Web Application manifest files


sergen.json

title: Table

required: Tablename Identifier Module PermissionKey

description: Table name

description: Row identifier without Row suffix

description: Module name

description: Permission key

title: Connection

description: Key of connection

description: Connection string

description: Provider name

title: Dialect

description: Dialect

title: Tables

description: Generated table information

$ref: #/definitions/Table

description: Serenity code generator (sergen) configuration

title: Extends

description:
If specified, the settings in this file extends settings in a base file similar to tsconfig.json
You can also use Sergen defaults by specifying this like "defaults@x.y.z"

description: The root namespace for the target project. It is recommended to have this in sergen.json. If not there, it will be auto calculated from root namespace in CSPROJ file, or derived from project file name by removing .Web suffix. Generated code will be placed under this namespace and project's own types are assumed to be under this namespace as well

description: If true, generated code will declare and use jFKTable type of constants for expressions in entities

description: If true, enables RowTemplate class generation. This should only be used when Serenity.Pro.Coder is enabled in the project

title: EndOfLine

description: End of line character to use in generated files. If not specified, it will be auto detected from the environment

enum: LF CRLF

description: If true, generated code will use file scoped namespaces

description: If true, generated code will parse global usings from the current project

description: If specified, generated code will assume these usings are in global using scope

description: If specified, generated code will assume these usings are not in global using scope even if they are in global using scope

description: If true, the default schema name, e.g. "dbo" for SQL Server won't be emitted in generated field expressions in Row.cs files. This is true by default only for MySql as in MySql schema names are actually database names

description: If true, instead of using [Expression] attributes for foreign view fields, it will use Origin(nameof(jFK), nameof(FKRow.ViewField)) if the FKRow is already generated in the project. It will also use ForeignKey(typeof(FKRow)) type of foreign keys instead of strings

description: If true, generated table options like Identity, Module etc. will be saved to the Connections array in sergen.json after code generation. Default is true

title: ClientTypes

description: Client types code generation related configuration

description: The output directory for generated client types .cs files

description: If false, the client types source generator in Serenity.Pro.Coder will be disabled

title: MVC

description: MVC (e.g. view locations) related configuration

description: If true, generated MVC views will be placed under the root namespace of the project

description: The output directory for MVC.cs

description: View paths to search for, defaults to "Modules" and "Views". "ProjectName" is used instead of "Modules" if Razor SDK is used  for the project, e.g. a Razor class library

description: Strip view paths from generated files. Defaults to "Modules", "Views". E.g. a subclass for Modules and Views won't be generated

description: If false, the view paths source generator in Serenity.Pro.Coder will be disabled

title: ServerTypings

description: Server typings code generation related configuration

description: Assemblies for server typings generation. Specify only if Sergen can't auto determine your project output file

description: The output directory for generated server typings files

description: If true, local texts will be generated

description: If true, module re-exports will be generated. Defaults to true

description: If true, module typings will be generated. Defaults to true if you have "module" defined in tsconfig.json

description: If true, namespace typings will be generated. Defaults to true if you don't have "module" defined in tsconfig.json

description: If false, the server typings source generator in Serenity.Pro.Coder will be disabled

title: Restore

description: Sergen restore command related configuration

description: List of files (git ignore like) to include while restoring

description: List of files (git ignore like) to exclude while restoring

description: Set false to disable namespace typings restore to typings/ folder

title: TSBuild

description: List of entry point globs, default is "**/Page.ts", "**/ScriptInit.ts"

description: Should the list of entry points, e.g. ESM be generated, only available with Serenity.Pro.Coder

title: Connections

description: List of connections. It is only needed when it is desired to work / generated code based on a connection string that is not in appsettings.json

$ref: #/definitions/Connection

description: Path to KDiff3 executable. If not specified, it will be auto detected from the environment. (deprecated)

description: Full path to TypeScript compiler. It is assumed to be in path if not specified

title: BaseRowClasses

description: The base class name

description: The base class fields that should exists in a table for this base class to be used

title: ForeignFieldSelection

description: The set of foreign fields to generate, default is NameOnly

enum: None All NameOnly

description: A list of foreign fields to include in generated code. This could be used to include some additional fields This could be used to include some additional fields. Not so useful if ForeignFieldSelection is All

description: A list of foreign fields to omit from generated code. This could be used to disable generating code for join fields like CreatedBy, ModifiedBy etc, so properties like CustomerCreatedBy, CustomerModifiedBy etc. won't be generated in OrderRow. Not so useful if ForeignFieldSelection is None or NameOnly

description:
The location of custom templates folder. The files in this folder will override the default scriban templates in Sergen. You may also include additional files to be generated. Their names must match the names at
https://github.com/serenity-is/Serenity/tree/master/src/Serenity.Net.CodeGenerator/Templates

title: CustomGenerate

description: The relative paths of custom generated files

title: CustomSettings

description: Custom settings to be passed to and used in custom templates

description: The list of appsettings.json files in order. Default is appsettings.json, appsettings.machine.json

title: UpgradeInfo

description: The upgrade / migration related information used by stargen to determine the base version of template used, and already applied upgrades

title: InitialType

description: Initial type of project. Available options are "Community" e.g. Serene, "Premium" e.g. StartSharp

enum: Community Premium

description: Version this project is created from. Used to determine which migrations should be applied to project (starting from)

title: InitialVersion

title: AppliedUpgrades

description: List of already applied upgrades if any

title: Serenity Code Generator (sergen) Configuration


dein.json

title: Pattern for a definition of vim plugin

title: repository.

description: The repository URI or local repository directory path.

$ref: #/definitions/Url

$ref: #/definitions/Path

$ref: #/definitions/repo-string-pattern

description: An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.

description: Specify the build script. This command is executed by |system()| in the plugin runtimepath. Note: In previous versions of dein, build could also be of type dictionary, but that is now deprecated. Please use |dein-options-hook_post_update| instead.

description: Specify a list of plugins a plugin depends on. List items are '{plugin-name}'. Those specified in the list are NOT installed automatically. Note: The loading order is not guaranteed in non lazy plugins.

$ref: #/definitions/ArrayOrString

description: If set to v:true, dein doesn't update it automatically. It is useful for outdated plugins that can no longer be updated.

$ref: #/definitions/Boolean

title: all filetypes

description: '_' key is executed after all ftplugin.

title: filetype

description:
'{filetype}' key is executed {filetype} ftplugin.
You can define multiple filetypes by '{filetype1}_{filetype2}' key.
'b:undo_ftplugin' is defined automatically.

description: If set to v:false, dein doesn't register the plugin, i.e. the plugin will be disabled. If it is String, dein will eval it. If you don't set it, dein will register (enable) the plugin

description: If set to v:true, dein doesn't add the path to 'runtimepath' automatically. If you don't set it, dein will set it automatically when the conditions are met. Note: You should not specify the plugins which have no 'plugin/' directory as lazy load plugins.  It is meaningless and just increases the overhead.  You can get the no meaning lazy plugins by |dein#check_lazy_plugins()|.

description: If set to v:false, dein doesn't merge the plugin directory. It is useful for the plugin files conflicts.

description: If set to v:true, dein merge the plugin "ftdetect" directory. It is useful to enable file detection when lazy loaded plugin. Note: It does not work if ftdetect script depends on lazy plugin functions.

description: Specify the name of the plugin. This is used for dein management and other functions. If it is omitted, the tail of the repository name will be used. Note: Must be unique across the all plugin. If the plugin name conflicts with another plugin, dein will overwrite the previous settings with the new one. If the repo tail is bound to conflict, you can set the 'name' option manually to prevent overwriting an existing plugin setting.

description: Specify the normalized name of the plugin.  If omitted, dein will normalize the tail of the repository name. Note: Must be unique across all plugins.

description: If it is matched to the executed command, dein will call |dein#source()|.

description: dein will call |dein#source()| on the events.

description: If it is matched to the called function, dein will call |dein#source()|.

description: If it is matched to 'filetype', dein will call |dein#source()|.

description: If it is evaluated and it is non-zero, dein will call|dein#source()|.The default evaluate timings are 'BufRead', 'BufNewFile','VimEnter' and 'FileType'.If |dein-options-on_event| exists, it is evaluated when|dein-options-on_event|.

description: If it is matched to the required lua module root, dein will call |dein#source()|. Note: It is for neovim only. Note: It does not work for neovim standard modules.

description: If it is the Dictionary, the key is {mode} and the items are{mapping} or [{mapping1}, {mapping2}, ...].If it is the List, the items are {mapping} or [{mode},{mapping1}, [{mapping2}, ...]].If {mode} is omitted, 'nx' is used.

description: If set to '.*', dein will call |dein#source()| on editing allfiles.  Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins.

description: If set to v:true, dein overwrite existing plugin config when |dein#add()|.

description: Specify the plugin downloaded path.

description: Specify a revision number or branch/tag name. If it is '*' in 'git' type, dein will use latest released tag.You can specify the wildcards like '0.*'.Note: If the type is 'raw', rev must be hash number.

description: Specify the runtime path. You can use it when the repository has the Vim plugin in a subdirectory.For example: https://github.com/rstacruz/sparkup If it is empty string, dein will not add the path to'runtimepath'

default: vim

description: Specify the script type. It is useful for non-official categorized plugins. For example: 'indent', 'plugin', 'ftplugin', ... Note: You must not specify it for categorized plugins.

enum: indent plugin colors ftplugin

description: The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.

description: If set to v:true, dein will load the plugin in 'sudo' mode. If you don't set it, dein won't load it.

description: Specify the repository type. If it is omitted, a guess is made based on {repository}.

enum: none raw git

enumValues: Raw plugin file ('script_type' attribute is needed)

description:
The history depth for 'git clone'.
 If omitted, |g:dein#types#git#clone_depth| is used. If it is than 0, dein clones the repository by shallow clone. Shallow clone feature saves your repository clone time. But it has problems in some repository.
 Note: This attribute is available in git type only.

 https://github.com/Shougo/neobundle.vim/issues/81 https://github.com/Homebrew/homebrew/issues/12024

description: It is executed after the line is parsed. Note: You cannot call plugin function in 'hook_add'. Because the plugin is not sourced when 'hook_add'.

description: It is executed after the all plugins are updated.

description: It is executed after plugins are sourced.  Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed.

description: It is executed after the plugins are updated.

description: It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded.           'type': 'string',

description:
Lua lauguage string hook instead of Vim script.
It is converted to "hook_add" key.

description:
Lua lauguage string hook instead of Vim script.
It is converted to "hook_source" key.

title: Pattern for multiple definition of vim plugin

title: plugins

title: path

title: repo name pattern

description: If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.

title: path

pattern: ^[nvxsomilct]+$

description: Pattern for vim key binding. You can use plugin prefix mappings. You can use '<Plug>' keyword as {mapping}. If{mapping} is '<Plug>', '<Plug>(normalized_name' isused. linter support is now under developping

description: A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)

description:
Definition properties table for installing a vim plugin.
It is converted to |dein#add()|.

$ref: #/definitions/Plugin

title: ftplugin definition

description:
'_' key is executed after all ftplugin.
'{filetype}' key is executed {filetype} ftplugin.
 You can define multiple filetypes by '{filetype1}_{filetype2}' key.

title: all filetypes

description: '_' key is executed after all ftplugin.

title: filetype

title: hook_add definition

description:
It is the global |dein-options-hook_add|.
It is executed in |dein#end()|.

title: It is converted to |dein-toml-hook_add|

description:
It is converted to |dein-toml-hook_add|
"plugins" key is needed.

$ref: #/definitions/MultiplePlugins

title: dein.vim


pre-commit-hooks.json

enum: conda coursier dart docker docker_image dotnet fail golang lua node perl python python_venv r ruby rust swift pygrep script system

enum: adobe-illustrator alpm apinotes asar asciidoc ash asm aspectj audio avif awk babelrc bash batch bats bazel bazelrc bib binary bitmap bowerrc browserslistrc bzip2 c c# c++ c2hs cbsd clojure clojurescript cmake codespellrc coffee coveragerc crystal csh cson csproj css csslintrc csv cuda cython dart dash def diff directory dockerfile dockerignore dotenv dtd editorconfig edn ejs eot eps erb executable expect file fish flake8 gdscript geojson gherkin gif gitattributes gitconfig gitignore gitlint gitmodules go go-mod go-sum gotmpl gpx graphql groovy gyb gyp gzip handlebars haskell hcl header hgrc html icalendar icns icon idl idris image inc ini inl ino inx jade jar java java-properties javascript jenkins jinja jpeg jshintrc json json5 jsonnet jsx jupyter kml kotlin ksh lean lektor lektorproject less liquid literate-haskell lua mailmap makefile manifest map markdown mdx mention-bot mib modulemap musescore myst ngdoc nim nimble nix non-executable npmignore nunjucks objective-c objective-c++ ocaml otf p12 pdbrc pdf pem perl php pkgbuild plain-text plantuml plist png pofile powershell prettierignore prisma proto puppet purescript pyi pylintrc pypirc pyproj python python2 python3 pyz qml r relax-ng rst ruby rust salt sass sbt scala scheme scss sh shell sln socket solidity spec sql stylus svelte svg swf swift swiftdeps symlink system-verilog tar tcsh terraform tex text thrift tiff toml ts tsv tsx ttf twig twisted txsprofile urdf vb vbproj vcxproj vdx verilog vhdl vim vtl vue wav webp wheel wkt woff woff2 wsgi xhtml xml xquery xsd xsl yaml yamllint yang yin zcml zig zip zpt zsh

enum: commit merge-commit push prepare-commit-msg commit-msg post-checkout post-commit post-merge post-rewrite pre-commit pre-merge-commit pre-push pre-rebase manual

$ref: #/definitions/stage

description: id of the hook - used in pre-commit-config.yaml.

description: name of the hook - shown during hook execution.

description: entry point - the executable to run. Can also contain arguments that will not be overridden such as `entry: autopep8 -i`.

description: language of the hook - tells pre-commit how to install the hook.

$ref: #/definitions/language

description: (optional) allows the hook to be referenced using an additional id.

description: (optional) the pattern of files to run on.

description: (optional) exclude files that were matched by files.

description: (optional) list of file types to run on (AND).

description: (optional) list of file types to run on (OR).

description: (optional) pattern of files to exclude.

description: (optional) a list of dependencies that will be installed in the environment where this hook gets run. One useful application is to install plugins for hooks such as eslint.

description: (optional) if true this hook will run even if there are no matching files.

description: (optional) if true, forces the output of the hook to be printed even when the hook passes.

description: (optional) if false no filenames will be passed to the hook.

description: (optional) if true this hook will execute using a single process instead of in parallel.

description: (optional) description of the hook. Used for metadata purposes only.

description: (optional) see Overriding language version at https://pre-commit.com/#overriding-language-version

default: default

description: (optional) if present, the hook output will additionally be written to a file.

description: (optional) allows one to indicate a minimum compatible pre-commit version.

description: (optional) list of additional parameters to pass to the hook.

description: (optional) confines the hook to the commit, merge-commit, push, prepare-commit-msg, commit-msg, post-checkout, post-commit, post-merge, post-rewrite, or manual stage. See Confining hooks to run at certain stages in https://pre-commit.com/#confining-hooks-to-run-at-certain-stages

$ref: #/definitions/stages