key: BeforeNonEmptyParentheses

description: If true, put a space before opening parentheses only if the parentheses are not empty.


key: SpaceBeforeRangeBasedForLoopColon

description:
clang-format 7

 If false, spaces will be removed before range-based for loop colon.

type: boolean


key: SpaceBeforeSquareBrackets

description:
clang-format 10

 If true, spaces will be before [. Lambdas will not be affected. Only the first [ will get a space added.


key: SpaceInEmptyBlock

description:
clang-format 10

 If true, spaces will be inserted into {}.


key: SpaceInEmptyParentheses

description:
clang-format 3.7

 If true, spaces may be inserted into ().


key: SpacesBeforeTrailingComments

description:
clang-format 3.7

 The number of spaces before trailing line comments (// - comments).

This does not affect trailing block comments (/* - comments) as those commonly have different usage patterns and a number of special cases.

type: integer


key: SpacesInAngles

description:
clang-format 3.4

 The SpacesInAnglesStyle to use for template argument lists.

type: string

enum: Never Always Leave


key: SpacesInCStyleCastParentheses

description:
clang-format 3.7

 If true, spaces may be inserted into C style casts.


key: SpacesInConditionalStatement

description:
clang-format 10

 If true, spaces will be inserted around if/for/switch/while conditions.


key: SpacesInContainerLiterals

description:
clang-format 3.7

 If true, spaces are inserted inside container literals (e.g. ObjC and Javascript array and dict literals).


key: SpacesInLineCommentPrefix

description:
clang-format 13

 How many spaces are allowed at the start of a line comment. To disable the maximum set it to -1, apart from that the maximum takes precedence over the minimum.

 In clang-format 16, his option has only effect if ReflowComments is set to true.

type: object


key: SpacesInParentheses

description:
clang-format 3.7

 If true, spaces will be inserted after ( and before ).


key: SpacesInSquareBrackets

description:
clang-format 3.7

 If true, spaces will be inserted after [ and before ]. Lambdas without arguments or unspecified size array declarations will not be affected.


key: Standard

description:
clang-format 3.7

 Parse and format C++ constructs compatible with this standard.


key: StatementAttributeLikeMacros

description:
clang-format 12

 Macros which are ignored in front of a statement, as if they were an attribute. So that they are not parsed as identifier, for example for Qts emit.

type: array


key: StatementMacros

description:
clnag-format 8

 A vector of macros that should be interpreted as complete statements.

 Typical macros are expressions, and require a semi-colon to be added; sometimes this is not the case, and this allows to make clang-format aware of such cases.


key: TabWidth

description:
clang-format 3.7

 The number of columns used for tab stops.


key: TypenameMacros

description:
clang-format 9

 A vector of macros that should be interpreted as type declarations instead of as function calls.

For example: OpenSSL STACK_OF, BSD LIST_ENTRY.


key: UseCRLF

description:
clang-format 10

 Use
 instead of
 for line breaks. Also used as fallback if DeriveLineEnding is true.

 This option is deprecated in clang-format 16. See LF and CRLF of LineEnding.


key: UseTab

description:
clang-format 3.7

 The way to use tab characters in the resulting file.

enum: Never ForIndentation ForContinuationAndIndentation AlignWithSpaces Always


key: WhitespaceSensitiveMacros

description:
clang-format 11

 A vector of macros which are whitespace-sensitive and should not be touched.

 For example: BOOST_PP_STRINGIZE


key: path

description: A JSON Pointer path.


key: op

description: The operation to perform.

enum: add replace test


key: value

description: The value to add, replace or test.


description: The operation to perform.


description: The operation to perform.

enum: move copy


key: from

description: A JSON Pointer path pointing to the location to move/copy from.


key: linters

description: Linters usable.

enum: asasalint asciicheck bidichk bodyclose containedctx contextcheck cyclop deadcode decorder depguard dogsled dupl dupword durationcheck errcheck errchkjson errname errorlint execinquery exhaustive exhaustivestruct exhaustruct exportloopref forbidigo forcetypeassert funlen gci ginkgolinter gocheckcompilerdirectives gochecknoglobals gochecknoinits gocognit goconst gocritic gocyclo godot godox goerr113 gofmt gofumpt goheader goimports golint gomnd gomoddirectives gomodguard goprintffuncname gosec gosimple gosmopolitan govet grouper ifshort importas ineffassign interfacebloat interfacer ireturn lll loggercheck maintidx makezero maligned mirror misspell musttag nakedret nestif nilerr nilnil nlreturn noctx nolintlint nonamedreturns nosnakecase nosprintfhostport paralleltest prealloc predeclared promlinter reassign revive rowserrcheck scopelint sqlclosecheck staticcheck structcheck stylecheck tagalign tagliatelle tenv testableexamples testpackage thelper tparallel typecheck unconvert unparam unused usestdlibvars varcheck varnamelen wastedassign whitespace wrapcheck wsl zerologlint


key: run

description: Options for analysis running,

enum: mod readonly vendor


key: concurrency

description: Number of concurrent runners. Defaults to the number of available CPU cores.


key: timeout

description: Timeout for the analysis.


key: issue-exit-code

description: Exit code when at least one issue was found.


key: tests

description: Enable inclusion of test files.


key: build-tags

description: List of build tags to pass to all linters.


key: skip-dirs

description: Which directories to skip: issues from them won't be reported.


key: items

description:
You can use regexp here. The regexp is applied on the full path.
"/" will be replaced by current OS file path separator to properly work on Windows.


key: skip-dirs-use-default

description: Enable skipping of directories "vendor", "third_party", "testdata", "examples", "Godeps", and "builtin".


key: skip-files

description: Which files to skip: they will be analyzed, but issues from them will not be reported.


description:
You can use regexp here. There is no need to include all autogenerated files, we confidently recognize them. If that is not the case, please let us know.
"/" will be replaced by current OS file path separator to properly work on Windows.


key: modules-download-mode

description:
Option to pass to "go list -mod={option}".
See "go help modules" for more information.


key: allow-parallel-runners

description: Allow multiple parallel golangci-lint instances running. If disabled, golangci-lint acquires file lock on start.


key: go

description: Targeted Go version.


key: output

description: Output configuration options.

default: colored-line-number


key: format

description: Output format to use.


key: print-issued-lines

description: Print lines of code with issue.


key: print-linter-name

description: Print linter name in the end of issue text.


key: unique-by-line

description: Make issues output unique by line.


key: path-prefix

description: Add a prefix to the output file references.


key: linters-settings

description: All available settings of specific linters.

examples: the and a

type: number

default: type const var func

enum: type const var func

examples: switch map

examples:
{{ MY COMPANY }}
SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at:

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

enum: argument case condition operation return assign

enum: Help MetricUnits Counter HistogramSummaryReserved MetricTypeInName ReservedChars CamelCase UnitAbbreviations

default: ACL API ASCII CPU CSS DNS EOF GUID HTML HTTP HTTPS ID IP JSON QPS RAM RPC SLA SMTP SQL SSH TCP TLS TTL UDP UI GID UID UUID URI URL UTF8 VM XML XMPP XSRF XSS SIP RTP AMQP DB TS

examples: json yaml yml toml mapstructure binding validate

enum: camel pascal kebab snake goCamel goPascal goKebab goSnake upper upperSnake lower header

examples:
c echo.Context
t testing.T
f *foo.Bar
const C

default: .Errorf( errors.New( errors.Unwrap( .Wrap( .Wrapf( .WithMessage( .WithMessagef( .WithStack(


key: keywords

description: Keywords for detecting duplicate words. If this list is not empty, only the words defined in this list will be detected.


key: exclude

description: To specify a set of function names to exclude.


key: use-builtin-exclusions

description: To enable/disable the asasalint builtin exclusions of function names.


key: ignore-test

description: Ignore *_test.go files.


key: left-to-right-embedding

description: Disallow: LEFT-TO-RIGHT-EMBEDDING


key: right-to-left-embedding

description: Disallow: RIGHT-TO-LEFT-EMBEDDING


key: pop-directional-formatting

description: Disallow: POP-DIRECTIONAL-FORMATTING


key: left-to-right-override

description: Disallow: LEFT-TO-RIGHT-OVERRIDE


key: right-to-left-override

description: Disallow: RIGHT-TO-LEFT-OVERRIDE


key: left-to-right-isolate

description: Disallow: LEFT-TO-RIGHT-ISOLATE


key: right-to-left-isolate

description: Disallow: RIGHT-TO-LEFT-ISOLATE


key: first-strong-isolate

description: Disallow: FIRST-STRONG-ISOLATE


key: pop-directional-isolate

description: Disallow: POP-DIRECTIONAL-ISOLATE


key: skip-tests

description: Should the linter execute on test files as well


key: max-complexity

description: Max complexity the function can have


key: package-average

description: Max average complexity in package


key: disable-dec-order-check

description: Order of declarations is not checked


key: disable-init-func-first-check

description: Allow init func to be anywhere in file


key: disable-dec-num-check

description: Multiple global type, const and var declarations are allowed


key: rules

description: Rules to apply.


description: Name of a rule.


key: files

description: List of file globs that will match this list of settings to compare against.


key: allow

description: List of allowed packages.


key: deny

description: Packages that are not allowed where the value is a suggestion.


key: desc

description: Description


key: pkg

description: Package


key: max-blank-identifiers

description: Check assignments with too many blank identifiers.


key: threshold

description: Tokens count to trigger issue.


key: check-type-assertions

description: Report about not checking errors in type assertions, i.e.: `a := b.(MyStruct)`


key: check-blank

description: Report about assignment of errors to blank identifier


key: ignore

description: DEPRECATED: use `exclude-functions` instead. Comma-separated list of pairs of the form "pkg:regex".


key: exclude

description: DEPRECATED: use `exclude-functions` instead. Path to a file containing a list of functions to exclude from checking.


key: exclude-functions

description: List of functions to exclude from checking, where each entry is a single function to exclude


key: disable-default-exclusions

description: To disable the errcheck built-in exclude list


key: report-no-exported

description: Issue on struct that doesn't have exported fields.


key: errorf

description: Check whether fmt.Errorf uses the %w verb for formatting errors


key: errorf-multi

description: Permit more than 1 %w verb, valid per Go 1.20


key: asserts

description: Check for plain type assertions and type switches.


key: comparison

description: Check for plain error comparisons


key: check

description: Program elements to check for exhaustiveness.


key: check-generated

description: Check switch statements in generated files


key: explicit-exhaustive-switch

description: Only run exhaustive check on switches with "//exhaustive:enforce" comment.


key: explicit-exhaustive-map

description: Only run exhaustive check on map literals with "//exhaustive:enforce" comment.


key: default-signifies-exhaustive

description: Presence of `default` case in switch statements satisfies exhaustiveness, even if all enum members are not listed.


key: ignore-enum-members

description: Enum members matching `regex` do not have to be listed in switch statements to satisfy exhaustiveness


key: ignore-enum-types

description: Enum types matching the supplied regex do not have to be listed in switch statements to satisfy exhaustiveness.


key: package-scope-only

description: Consider enums only in package scopes, not in inner scopes.


key: suppress-len-assertion

description: Suppress the wrong length assertion warning.


key: suppress-nil-assertion

description: Suppress the wrong nil assertion warning.


key: suppress-err-assertion

description: Suppress the wrong error assertion warning.


key: suppress-compare-assertion

description: Suppress the wrong comparison assertion warning.


key: suppress-async-assertion

description: Suppress the function all in async assertion warning.


key: allow-havelen-zero

description: Don't trigger warnings for HaveLen(0).


key: struct-patterns

description: Struct Patterns is list of expressions to match struct packages (written using `path` matching syntax)


key: include

description: List of regular expressions to match struct packages and names.


key: exclude

description: List of regular expressions to exclude struct packages and names from check.


key: exclude-godoc-examples

description: Exclude code in godoc examples.


key: analyze-types

description: Instead of matching the literal source code, use type information to replace expressions with strings that contain the package name and (for methods and fields) the type name.


key: forbid

description: List of identifiers to forbid (written using `regexp`)


key: p

description: Pattern


key: pkg

description: Package


key: msg

description: Message


key: lines

description: Limit lines number per function.


key: statements

description: Limit statements number per function


key: local-prefixes

description: DEPRECATED: use 'sections' and 'prefix(github.com/org/project)' instead.


key: sections

description: Section configuration to compare against.

default: standard default


key: skip-generated

description: Skip generated files.


key: custom-order

description: Enable custom order of sections.


key: min-complexity

description: Minimal code complexity to report (we recommend 10-20).


key: match-constant

description: Look for existing constants matching the values


key: min-len

description: Minimum length of string constant.


key: min-occurrences

description: Minimum occurrences count to trigger.


key: ignore-tests

description: Ignore test files.


key: ignore-calls

description: Ignore when constant is not used as function argument


key: numbers

description: Search also for duplicated numbers.


key: min

description: Minimum value, only works with `numbers`


key: max

description: Maximum value, only works with `numbers`


key: enabled-checks

description: Which checks should be enabled. By default, a list of stable checks is used. To see it, run `GL_DEBUG=gocritic golangci-lint run`.


key: disabled-checks

description: Which checks should be disabled.


key: enabled-tags

description: Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.


key: disabled-tags

description: Disable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.


key: settings

description: Settings passed to gocritic. Properties must be valid and enabled check names.


description: Minimum code complexity to report (we recommend 10-20).


key: scope

description: Comments to be checked.

enum: declarations toplevel all

default: declarations


key: exclude

description: List of regexps for excluding particular comment lines from check.


key: period

description: Check that each sentence ends with a period.


key: capital

description: Check that each sentence starts with a capital letter.


key: check-all

description: DEPRECATED: Check all top-level comments, not only declarations.


key: keywords

description: Report any comments starting with one of theses keywords. This is useful for TODO or FIXME comments that might be left in the code accidentally and should be resolved before merging.

default: TODO BUG FIXME


key: simplify

description: Simplify code.


key: rewrite-rules

description: Apply the rewrite rules to the source before reformatting.


description: The maximum number of methods allowed for an interface.


key: extra-rules

description: Choose whether or not to use the extra rules that are disabled by default.


key: lang-version

description: Select the Go version to target.


key: module-path

description: Module path which contains the source code being formatted.


key: const

description: Constants to use in the template.

COMPANY: MY FUTURISTIC COMPANY


description: Value for the constant.


key: regexp

description: Regular expressions to use in your template.


key: template

description: Template to put on top of every file.


key: template-path

description: Path to the file containing the template source.


key: local-prefixes

description: Put imports beginning with prefix after 3rd-party packages. It is a comma-separated list of prefixes.


key: min-confidence

description: Minimum confidence for issues.


key: ignored-files

description: Comma-separated list of file patterns to exclude from the analysis.


key: ignored-functions

description: Comma-separated list of function patterns to exclude from the analysis.


key: ignored-numbers

description: Comma-separated list of numbers to exclude from the analysis.


key: checks

description: The list of enabled checks.


description: List of file patterns to exclude from analysis.


description: List of numbers to exclude from analysis.


description: The list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.


key: modules

description: List of allowed modules.


key: domains

description: List of allowed module domains.


description: List of blocked modules.


key: recommendations

description: Recommended modules that should be used instead.


key: reason

description: Reason why the recommended module should be used.


key: versions

description: List of blocked module version constraints.


key: version

description: Version constraint.


description: Reason why the version constraint exists.


description: Raise lint issues if loading local path with replace directive


key: go

description: Targeted Go version


key: includes

description: To select a subset of rules to run


key: excludes

description: To specify a set of rules to explicitly exclude


key: exclude-generated

description: Exclude generated files


key: severity

description: Filter out the issues with a lower severity than the given value

enum: low medium high

default: low


key: confidence

description: Filter out the issues with a lower confidence than the given value


key: config

description: To specify the configuration of rules


key: concurrency

description: Concurrency value


key: allow-time-local

description: Allow and ignore `time.Local` usages.


key: escape-hatches

description: List of fully qualified names in the `full/pkg/path.name` form, to act as "i18n escape hatches".


key: ignore-tests

description: Ignore test files.


key: watch-for-scripts

description: List of Unicode scripts to watch for any usage in string literals.


key: check-shadowing

description: Report shadowed variables.


key: settings

description:
Settings per analyzer. Map of analyzer name to specific settings.
Run `go tool vet help` to find out more.


description: Run `go tool vet help <analyzer>` to see all settings.


key: enable

description: Enable analyzers by name.


key: disable

description: Disable analyzers by name.


key: enable-all

description: Enable all analyzers.


key: disable-all

description: Disable all analyzers.


key: max-decl-lines

description: maximum length of variable declaration measured in numbers of lines, after which the linter won't suggest using short syntax. Has precedence over max-decl-chars


key: max-decl-chars

description: maximum length of variable declaration measured in number of characters, after which the linter won't suggest using short syntax.


key: no-unaliased

description: Do not allow unaliased imports of aliased packages.


key: no-extra-aliases

description: Do not allow non-required aliases.


key: alias

description: List of aliases

required: pkg alias


key: pkg

description: Package path e.g. knative.dev/serving/pkg/apis/autoscaling/v1alpha1


description: Package alias e.g. autoscalingv1alpha1


key: ireturn

description: Use either `reject` or `allow` properties for interfaces matching.

enum: anon error empty stdlib

const: reject


key: tab-width

description: Width of "\t" in spaces.


key: line-length

description: Maximum allowed line length, lines longer will be reported.


key: maintidx

description: Maintainability index https://docs.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022


key: under

description: Minimum accatpable maintainability index level (see https://docs.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022)


key: suggest-new

description: Allow only slices initialized with a length of zero.


key: kitlog

description: Allow check for the github.com/go-kit/log library.


key: klog

description: Allow check for the k8s.io/klog/v2 library.


key: logr

description: Allow check for the github.com/go-logr/logr library.


key: zap

description: Allow check for the "sugar logger" from go.uber.org/zap library.


key: require-string-key

description: Require all logging keys to be inlined constant strings.


key: no-printf-like

description: Require printf-like format specifier (%s, %d for example) not present.


key: rules

description: List of custom rules to check against, where each rule is a single logger pattern, useful for wrapped loggers.


description: Whether to print struct with more effective memory layout.


key: misspell

description: Correct spellings using locale preferences for US or UK. Default is to use a neutral variety of English.

enum: US UK


key: ignore-words

description: List of words to ignore.


key: max-func-lines

description: Report if a function has more lines of code than this value and it has naked returns.


key: min-complexity

description: Minimum complexity of "if" statements to report.


key: checked-types

description: Order of return types to check.

enum: ptr func iface map chan

default: ptr func iface map chan


key: block-size

description: set block size that is still ok


key: allow-unused

description: Enable to ensure that nolint directives are all used.


key: allow-no-explanation

description: Exclude these linters from requiring an explanation.


key: require-explanation

description: Enable to require an explanation of nonzero length after each nolint directive.


key: require-specific

description: Enable to require nolint directives to mention the specific linter being suppressed.


key: report-error-in-defer

description: Report named error if it is assigned inside defer.


key: ignore-missing

description: Ignore missing calls to `t.Parallel()` and only report incorrect uses of it.


key: prealloc

description:
We do not recommend using this linter before doing performance profiling.
For most programs usage of `prealloc` will be premature optimization.


key: simple

description: Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.


key: range-loops

description: Report preallocation suggestions on range loops.


key: for-loops

description: Report preallocation suggestions on for loops.


key: ignored

description: Comma-separated list of predeclared identifiers to not report on.


key: q

description: Include method names and field names (i.e., qualified names) in checks.


key: go

description: Targeted Go version


key: dot-import-whitelist

description: By default, ST1001 forbids all uses of dot imports in non-test packages. This setting allows setting a whitelist of import paths that can be dot-imported anywhere.


key: http-status-code-whitelist

description: ST1013 recommends using constants from the net/http package instead of hard-coding numeric HTTP status codes. This setting specifies a list of numeric status codes that this check does not complain about.


key: initialisms

description: ST1003 check, among other things, for the correct capitalization of initialisms. The set of known initialisms can be configured with this option.


key: align

description: Align and sort can be used together or separately.


key: sort

description: Whether enable tags sort.


key: order

description: Specify the order of tags, the other tags will be sorted by name.


key: use-field-name

description: Use the struct field name to check the name of the struct tag.


key: all

description: The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.


key: skip-regexp

description: Files with names matching this regular expression are skipped.


key: allow-packages

description: List of packages that don't end with _test that tests are allowed to be in.


key: begin

description: Check if `t.Helper()` begins helper function.


key: first

description: Check if *testing.T is first param of helper function.


key: name

description: Check if *testing.T param has t name.


description: Check if `b.Helper()` begins helper function.


description: Check if *testing.B is first param of helper function.


description: Check if *testing.B param has b name.


description: Check if `tb.Helper()` begins helper function.


description: Check if *testing.TB is first param of helper function.


description: Check if *testing.TB param has tb name.


description: Check if `f.Helper()` begins helper function.


description: Check if *testing.F is first param of helper function.


description: Check if *testing.F param has f name.


key: check-exported

description:
Inspect exported functions. Set to true if no external program/library imports your code.

WARNING: if you enable this setting, unparam will report a lot of false-positives in text editors:
if it's called for subdir of a project it can't find external interfaces. All text editor integrations
with golangci-lint call it on a directory with the changed file.


key: http-method

description: Suggest the use of http.MethodXX.


key: http-status-code

description: Suggest the use of http.StatusXX.


key: time-weekday

description: Suggest the use of time.Weekday.String().


key: time-month

description: Suggest the use of time.Month.String().


key: time-layout

description: Suggest the use of time.Layout.


key: crypto-hash

description: Suggest the use of crypto.Hash.String().


key: default-rpc-path

description: Suggest the use of rpc.DefaultXXPath.


key: os-dev-null

description: Suggest the use of os.DevNull.


key: sql-isolation-level

description: Suggest the use of sql.LevelXX.String().


key: tls-signature-scheme

description: Suggest the use of tls.SignatureScheme.String().


key: constant-kind

description: Suggest the use of constant.Kind.String().


key: syslog-priority

description: Suggest the use of syslog.Priority.


key: exported-fields

description: Check usage of exported variables


key: max-distance

description: Variables used in at most this N-many lines will be ignored.


key: min-name-length

description: The minimum length of a variable's name that is considered `long`.


key: check-receiver

description: Check method receiver names.


key: check-return

description: Check named return values.


key: check-type-param

description: Check type parameters.


key: ignore-type-assert-ok

description: Ignore `ok` variables that hold the bool return value of a type assertion


key: ignore-map-index-ok

description: Ignore `ok` variables that hold the bool return value of a map index.


key: ignore-chan-recv-ok

description: Ignore `ok` variables that hold the bool return value of a channel receive.


key: ignore-names

description: Optional list of variable names that should be ignored completely.


key: ignore-decls

description: Optional list of variable declarations that should be ignored completely.


key: multi-if

description: Enforces newlines (or comments) after every multi-line if statement


key: multi-func

description: Enforces newlines (or comments) after every multi-line function signature


key: ignoreSigs

description: An array of strings which specify substrings of signatures to ignore.


key: ignoreSigRegexps

description: An array of strings which specify regular expressions of signatures to ignore.


key: ignorePackageGlobs

description: An array of glob patterns which, if any match the package of the function returning the error, will skip wrapcheck analysis for this error.


key: ignoreInterfaceRegexps

description: An array of glob patterns which, if matched to an underlying interface name, will ignore unwrapped errors returned from a function whose call is defined on the given interface.


key: allow-assign-and-anything

description: Controls if you may cuddle assignments and anything without needing an empty line between them.


key: allow-assign-and-call

description: Allow calls and assignments to be cuddled as long as the lines have any matching variables, fields or types.


key: allow-cuddle-declarations

description: Allow declarations (var) to be cuddled.


key: allow-multiline-assign

description: Allow multiline assignments to be cuddled.


key: allow-separated-leading-comment

description: Allow leading comments to be separated with empty lines.


key: allow-trailing-comment

description: Allow trailing comments in ending of blocks.


key: force-case-trailing-whitespace

description: Force newlines in end of case at this limit (0 = never).


key: allow-cuddle-with-calls

description: A list of call idents that everything can be cuddled with.


key: allow-cuddle-with-rhs

description: AllowCuddleWithRHS is a list of right hand side variables that is allowed to be cuddled with anything.


key: error-variable-names

description: When force-err-cuddling is enabled this is a list of names used for error variables to check for in the conditional.


key: force-err-cuddling

description: Causes an error when an If statement that checks an error variable doesn't cuddle with the assignment of that variable.


key: force-short-decl-cuddling

description: Causes an error if a short declaration (:=) cuddles with anything other than another short declaration.


key: strict-append

description: If true, append is only allowed to be cuddled if appending value is matching variables, fields or types on line above.


key: custom

description:
The custom section can be used to define linter plugins to be loaded at runtime. See README of golangci-lint for more information.
Each custom linter should have a unique name.


key: path

description: The path to the plugin *.so. Can be absolute or local.


key: description

description: The description of the linter, for documentation purposes only.


key: original-url

description: Intended to point to the repo location of the linter, for documentation purposes only.


key: enable

description: List of enabled linters.


key: disable

description: List of disabled linters.


key: enable-all

description: Whether to enable all linters. You can re-disable them with `disable` explicitly.


key: disable-all

description: Whether to disable all linters. You can re-enable them with `enable` explicitly.


key: presets

description: Allow to use different presets of linters

enum: bugs comment complexity error format import metalinter module performance sql style test unused


key: fast

description: Enable run of fast linters.


key: exclude

description:
List of regular expressions of issue texts to exclude.
But independently from this option we use default exclude patterns. Their usage can be controlled through `exclude-use-default`.


key: exclude-rules

description: Exclude configuration per-path, per-linter, per-text and per-source


key: exclude-use-default

description: Independently from option `exclude` we use default exclude patterns. This behavior can be disabled by this option.


key: exclude-case-sensitive

description: If set to true, exclude and exclude-rules regular expressions become case sensitive.


key: include

description: The list of ids of default excludes to include or disable.


key: max-issues-per-linter

description: Maximum issues count per one linter. Set to 0 to disable.


key: max-same-issues

description: Maximum count of issues with the same text. Set to 0 to disable.


key: new

description: Show only new issues: if there are unstaged changes or untracked files, only those changes are analyzed, else only changes in HEAD~ are analyzed.


key: new-from-rev

description: Show only new issues created after this git revision.


key: new-from-patch

description: Show only new issues created in git patch with this file path.


key: default-severity

description: Set the default severity for issues. If severity rules are defined and the issues do not match or no severity is provided to the rule this will be the default severity applied. Severities should match the supported severity names of the selected out format.


key: case-sensitive

description: If set to true, severity-rules regular expressions become case sensitive.


key: rules

description:
When a list of severity rules are provided, severity information will be added to lint issues. Severity rules have the same filtering capability as exclude rules except you are allowed to specify one matcher per severity rule.
Only affects out formats that support setting severity information.


description: JSON schema for V2Ray jsonv4 configuration format: https://github.com/v2fly/v2ray-core

enum: linear mph

enum: Enabled Disabled

enum: Enabled Disabled DisabledIfAnyMatch

const: dokodemo-door

const: http

const: shadowsocks

const: socks

const: vless

const: vmess

const: trojan

enum: none srtp utp wechat-video dtls wireguard

const: burst

const: default

const: blackhole

const: freedom

const: dns

const: loopback

enum: AsIs AlwaysIP IPIfNonMatch IPOnDemand

const: random

const: leastping

const: leastload


key: costs

description: weight settings


key: baselines

description: RTT baselines for selecting, int64 values of time.Duration


key: expected

description: expected nodes count to select


key: maxRtt

description: max acceptable rtt, filter away high delay nodes. defalut 0


key: tolerance

description: acceptable failure rate


description: DNSConfig is a JSON serializable object for dns.Config.


description: HealthCheckSettings holds settings for health Checker


key: pingConfig

description: health check settings


key: port

description:
Port of this Point server.
Deprecated: Port exists for historical compatibility
and should not be used.


key: inbound

description:
Deprecated: InboundConfig exists for historical compatibility
and should not be used.


key: outbound

description:
Deprecated: OutboundConfig exists for historical compatibility
and should not be used.


key: inboundDetour

description:
Deprecated: InboundDetours exists for historical compatibility
and should not be used.


key: outboundDetour

description:
Deprecated: OutboundDetours exists for historical compatibility
and should not be used.


description: TrojanClientConfig is configuration of trojan servers


description: TrojanInboundFallback is fallback configuration


description: TrojanServerConfig is Inbound configuration


description: TrojanServerTarget is configuration of a single trojan server


description: TrojanUserConfig is user configuration


key: id

description: ID of the account, in the form of a UUID, e.g., "66ad4540-b58c-4ad2-9926-ea63445a9b57".


key: flow

description: Flow settings.


key: encryption

description: Encryption settings. Only applies to client side, and only accepts "none" for now.


key: persistenceScope

description: Determines if the user entered values should be persisted for the next template invocation.

enum: none templateGroup shared


description: The id of the symbol from the template.json.


key: name

description: Overrides the name specified in the template.json


key: description


key: isVisible

description: Should be shown in the IDE. If not specified, defaults value is the value specified by defaultSymbolVisibility.


key: invertBoolean

description: If the referenced symbol should be shown in the IDE.


key: defaultValue

description: Overrides the default value specified for the


description: Determines if the user entered value should be persisted and used the next time a template is selected. Default value is the value specified by defaultSymbolVisibility Used starting in Visual Studio 2022 17.3


key: persistenceScopeName

description: Specifies the scope name of the persisted template option. To avoid conflicts with other templates, treat this like a namespace. Used starting in Visual Studio 2022 17.3


key: choices

description: Specifies the name and description overrides for individual choice parameters


key: type

description: The tag to modify

enum: platform projectType


key: add

description: Tags to add


key: remove

description: Tags to remove. * can be specified to remove all tags specified in template.json


description: The host identifier.


key: version

description: A version range specifying the unsupported host versions. This uses the nuget package format.


key: requiredComponent

description: To require a particular host version specify the hostId and optionally version only. To require a particular SetupComponent or Extension, specify the ID and set the componentType appropriately. Version range is optional.

enum: setupComponent extension


description: The id of the component


key: hostId

description: The host id that the component applies to


description: A version range specifying the required version range. This uses the nuget package format.


description: Name of the template


description: Description of the template


key: order

description: The order of the template as shown in the New Project dialog


key: icon

description: The relative file name of the icon to show in the New Project dialog


key: supportsDocker

description: Determines if the checkbox for adding Docker support in the New Project dialog should be visible


key: disableHttpsSymbol

description: The symbol in the template.json which when set, would cause the template to generate non-https ports and settings


key: defaultSymbolVisibility

description: Sets the default isVisible for a symbolInfo if not explictly specified. Controls if the parameter is displayed in the IDE. Defaults to false if not specified


key: defaultPersistenceScope

description: The dafault value for a symbolInfo if not explictly specified. Determines if the user entered value should be persisted and used the next time a template is selected. Used starting in Visual Studio 2022 17.3


key: defaultPersistenceScopeName

description: The dafault value for a symbolInfo if not explictly specified. Specifies the scope name of the persisted template option. To avoid conflicts with other templates, treat this like a namespace. Used starting in Visual Studio 2022 17.3


key: symbolInfo

description: Controls display characteristics of symbols declared in template.json


key: tags

description: Modifigy the project and platform tags displayed in the IDE


key: unsupportedHosts

description: Unsuppored Hosts. This can be used to supress the template from being displayed in the new project dialog in Visual Studio.


key: requiredComponents

description: Required components in order to display this template.


description: config file for rtx version manager (.rtx.toml)

enum: ignore prompt autoinstall warn error

enum: error warn info debug trace


description: path to .env file


description: PATH entries to add


key: items

description: a path to add to PATH


key: env

description: environment variables


key: tools

description: dev tools to use


key: plugins

description: plugins to use


key: additionalProperties

description: url to plugin repository


key: alias

description: custom shorthands for versions


description: plugin to set aliases for


description: version alias points to


key: tool

description: version of the tool to install


key: version

description: version of the tool to install


key: settings

description: settings for rtx


description: what to do when a runtime is missing


description: should rtx parse legacy version files (e.g. .node-version)


description: tools that should not have their legacy version files parsed


description: tool name


description: should rtx keep downloaded files after installation


description: should rtx keep install files after installation even if the installation fails


description: how often to check for plugin updates


description: how often to check for plugin updates


description: set to true to ensure .tool-versions will be compatible with asdf


key: jobs

description: number of tools to install in parallel, default is 4


key: raw

description: directly connect plugin scripts to stdin/stdout, implies --jobs=1


description: path to file containing shorthand mappings


description: disables built-in shorthands


description: tools that should not be used


description: config files with these prefixes will be trusted by default


description: a path to add to PATH


key: experimental

description: enable experimental features


description: log level


key: verbose

description: display installation output


key: default

description: Default state for all rules


key: extends

description: Path to configuration file to extend


key: $schema

description: JSON Schema URI (used by some editors)


description: MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time


description: MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading

type: boolean object


key: level

description: Heading level


description: MD003/heading-style/header-style - Heading style

default: consistent


key: style

description: Heading style


description: MD004/ul-style - Unordered list style

enum: consistent asterisk plus dash sublist


description: List style


description: MD005/list-indent - Inconsistent indentation for list items at the same level


description: MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line


description: MD007/ul-indent - Unordered list indentation


key: indent

description: Spaces for indent


description: Whether to indent the first level of the list


description: Spaces for first level indent (when start_indented is set)


description: MD009/no-trailing-spaces - Trailing spaces


description: Spaces for line break


description: Allow spaces for empty lines in list items


key: strict

description: Include unnecessary breaks


description: MD010/no-hard-tabs - Hard tabs


description: Include code blocks


description: Fenced code languages to ignore


description: Number of spaces for each hard tab


description: MD011/no-reversed-links - Reversed link syntax


description: MD012/no-multiple-blanks - Multiple consecutive blank lines


key: maximum

description: Consecutive blank lines


description: MD013/line-length - Line length


description: Number of characters


description: Number of characters for headings


description: Number of characters for code blocks


key: tables

description: Include tables


key: headings

description: Include headings


key: headers

description: Include headings


description: Strict length checking


key: stern

description: Stern length checking


description: MD014/commands-show-output - Dollar signs used before commands without showing output


description: MD018/no-missing-space-atx - No space after hash on atx style heading


description: MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading


description: MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading


description: MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading


description: MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines

type: integer array


description: Blank lines above heading


description: Blank lines below heading


description: MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line


description: MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content


description: Only check sibling headings


description: MD025/single-title/single-h1 - Multiple top-level headings in the same document


description: Heading level


description: RegExp for matching title in front matter


description: MD026/no-trailing-punctuation - Trailing punctuation in heading


key: punctuation

description: Punctuation characters


description: MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol


description: MD028/no-blanks-blockquote - Blank line inside blockquote


description: MD029/ol-prefix - Ordered list item prefix

enum: one ordered one_or_ordered zero


description: List style


description: MD030/list-marker-space - Spaces after list markers


description: Spaces for single-line unordered list items


description: Spaces for single-line ordered list items


description: Spaces for multi-line unordered list items


description: Spaces for multi-line ordered list items


description: MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines


description: Include list items


description: MD032/blanks-around-lists - Lists should be surrounded by blank lines


description: MD033/no-inline-html - Inline HTML


description: Allowed elements


description: MD034/no-bare-urls - Bare URL used


description: MD035/hr-style - Horizontal rule style


description: Horizontal rule style


description: MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading


description: Punctuation characters


description: MD037/no-space-in-emphasis - Spaces inside emphasis markers


description: MD038/no-space-in-code - Spaces inside code span elements


description: MD039/no-space-in-links - Spaces inside link text


description: MD040/fenced-code-language - Fenced code blocks should have a language specified


description: List of languages


description: Require language only


description: MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading


description: Heading level


description: RegExp for matching title in front matter


description: MD042/no-empty-links - No empty links


description: MD043/required-headings/required-headers - Required heading structure


description: List of headings


description: List of headings


description: Match case of headings


description: MD044/proper-names - Proper names should have the correct capitalization


key: names

description: List of proper names


description: Include code blocks


description: Include HTML elements


description: MD045/no-alt-text - Images should have alternate text (alt text)


description: MD046/code-block-style - Code block style

enum: consistent fenced indented


description: Block style


description: MD047/single-trailing-newline - Files should end with a single newline character


description: MD048/code-fence-style - Code fence style

enum: consistent backtick tilde


description: Code fence style


description: MD049/emphasis-style - Emphasis style should be consistent

enum: consistent asterisk underscore


description: Emphasis style


description: MD050/strong-style - Strong style should be consistent


description: Strong style


description: MD051/link-fragments - Link fragments should be valid


description: MD052/reference-links-images - Reference links and images should use a label that is defined


description: MD053/link-image-reference-definitions - Link and image reference definitions should be needed


description: Ignored definitions


description: headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043


description: headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043


key: bullet

description: bullet - MD004, MD005, MD006, MD007, MD032


key: ul

description: ul - MD004, MD005, MD006, MD007, MD030, MD032


key: indentation

description: indentation - MD005, MD006, MD007, MD027


key: whitespace

description: whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039


description: hard_tab - MD010


key: links

description: links - MD011, MD034, MD039, MD042, MD051, MD052, MD053


description: blank_lines - MD012, MD022, MD031, MD032, MD047


description: line_length - MD013


key: code

description: code - MD014, MD031, MD038, MD040, MD046, MD048


key: atx

description: atx - MD018, MD019


key: spaces

description: spaces - MD018, MD019, MD020, MD021, MD023


description: atx_closed - MD020, MD021


key: blockquote

description: blockquote - MD027, MD028


key: ol

description: ol - MD029, MD030, MD032


key: html

description: html - MD033


key: url

description: url - MD034


key: hr

description: hr - MD035


key: emphasis

description: emphasis - MD036, MD037, MD049, MD050


key: language

description: language - MD040


key: spelling

description: spelling - MD044


key: accessibility

description: accessibility - MD045


key: images

description: images - MD045, MD052, MD053


description:
A syntax
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-files


key: start

description:
A region start
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: end

description:
A region end
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: skip

description:
Ignored region sequences
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: rules

description:
Rules
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: items

description:
A rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: comment

description:
A comment rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A line comment rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A block comment rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: identifier

description:
An identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A callable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin callable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A macro rule
Also used for functions
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin macro rule
Also used for functions
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A variable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin variable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: constant

description:
A constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A null rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A bool constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A true bool constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A false bool constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A integer number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A float number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A complex number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A string constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin string constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A url string constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A escape string constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A string format specifier constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: statement

description:
A statement rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: symbol

description:
A symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A bracket symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


An operator symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A tag symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: preproc

description:
A preprocessor rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A shebang preprocessor rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: type

description:
A type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A builtin type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


A keyword type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: todo

description:
A todo rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: include

description:
An include
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: additionalProperties

description:
A rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules


key: filetype

description:
A file type
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#filetype-definition


key: detect

description:
Detection options
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#detect-definition


key: filename

description:
A file name
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#detect-definition


key: header

description:
A file header
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#detect-definition


Super-schema that describes all versions of 'CICS resource overrides JSON Schema for CICS TS 6.1.0.'


Schema that describes the structure of a CICS resource overrides document.


key: message

description:
The translated message, in the form of a string that can contain placeholders. Use `$_placeholder_name_$` (case insensitive) to refer to a particular placeholder. For example, you can refer to a placeholder named "our_site" as `$our_site$`, `$OUR_SITE$`, or `$oUR_sITe$`.
To put a dollar sign (`$`) into the string, use `$$`.
Although placeholders such as `$USER$` are the preferred way of referring to substitution strings (strings specified using the substitutions parameter of i18n.getMessage) you can also refer to substitution strings directly within the message.

examples: Goodbye, $USER$. Come back to $OUR_SITE$ soon!


key: description

description: Optional. A description of the message, intended to give context or details to help the translator make the best possible translation.

examples:
Ask for the user's name
Greet the user
Say goodbye to the user


key: placeholders

description:
Optional. Defines one or more substrings to be used within the message.
Each placeholder has a name, a "content" item, and an optional "example" item. A placeholder's name is case-insensitive and can contain the same characters as a message name.


key: content

description: The "content" item's value is a string that can refer to substitution strings, which are specified using the i18n.getMessage method's substitutions parameter. The value of a "content" item is typically something like "Example.com" or "$1". If you refer to a substitution string that doesn't exist, you get an empty string. The following table shows how `$_n_` strings correspond to strings specified by the substitutions parameter.


key: example

description: The "example" item (optional, but highly recommended) helps translators by showing how the content appears to the end user. For example, a placeholder for a dollar amount should have an example like `"$23.45"`.


key: allowSelfApprovals

description: Set to false to disallow requesters from approving their own requests for this task.


key: concurrencyKey

description: If non-empty, restricts runs with the same concurrency key from executing at the same time.


key: concurrencyLimit

description: If concurrency key is set, only allows this task's runs to start if the number of other active runs with the same key is below this limit.


key: constraints

description: Set label constraints to restrict this task to run only on agents with matching labels.


key: defaultRunPermissions

description: Manage who can view new runs of this task. If not specified, defaults to 'task-viewers'

default: task-viewers

enum: task-viewers task-participants


description: A human-readable description for your task.


key: name

description: A human-readable name for your task.


key: parameters

description: A list of inputs to your task.


key: permissions

description: Permissions for the task. If specified, permission configuration will not be allowed in the UI.


key: admins

description: Groups and users who have full access to the task, and can change task configurations and permissions.


key: executers

description: Groups and users who have all the permissions of requesters, and can also execute tasks and other's requests.


key: requesters

description: Groups and users who have all the permission of viewers, and can also request tasks.


key: viewers

description: Groups and users who can see task information, but can't request or execute tasks.


key: requireRequests

description: Set to true to disable direct execution of this task.


key: resources

description: A list of resources to make available to your task. Resources are identified by slug, but can be mapped to an alias to configure how the task references the resource. If using aliases, resources are expressed as a map of alias to slug.


key: restrictCallers

description: Hide this task in the UI and disable direct execution. This task may only be executed by the specified callers.

examples: task view

enum: task view


key: runtime

description: Set the runtime used for this task.


key: schedules

description: A map of schedules that are to be deployed with this task. The key corresponds to a unique schedule across deploys.

Daily Midnight Batch

param_two: hello


description: Runs this task daily at midnight.


key: cron

description: The cron string in crontab format


key: description

description: The description of the schedule


description: The name of the schedule


key: paramValues

description: A map of parameter slugs to values to be passed to the task each run


key: timeout

description: The maximum number of seconds the task should take before being timed out.


key: webhooks

description: A list of webhooks that are to be deployed with this task.


key: configs

description: A list of config variables that this task can access.


key: envVars

description: A map of environment variables to use when running the task. If specifying raw values, the value may be a string; if using config variables, the value must be an object with config mapped to the name of the config variable.


key: environments

description: A map from environment slug to override for that environment.


key: default

description: The default value of the parameter.


description: A human-readable description of the parameter.


key: hidden

description: A JST that's evaluated to determine whether the parameter is hidden. You can reference the value of other parameters using the `params` object.


key: multi

description: Whether the parameter is a list parameter or not.


key: name

description: A human-readable name for the parameter.


key: options

description: A list of options to constrain the parameter values. For configvar types, each option needs to be an object with a label (value to show to user) and a config (name of the config var). For all other types, each option can be a single value or an object with a label and a value.

label: Batman

value: Bruce Wayne

required: label value

required: label config


description: The task that's run to populate the options.


key: enabled

description: A JST that's evaluated to determine whether to run the task to populate the options. You can reference the value of other parameters using the `params` object.


key: regex

description: A regular expression with which to validate parameter values.

format: regex


key: required

description: Set to false to indicate that this parameter is optional.


key: slug

description: An identifier for the parameter, which can be used in JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: type

description: The type of parameter.

enum: shorttext longtext sql boolean upload integer float date datetime configvar json


key: validate

description: A JST that's evaluated to validate the parameter value. This should evaluate to a string error message if the validation fails. You can reference the value of other parameters using the `params` object.

examples: params.country.value === 'USA' ? 'The country cannot be set to USA.' : undefined


key: groups

description: Groups to assign the permission to.


key: users

description: Users to assign the permission to.


key: node

description: Configuration for a Node task.

enum: full slim


key: base

description: The type of base image to use; if not specified, defaults to full.


key: entrypoint

description: The path to the .ts or .js file containing the logic for this task. This can be absolute or relative to the location of the definition file.


key: nodeVersion

description: The version of Node to use.


key: python

description: Configuration for a Python task.


description: The path to the .py file containing the logic for this task. This can be absolute or relative to the location of the definition file.


key: shell

description: Configuration for a shell task.


description: The path to the .sh file containing the logic for this task. This can be absolute or relative to the location of the definition file.


key: docker

description: Configuration for a Docker task.

examples:
echo "hello world"
echo "{{params.input}}"


key: command

description: The Docker command to run. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


description: Specify a Docker entrypoint to override the default image entrypoint.


key: image

description: The name of the image to use.


key: sql

description: Configuration for a SQL task.

type: string boolean number

default: auto

enum: auto readOnly readWrite none

required: resource entrypoint


key: configs

description: (Deprecated) A list of config variables that this task can access. Use top-level `configs` instead.


description: The path to the .sql file containing the logic for this task. This can be absolute or relative to the location of the definition file. The contents of the .sql file support JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: queryArgs

description: A map of query arguments that can be used to safely pass parameter inputs to your query. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: resource

description: The slug of a database resource. (Deprecated: This can also be the name of the resource.)


key: transactionMode

description: The transaction mode to use.


key: rest

description: Configuration for a REST task.

type: string object

enum: json raw form-data x-www-form-urlencoded

enum: GET POST PATCH PUT DELETE

type: boolean string

required: resource method path


key: body

description: The body of the request. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: bodyType

description: The type of body that this request should send.


key: formData

description: A map of form values. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: headers

description: A map of request headers. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: method

description: The HTTP method to use.


key: path

description: The path to request. Your REST resource may specify a path prefix as part of its base URL, in which case this path is joined to it. Airplane recommends that this start with a leading slash. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


description: The slug of a REST resource. (Deprecated: This can also be the name of the resource.)


key: retryFailures

description: Retry the request if the server returns a 500, 502, 503, or 504 status code. Requests are always retried on 408 and 429 status codes. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: urlParams

description: A map of URL parameters. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


key: graphql

description: Configuration for a GraphQL task.

required: resource operation


key: operation

description: The query or mutation to execute.


description: The slug of a GraphQL resource.


key: variables

description: A map of GraphQL variables. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).


description: The last linter you'll ever need

examples: ALL bazel-build bazel-workspace c c# c++ c++-header c++-source c-header c-source c/c++ c/c++-source css cue docker dotenv gemspec go graphql haml html java javascript json kotlin latex markdown php prettier_supported_configs proto python ruby rust sass scala shell sql starlark svg terraform toml typescript yaml zsh

examples: ALL actionlint ansible-lint autopep8 bandit black black-py brakeman buf-breaking buf-format buf-lint buildifier cfnlint clang-format clang-tidy clippy cue-fmt detekt detekt-explicit detekt-gradle dotenv-linter eslint flake8 git-diff-check gitleaks gofmt goimports golangci-lint hadolint haml-lint include-what-you-use isort ktlint markdownlint mypy prettier pylint rubocop rubocop-fmt rufo rustfmt scalafmt semgrep shellcheck shfmt sql-formatter standardrb stylelint stylelint-fmt svgo taplo taplo-fmt terraform terraform-fmt terraform-validate tflint yamllint yapf

type: string number boolean

examples: go java node python ruby rust

examples: critical debug error info off trace warn

examples: linux macos

examples: bazel json

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate

examples: "${linter}" will expand to the directory a linter is installed into, e.g. "${linter}/node_modules/.bin" is appended to the `PATH` of any linter with `runtime: node`

examples: "${runtime}" will expand to the directory a runtime is installed into, e.g. with `runtime: node`, "${runtime}/bin/npm" will yield the path to the installed NPM binary

examples: flake8@4.0.1 { packages [ 'flake8-bugbear@21.9.2', 'flake8-docstring@1.6.0' ] }

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate


description:
List of filetypes
To refer to all filetypes, use [ALL]


description:
List of linter IDs
To refer to all linters, use [ALL]


description: String where "${key1} ${key2}" will be expanded into "value1 value2"


description: Whether or not this will be run on empty files


key: batch

description:
Whether linter invocations for multiple targets should be batched; used to cut down on per-invocation overhead

Causes every token containing ${target} to be expanded multiple times, e.g. 'my_linter target=${target}' would be expanded into 'my_linter target=target1 target=target2 ... target=targetN'


description: Whether Trunk can cache results for this linter


key: command

description: argv of the command to invoke the linter with


description: Whether or not we support linting the upstream version of a target


key: enabled

description: Whether the command is enabled to run when the linter is run. Allows some commands of a linter to be run by default without others.


description: Exit codes implying the linter experienced an internal error


key: formatter

description: Whether or not this linter will be run by 'trunk fmt'; default: false


description: Whether the linter modifies ${target} files in-place.


key: output

description: Output type of this linter; controls how `trunk` parses its output

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate


description: Command to initialize the linter with


description:
Tell parser where to expect output from for reading (if 'tmpfile', then the linter should write its output to ${tmpfile})

NOTE: this field is only respected for type=sarif linters currently

examples: stderr stdout tmp_file


key: run

description: Command to invoke the linter with (write as if you were typing into your shell)


description: The nearest target to search for when 'run_linter_from' is 'root_file' or 'root_directory'


description:
What to use as the current working directory:
  * workspace - the root of the repository
  * parent_directory - the directory containing the linter target
  * directory - the linter target itself, with the condition that the linter target is a directory itself
  * root_file - the nearest directory containing 'run_from_root_target', e.g. the nearest directory containing a go.mod file
  * root_directory - the nearest directory matching 'run_from_root_target', e.g. the nearest src/ directory


key: stdin

description: Whether or not this linter takes its input from stdin


description: Exit codes corresponding to no issues found or issues found


key: download

description: The download containing this linter (i.e. the `name` of an entry in `downloads`)


key: environment

description: Environment variables set when `trunk` runs the linter

required: name value

required: name list


key: list

description: The envvar will be set to the `:`-joined list


description: Extra packages needed to run this linter; also installed using the runtime's package manager


key: files

description: Filetypes to run this linter on


description: Whether or not this linter can handle LFS files; default: false


key: name

description: Linter ID; use this in fields like `enabled` to reference this linter


key: package

description: The package containing this linter; installed using the runtime's package manager


description: argv of the command to initialize the linter with


key: runtime

description: The runtime, toolchain, and package manager used to run and install a linter


key: type


key: items

description: linter@envOrVersion, where envOrVersion is either the name of an environment, the version of the main `package` if `runtime` is set, or the verson of the `download`


key: paths

description: Paths to exclude from linting


description: See https://docs.trunk.io


key: version

description: The trunk config version being parsed. The only possible value is 0.1.


description:
A build resource in the Cloud Build API.

At a high level, a `Build` describes where to find source code, how to build
it (for example, the builder image to run on the source), and where to store
the built artifacts.

Fields can include the following variables, which will be expanded when the
build is created:

- $PROJECT_ID: the project ID of the build.
- $BUILD_ID: the autogenerated ID of the build.
- $REPO_NAME: the source repository name specified by RepoSource.
- $BRANCH_NAME: the branch name specified by RepoSource.
- $TAG_NAME: the tag name specified by RepoSource.
- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
  resolved from the specified branch or tag.
- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

format: google-duration

enumDescriptions:
e2 HighCPU: 2 vCPUs, 2GB RAM
e2 HighCPU: 4 vCPUs, 4GB RAM
e2 HighCPU: 8 vCPUs, 8GB RAM
e2 HighCPU: 16 vCPUs, 16GB RAM
e2 HighCPU: 32 vCPUs, 32GB RAM
e2 HighMem: 2 vCPUs, 16GB RAM
e2 HighMem: 4 vCPUs, 32GB RAM
e2 HighMem: 8 vCPUs, 64GB RAM
e2 HighMem: 16 vCPUs, 128GB RAM
e2 Medium: 1 vCPU, 4GB RAM
e2 Standard: 2 vCPU, 8GB RAM
e2 Standard: 4 vCPU, 16GB RAM
e2 Standard: 8 vCPU, 32GB RAM
e2 Standard: 16 vCPU, 64GB RAM
e2 Standard: 32 vCPU, 128GB RAM
n1 HighCPU: 8 vCPUs, 7.2GB RAM
n1 HighCPU: 32 vCPUs, 28.8GB RAM
e2 Medium: 1 vCPU, 4GB RAM

enumDescriptions: Service may automatically determine build log streaming behavior.

enumDescriptions: Build logs should be streamed to Google Cloud Storage.

enumDescriptions:
Build logs should not be streamed to Google Cloud Storage; they will be
written when the build is completed.

enumDescriptions:
The service determines the logging mode. The default is `LEGACY`. Do not
rely on the default logging behavior as it may change in the future.

enumDescriptions: Stackdriver logging and Cloud Storage logging are enabled.

enumDescriptions: Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.

enumDescriptions: Turn off all logging. No build logs will be captured.

enumDescriptions:
Not a verifiable build. (default)
Verified build.

enumDescriptions:
Fails the build if error in substitutions checks, like missing
a substitution in the template or in the map.

enumDescriptions: Do not fail the build if error in substitutions checks.

enumDescriptions:
No hash requested.
Use a sha256 hash.
Use a md5 hash.

format: byte

pattern: ^projects/\w+/serviceAccounts/\w+$


key: BuildStep

description: A step in the build pipeline.


description:
Required. The name of the container image that will run this particular
build step.

If the image is available in the host's Docker daemon's cache, it
will be run directly. If not, the host will attempt to pull the image
first, using the builder service account's credentials if necessary.

The Docker daemon's cache will already have the latest versions of all of
the officially supported build steps
([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
The Docker daemon will also have cached many of the layers for some popular
images, like "ubuntu", "debian", but they will be refreshed at the time you
attempt to use them.

If you built an image in a previous build step, it will be stored in the
host's Docker daemon's cache and is available to use as the name for a
later build step.


key: waitFor

description:
The ID(s) of the step(s) that this build step depends on.
This build step will not start until all the build steps in `wait_for`
have completed successfully. If `wait_for` is empty, this build step will
start when all previous build steps in the `Build.Steps` list have
completed successfully.


key: env

description:
A list of environment variable definitions to be used when running a step.

The elements are of the form "KEY=VALUE" for the environment variable "KEY"
being given the value "VALUE".


key: entrypoint

description:
Entrypoint to be used instead of the build step image's default entrypoint.
If unset, the image's default entrypoint is used.


key: volumes

description:
List of volumes to mount into the build step.

Each volume is created as an empty volume prior to execution of the
build step. Upon completion of the build, volumes and their contents are
discarded.

Using a named volume in only one step is not valid as it is indicative
of a build request with an incorrect configuration.


key: args

description:
A list of arguments that will be presented to the step when it is started.

If the image used to run the step's container has an entrypoint, the `args`
are used as arguments to that entrypoint. If the image does not define
an entrypoint, the first element in args is used as the entrypoint,
and the remainder will be used as arguments.


key: timeout

description:
Time limit for executing this build step. If not defined, the step has no
time limit and will be allowed to continue to run until either it completes
or the build itself times out.


key: id

description:
Unique identifier for this build step, used in `wait_for` to
reference this build step as a dependency.


key: secretEnv

description:
A list of environment variables which are encrypted using a Cloud Key
Management Service crypto key. These values must be specified in the
build's `Secret`.


key: dir

description:
Working directory to use when running this step's container.

If this value is a relative path, it is relative to the build's working
directory. If this value is absolute, it may be outside the build's working
directory, in which case the contents of the path may not be persisted
across build step executions, unless a `volume` for that path is specified.

If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
which specifies an absolute path, the `RepoSource` `dir` is ignored for
the step's execution.


key: BuildOptions

description: Optional arguments to enable specific features of builds.


key: machineType

description: Compute Engine machine type on which to run the build.


description:
Global list of volumes to mount for ALL build steps

Each volume is created as an empty volume prior to starting the build
process. Upon completion of the build, volumes and their contents are
discarded. Global volume names and paths cannot conflict with the volumes
defined a build step.

Using a global volume in a build with only one step is not valid as
it is indicative of a build request with an incorrect configuration.


key: logStreamingOption

description:
Option to define build log streaming behavior to Google Cloud
Storage.


key: workerPool

description:
Option to specify a `WorkerPool` for the build. User specifies the pool
with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
This is an experimental field.


description:
A list of global environment variable definitions that will exist for all
build steps in this build. If a variable is defined in both globally and in
a build step, the variable will use the build step value.

The elements are of the form "KEY=VALUE" for the environment variable "KEY"
being given the value "VALUE".


key: logging

description:
Option to specify the logging mode, which determines where the logs are
stored.


key: requestedVerifyOption

description: Requested verifiability options.


key: substitutionOption

description:
Option to specify behavior when there is an error in the substitution
checks.


key: diskSizeGb

description:
Requested disk size for the VM that runs the build. Note that this is *NOT*
"disk free"; some of the space will be used by the operating system and
build utilities. Also note that this is the minimum disk size that will be
allocated for the build -- the build may run with a larger disk than
requested. At present, the maximum disk size is 1000GB; builds that request
more than the maximum are rejected with an error.


description:
A list of global environment variables, which are encrypted using a Cloud
Key Management Service crypto key. These values must be specified in the
build's `Secret`. These variables will be available to all build steps
in this build.


key: sourceProvenanceHash

description: Requested hash for SourceProvenance.


key: Secret

description:
Pairs a set of secret environment variables containing encrypted
values with the Cloud KMS key to use to decrypt the value.


key: kmsKeyName

description: Cloud KMS key name to use to decrypt these envs.


description:
Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's
secrets, and must be used by at least one build step. Values can be at most
64 KB in size. There can be at most 100 secret values across all of a
build's secrets.


key: Source

description: Location of the source in a supported storage service.


key: storageSource

description: If provided, get the source from this location in Google Cloud Storage.


key: repoSource

description:
If provided, get the source from this location in a Cloud Source
Repository.


key: StorageSource

description: Location of the source in an archive file in Google Cloud Storage.


key: generation

description:
Google Cloud Storage generation for the object. If the generation is
omitted, the latest generation will be used.


key: bucket

description:
Google Cloud Storage bucket containing the source (see
[Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).


key: object

description:
Google Cloud Storage object containing the source.

This object must be a gzipped archive file (`.tar.gz`) containing source to
build.


key: RepoSource

description: Location of the source in a Google Cloud Source Repository.


key: tagName

description: Name of the tag to build.


key: projectId

description:
ID of the project that owns the Cloud Source Repository. If omitted, the
project ID requesting the build is assumed.


key: repoName

description:
Name of the Cloud Source Repository. If omitted, the name "default" is
assumed.


key: commitSha

description: Explicit commit SHA to build.


key: dir

description:
Directory, relative to the source root, in which to run the build.

This must be a relative path. If a step's `dir` is specified and is an
absolute path, this value is ignored for that step's execution.


key: branchName

description: Name of the branch to build.


key: Artifacts

description:
Artifacts produced by a build that should be uploaded upon
successful completion of all build steps.


key: objects

description:
A list of objects to be uploaded to Cloud Storage upon successful
completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to
the specified Cloud Storage location using the builder service account's
credentials.

The location and generation of the uploaded objects will be stored in the
Build resource's results field.

If any objects fail to be pushed, the build is marked FAILURE.


key: images

description:
A list of images to be pushed upon the successful completion of all build
steps.

The images will be pushed using the builder service account's credentials.

The digests of the pushed images will be stored in the Build resource's
results field.

If any of the images fail to be pushed, the build is marked FAILURE.


key: ArtifactObjects

description:
Files in the workspace to upload to Cloud Storage upon successful
completion of all build steps.


key: location

description:
Cloud Storage bucket and optional object path, in the form
"gs://bucket/path/to/somewhere/". (see [Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Files in the workspace matching any path pattern will be uploaded to
Cloud Storage with this location as a prefix.


key: paths

description: Path globs used to match files in the build's workspace.


key: Volume

description:
Volume describes a Docker container volume which is mounted into build steps
in order to persist files across build step execution.


key: name

description:
Name of the volume to mount.

Volume names must be unique per build step and must be valid names for
Docker volumes. Each named volume must be used by at least two build steps.


key: path

description:
Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the
same build step or with certain reserved volume paths.


key: steps

description: Required. The operations to be performed on the workspace.


key: logsBucket

description:
Google Cloud Storage bucket where logs should be written (see
[Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.


key: tags

description: Tags for annotation of a `Build`. These are not docker tags.


key: substitutions

description: Substitutions data for `Build` resource.


description:
A list of images to be pushed upon the successful completion of all build
steps.

The images are pushed using the builder service account's credentials.

The digests of the pushed images will be stored in the `Build` resource's
results field.

If any of the images fail to be pushed, the build status is marked
`FAILURE`.


key: options

description: Special options for this build.


key: source

description: The location of the source files to build.


key: artifacts

description:
Artifacts produced by the build that should be uploaded upon
successful completion of all build steps.


key: timeout

description:
Amount of time that this build should be allowed to run, to second
granularity. If this amount of time elapses, work on the build will cease
and the build status will be `TIMEOUT`.

Default time is ten minutes.


key: secrets

description: Secrets to decrypt using Cloud Key Management Service.


key: serviceAccount

description: Use this field to specify the IAM service account to use at build time.


key: id

description: A unique identifier for the extension pack. This is to uniquely identify the extension pack and will not be shown to the user.


description: The name of the extension pack.


key: description

description: A short description of the extension pack.


key: version

description: The version of the extension pack.


key: extensions

description: A list of extension objects.


description: The name of the extension.


key: vsixId

description: The unique ID of the extension.


description: Name of project root (deprecated, use `name`)


description: Name of project root (deprecated, use `root`)


description: Optional tmux socket.


description: Runs on project start, always.


description: Run on project start, the first time.


description: Run on project start, after the first time.


description: Run on project exit (detaching from tmux session).


description: Run on project stop.


key: pre

description: Runs before everything (deprecated).


key: post

description: Runs after everything (deprecated).


key: rbenv

description: Specify version for rbenv (deprecated)


description: Pass arguments to tmux (deprecated)


key: tabs

description: Specify tabs (deprecated)


description: Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.


description: Pass command line options to tmux. Useful for specifying a different tmux.conf.


description: Change the command to call tmux.  This can be used by derivatives/wrappers like byobu.


description: Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.


description: Specifies (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.


key: attach

description: Controls whether the tmux session should be attached to automatically. Defaults to true.


description: Deprecated. Use `attach`


key: layout

description: The layout setting gets handed down to tmux directly, so you can choose from one of the five tmux standard layouts or specify your own.


key: panes

description: Panes are optional and are children of window entries.


description: A manifest describing a Stripe App.

required: id version name icon permissions ui_extension

required: permission purpose

const: settings

required: type url

const: external

format: uri

required: viewport component


description: The unique identifier for an app, for example "com.invoicing.myapp".


description: An app version that you define. You can use any format you want for version identifiers.


key: name

description: The name shown in the UI when referring to your app.


key: icon

description: The relative path to a 300x300 pixel PNG image, for example "./icon.png".


key: permissions

description: The permissions available to the app. Read more about permissions: https://stripe.com/docs/stripe-apps/reference/permissions


key: permission

description: The ID of the permission. Read more about permissions: https://stripe.com/docs/stripe-apps/reference/permissions


key: purpose

description: The reason for requesting the permission.


description: Specify a recommended action for users to take after installing your app. Read more about post-install actions: https://stripe.com/docs/stripe-apps/post-install-actions


key: url

description: External URL to redirect users to after installing your app.


description: Configuration options for how to display the app in the Dashboard.


key: views

description: Configure where the app appears in the Dashboard.


key: viewport

description: An identifier that indicates where a UI extension appears in the Dashboard. Read more about viewports: https://stripe.com/docs/stripe-apps/reference/viewports


key: component

description: The name of the React component in the "src/views" directory to render.


description: Configure the content security policy for your app.


key: connect-src

description: URLs of permitted third-party APIs. If the URL ends in a slash, all of its children also receive permission. Read about using third-party APIs: https://stripe.com/docs/stripe-apps/build-ui#use-third-party-apis


key: image-src

description: URLs the Img component (https://stripe.com/stripe-apps/ui-toolkit/components/img) can load from. If the URL ends in a slash, all trailing paths are also permitted.


description: A message to show users when the app is installed that explains why the app needs to communicate with external URLs.


key: constants

description: Custom values that are passed through to your views via context props. Read about context props: https://stripe.com/docs/stripe-apps/reference/extensions-sdk-api#props


description: A list of allowed urls to which the user can be redirected upon successful install of this app. Read about using allowed redirect urls: https://stripe.com/docs/stripe-apps/reference/app-manifest#allowed-redirect-urls


key: postInstallActionType

description: The recommended action for users to take after installing your app. Read about post-install actions: https://stripe.com/docs/stripe-apps/post-install-actions


key: description

description: The description of the state node, in Markdown


key: uri

description: The value of uri should always be the same as when the site is being accessed from a web browser


description: Analysis scope configuration file used by Sigrid (sigrid-says.com)

enum: week month

required: source target

required: name include

format: email

required: enabled id


description: When true, excludes files and directories from the analysis scope based on common conventions.


key: exclude

description: List of file and directory patterns to manually exclude from the analysis.


description: Directory depth that will be used to define components.


key: languages

description: A list of technologies that should be included as part of the analysis.


key: model

description: Version of the SIG quality model that should be used for the analysis.


key: enabled

description: When true, will send alert email notifications when noteworthy events happen.


key: recipients

description: List of email addresses that should receive alerts.


description: When this *or* the 'blocklist' option is provided, OSH analysis is performed for every upload.


key: blocklist

description: List of patterns for library names that should not be sent to external services.


key: blacklist

description: Deprecated, use 'blocklist' instead.


key: transitive

description: When true, transitive dependencies are also checked and included in the results.


description: List of file/directory patterns that should be excluded from the Open Source Health analysis.


description: Indicates that this system should be scanned for vulnerabilities using Checkmarx.


key: id

description: Unique ID to identify the Checkmarx project.


key: username

description: Your Checkmarx username.


description: When true, architecture analysis will be triggered for each incoming upload.


description: Version of the SIG Architecture Quality Model to use.


description: List of exclude patterns that applies only to Architecture Quality, not globally.


description: Overrides automatic component detection with components defined manually in scope file.


List of directory names that should be flattened and not considered as components during the analysis.


List of manually added dependencies on top of the ones detected automatically by the analysis.


List of dependencies that manually overrides the analysis and removes them from the results.


List of dependencies considered undesirable, and should therefore be highlighted in the visualization.


key: rename

description: Map of system elements for which to manually override the name.


description: Default is false. When true, skips automated data store detection and assumes one monolithic data store.


key: grouping

description: Annotate all top-level components matching the pattern, in order to divide them into logical groups.


description: Disables change history analysis when set to false.


key: history

description: Deprecated, use 'history_enabled' instead.


description: Period to use for repository history analysis, default is last 12 months.


Repository history start date in the format 'yyyy-mm-dd', default is last year.


Repository history end date in the format 'yyyy-mm-dd', default is current date.


Either 'week' (default) or ‘month’.


description: Filters commits with an abnormally large amount of churn from the history analysis.


key: branch

description: Repository branch to use, comma-separated for multiple branches. Defaults to current branch.


key: duplication

description: Set to false to disable duplication detection, improves performance for huge systems.


description: Set to false to disable co-evolution detection, improves performance for huge systems.


description: List of metrics that should be removed from the analysis and set to N/A.


description: When true, third party findings analysis will be triggered for each incoming upload.


List of third-party analyzers that should not be ran.


List of third-party analyzer names that should be ran even though they are disabled by default.


key: include

description: List of file/directory patterns that should be included in the third party findings analysis beyond the maintainability scope and production configuration files.


description: List of file/directory patterns that should be excluded from the third party findings analysis.


description: A GitHub Action for automatically labelling pull requests.

type: string array