eslintrc.json

type: string

type: array

description:
ESLint rule

0 - turns the rule off
1 - turn the rule on as a warning (doesn't affect exit code)
2 - turn the rule on as an error (exit code is 1 when triggered)

type: integer

description:
ESLint rule

"off" - turns the rule off
"warn" - turn the rule on as a warning (doesn't affect exit code)
"error" - turn the rule on as an error (exit code is 1 when triggered)

enum: off warn error

type: object

$ref: #/definitions/rule

description: Require or disallow trailing commas

description: Enforce "for" loop update clause moving the counter in the right direction

description: Enforce return statements in getters

description: Disallow await inside of loops

description: Disallow comparing against -0

description: Disallow assignment operators in conditional expressions

description: Disallow the use of console

description: Disallow constant expressions in conditions

description: Disallow control characters in regular expressions

description: Disallow the use of debugger

description: Disallow duplicate arguments in function definitions

description: Disallow duplicate keys in object literals

description: Disallow duplicate case labels

description: Disallow empty block statements

description: Disallow empty character classes in regular expressions

description: Disallow reassigning exceptions in catch clauses

description: Disallow unnecessary boolean casts

description: Disallow unnecessary parentheses

description: Disallow unnecessary semicolons

description: Disallow reassigning function declarations

description: Disallow function or var declarations in nested blocks

description: Disallow invalid regular expression strings in RegExp constructors

description: Disallow irregular whitespace outside of strings and comments

description: Disallow negating the left operand in in expressions (deprecated)

description: Disallow calling global object properties as functions

description: Disallow calling some Object.prototype methods directly on objects

description: Disallow multiple spaces in regular expressions

description: Disallow sparse arrays

description: Disallow template literal placeholder syntax in regular strings

description: Disallow confusing multiline expressions

description: Disallow unreachable code after return, throw, continue, and break statements

description: Disallow control flow statements in finally blocks

description: Disallow negating the left operand of relational operators

description: Require calls to isNaN() when checking for NaN

description: Enforce valid JSDoc comments

description: Enforce comparing typeof expressions against valid strings

description: Enforce getter and setter pairs in objects

description: Enforce return statements in callbacks of array methods

description: Enforce the use of variables within the scope they are defined

description: Enforce that class methods utilize this

description: Enforce a maximum cyclomatic complexity allowed in a program

description: Require return statements to either always or never specify values

description: Enforce consistent brace style for all control statements

description: Require default cases in switch statements

description: Enforce consistent newlines before and after dots

description: Enforce dot notation whenever possible

description: Require the use of === and !==

description: Require for-in loops to include an if statement

description: Disallow the use of alert, confirm, and prompt

description: Disallow the use of arguments.caller or arguments.callee

description: Disallow lexical declarations in case clauses

description: Disallow division operators explicitly at the beginning of regular expressions

description: Disallow else blocks after return statements in if statements

description: Disallow empty functions

description: Disallow empty destructuring patterns

description: Disallow null comparisons without type-checking operators

description: Disallow the use of eval()

description: Disallow extending native types

description: Disallow unnecessary calls to .bind()

description: Disallow unnecessary labels

description: Disallow fallthrough of case statements

description: Disallow leading or trailing decimal points in numeric literals

description: Disallow assignments to native objects or read-only global variables

description: Disallow shorthand type conversions

description: Disallow var and named function declarations in the global scope

description: Disallow the use of eval()-like methods

description: Disallow this keywords outside of classes or class-like objects

description: Disallow the use of the __iterator__ property

description: Disallow labeled statements

description: Disallow unnecessary nested blocks

description: Disallow function declarations and expressions inside loop statements

description: Disallow magic numbers

description: Disallow multiple spaces

description: Disallow multiline strings

description: Disallow new operators outside of assignments or comparisons

description: Disallow new operators with the Function object

description: Disallow new operators with the String, Number, and Boolean objects

description: Disallow octal literals

description: Disallow octal escape sequences in string literals

description: Disallow reassigning function parameters

description: Disallow the use of the __proto__ property

description: Disallow var redeclaration

description: Disallow certain properties on certain objects

description: Disallow assignment operators in return statements

description: Disallow unnecessary return await

description: Disallow javascript: urls

description: Disallow assignments where both sides are exactly the same

description: Disallow comparisons where both sides are exactly the same

description: Disallow comma operators

description: Disallow throwing literals as exceptions

description: Disallow unmodified loop conditions

description: Disallow unused expressions

description: Disallow unused labels

description: Disallow unnecessary calls to .call() and .apply()

description: Disallow unnecessary concatenation of literals or template literals

description: Disallow unnecessary escape characters

description: Disallow redundant return statements

description: Disallow void operators

description: Disallow specified warning terms in comments

description: Disallow with statements

description: Require using Error objects as Promise rejection reasons

description: Enforce the consistent use of the radix argument when using parseInt()

description: Disallow async functions which have no await expression

description: Require var declarations be placed at the top of their containing scope

description: Require parentheses around immediate function invocations

description: Require or Disallow "Yoda" conditions

description: require or disallow strict mode directives

description: Require or disallow initialization in var declarations

description: Disallow catch clause parameters from shadowing variables in the outer scope

description: Disallow deleting variables

description: Disallow labels that share a name with a variable

description: Disallow specified global variables

description: Disallow var declarations from shadowing variables in the outer scope

description: Disallow identifiers from shadowing restricted names

description: Disallow the use of undeclared variables unless mentioned in /*global */ comments

description: Disallow the use of undefined as an identifier

description: Disallow initializing variables to undefined

description: Disallow unused variables

description: Disallow the use of variables before they are defined

description: Require return statements after callbacks

description: Require require() calls to be placed at top-level module scope

description: Require error handling in callbacks

description: Disallow use of the Buffer() constructor

description: Disallow require calls to be mixed with regular var declarations

description: Disallow new operators with calls to require

description: Disallow string concatenation with __dirname and __filename

description: Disallow the use of process.env

description: Disallow the use of process.exit()

description: Disallow specified modules when loaded by require

description: Disallow synchronous methods

description: Enforce line breaks after opening and before closing array brackets

description: Enforce consistent spacing inside array brackets

description: Enforce line breaks after each array element

description: Enforce consistent spacing inside single-line blocks

description: Enforce consistent brace style for blocks

description: Enforce camelcase naming convention

description: Enforce or disallow capitalization of the first letter of a comment

description: Require or disallow trailing commas

description: Enforce consistent spacing before and after commas

description: Enforce consistent comma style

description: Enforce consistent spacing inside computed property brackets

description: Enforce consistent naming when capturing the current execution context

description: Enforce at least one newline at the end of files

description: Require or disallow spacing between function identifiers and their invocations

description: Require function names to match the name of the variable or property to which they are assigned

description: Require or disallow named function expressions

description: Enforce the consistent use of either function declarations or expressions

description: Enforce line breaks between arguments of a function call

description: Enforce consistent line breaks inside function parentheses

description: Disallow specified identifiers

description: Enforce minimum and maximum identifier lengths

description: Require identifiers to match a specified regular expression

description: Enforce the location of arrow function bodies

description: Enforce consistent indentation

description: Enforce consistent indentation (legacy, deprecated)

description: Enforce the consistent use of either double or single quotes in JSX attributes

description: Enforce consistent spacing between keys and values in object literal properties

description: Enforce consistent spacing before and after keywords

description: Enforce position of line comments

description: Require or disallow an empty line between class members

description: Enforce consistent linebreak style

description: Require empty lines around comments

description: Require or disallow newlines around directives

description: Enforce a maximum depth that blocks can be nested

description: Enforce a maximum line length

description: Enforce a maximum number of lines per file

description: Enforce a maximum depth that callbacks can be nested

description: Enforce a maximum number of parameters in function definitions

description: Enforce a maximum number of statements allowed in function blocks

description: Enforce a maximum number of statements allowed per line

description: Enforce a particular style for multiline comments

description: Enforce newlines between operands of ternary expressions

description: Require constructor function names to begin with a capital letter

description: Require or disallow an empty line after var declarations

description: Require an empty line before return statements

description: Require a newline after each call in a method chain

description: Require parentheses when invoking a constructor with no arguments

description: Disallow Array constructors

description: Disallow bitwise operators

description: Disallow continue statements

description: Disallow inline comments after code

description: Disallow if statements as the only statement in else blocks

description: Disallow mixed binary operators

description: Disallow mixed spaces and tabs for indentation

description: Disallow use of chained assignment expressions

description: Disallow multiple empty lines

description: Disallow negated conditions

description: Disallow nested ternary expressions

description: Disallow Object constructors

description: Disallow the unary operators ++ and --

description: Disallow specified syntax

description: Disallow tabs in file

description: Disallow ternary operators

description: Disallow trailing whitespace at the end of lines

description: Disallow dangling underscores in identifiers

description: Disallow ternary operators when simpler alternatives exist

description: Disallow whitespace before properties

description: Enforce the location of single-line statements

description: Enforce consistent line breaks inside braces

description: Enforce consistent spacing inside braces

description: Enforce placing object properties on separate lines

description: Enforce variables to be declared either together or separately in functions

description: Require or disallow newlines around var declarations

description: Require or disallow assignment operator shorthand where possible

description: Enforce consistent linebreak style for operators

description: Require or disallow padding within blocks

description: Require or disallow padding lines between statements

description: Require quotes around object literal property names

description: Enforce the consistent use of either backticks, double, or single quotes

description: Require JSDoc comments

description: Require or disallow semicolons instead of ASI

description: Enforce consistent spacing before and after semicolons

description: Enforce location of semicolons

description: Requires object keys to be sorted

description: Require variables within the same declaration block to be sorted

description: Enforce consistent spacing before blocks

description: Enforce consistent spacing before function definition opening parenthesis

description: Enforce consistent spacing after the // or /* in a comment

description: Require spacing around operators

description: Enforce consistent spacing inside parentheses

description: Enforce consistent spacing before or after unary operators

description: Enforce spacing around colons of switch statements

description: Require or disallow spacing between template tags and their literals

description: Require or disallow Unicode byte order mark (BOM)

description: Require parenthesis around regex literals

description: Require braces around arrow function bodies

description: Require parentheses around arrow function arguments

description: Enforce consistent spacing before and after the arrow in arrow functions

description: Require super() calls in constructors

description: Enforce consistent spacing around * operators in generator functions

description: Disallow reassigning class members

description: Disallow arrow functions where they could be confused with comparisons

description: Disallow reassigning const variables

description: Disallow duplicate class members

description: Disallow duplicate module imports

description: Disallow new operators with the Symbol object

description: Disallow specified modules when loaded by import

description: Disallow this/super before calling super() in constructors

description: Disallow unnecessary computed property keys in object literals

description: Disallow unnecessary constructors

description: Disallow renaming import, export, and destructured assignments to the same name

description: Require let or const instead of var

description: Require or disallow method and property shorthand syntax for object literals

description: Require arrow functions as callbacks

description: Require const declarations for variables that are never reassigned after declared

description: Require destructuring from arrays and/or objects

description: Disallow parseInt() in favor of binary, octal, and hexadecimal literals

description: Require Reflect methods where applicable

description: Require rest parameters instead of arguments

description: Require spread operators instead of .apply()

description: Require template literals instead of string concatenation

description: Require generator functions to contain yield

description: Enforce spacing between rest and spread operators and their expressions

description: Enforce sorted import declarations within modules

description: Require symbol descriptions

description: Require or disallow spacing around embedded expressions of template strings

description: Require or disallow spacing around the * in yield* expressions

description: By default, ESLint supports only ECMAScript 5 syntax. You can override that setting to enable support for ECMAScript 6 as well as JSX by using configuration settings.

description: Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)

description: allow return statements in the global scope

description: enable global strict mode (if ecmaVersion is 5 or greater)

description: enable JSX

description: An environment defines global variables that are predefined.

description: defines require() and define() as global variables as per the amd spec

description: AppleScript global variables

description: Atom test helper globals

description: browser global variables

description: CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack)

description: Globals common to both Node and Browser

description: Ember test helper globals

description: enable all ECMAScript 6 features except for modules

description: GreaseMonkey globals

description: adds all of the Jasmine testing global variables for version 1.3 and 2.0

description: Jest global variables

description: jQuery global variables

description: Meteor global variables

description: adds all of the Mocha test global variables

description: MongoDB global variables

description: Java 8 Nashorn global variables

description: Node.js global variables and Node.js scoping

description: PhantomJS global variables

description: Prototype.js global variables

description: Protractor global variables

description: QUnit global variables

description: Service Worker global variables

description: ShellJS global variables

description: WebExtensions globals

description: web workers global variables

description: If you want to extend a specific configuration file, you can use the extends property and specify the path to the file. The path can be either relative or absolute.

description: Set each global variable name equal to true to allow the variable to be overwritten or false to disallow overwriting.

description: The values false|"readable" and true|"writeable" are deprecated, they are equivalent to "readonly" and "writable", respectively.

description: Prevent comments from changing config or rules

description: The JavaScript language options to be supported

description: Set to 3, 5, 6, 7, 8, 9, 10, 11 (default), 12, 13, 14 or "latest" to specify the version of ECMAScript syntax you want to use. You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13) or 2023 (same as 14) to use the year-based naming. "latest" always enables the latest supported ECMAScript version.

description: set to "script" (default) or "module" if your code is in ECMAScript modules

description: ESLint supports the use of third-party plugins. Before using the plugin, you have to install it using npm.

description: By default, ESLint will look for configuration files in all parent folders up to the root directory. This can be useful if you want all of your projects to follow a certain convention, but can sometimes lead to unexpected results. To limit ESLint to a specific project, set this to `true` in a configuration in the root of your project.

description: Tell ESLint to ignore specific files and directories. Each value uses the same pattern as the `.eslintignore` file.

description: ESLint comes with a large number of rules. You can modify which rules your project uses either using configuration comments or configuration files.

description: ESLint supports adding shared settings into configuration file. You can add settings object to ESLint configuration file and it will be supplied to every rule that will be executed. This may be useful if you are adding custom rules and want them to have access to the same information and be easily configurable.

description: Allows to override configuration for files and folders, specified by glob patterns

description: Glob pattern for files to apply 'overrides' configuration, relative to the directory of the config file

description: If a file matches any of the 'excludedFiles' glob patterns, the 'overrides' configuration won't apply

description: To specify a processor, specify the plugin name and processor name joined by a forward slash

title: JSON schema for ESLint configuration files


description: Any property starting with 'x_' is valid.

description: File version (always the first entry in the object) and must be a positive integer.

description: An optional name of the generated code that this source map is associated with.

description: An optional source root, useful for relocating source files on a server or removing repeated values in the 'sources' entry.  This value is prepended to the individual entries in the 'source' field.

description: A list of original sources used by the 'mappings' entry.

description: An optional list of source content, useful when the 'source' can�t be hosted. The contents are listed in the same order as the sources in line 5. 'null' may be used if some original sources should be retrieved by name.

description: A list of symbol names used by the 'mappings' entry.

description: A string with the encoded mapping data.

$ref: #/definitions/sectionMap

title: JSON schema for the Source Maps v3


description: A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

description: The address expressed as a byte offset from the start of the addressable region.

description: The address expressed as a byte offset from the absolute address of the top-most parent object.

description: The number of bytes in this range of addresses.

description: An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

description: A name that is associated with the address, e.g., '.text'.

description: A human-readable fully qualified name that is associated with the address.

description: The byte offset of this address from the absolute or relative address of the parent object.

description: The index within run.addresses of the cached object for this address.

description: The index within run.addresses of the parent object.

description: Key/value pairs that provide additional information about the address.

$ref: #/definitions/propertyBag

description: A single artifact. In some cases, this artifact might be nested within another artifact.

description: A short description of the artifact.

$ref: #/definitions/message

description: The location of the artifact.

$ref: #/definitions/artifactLocation

description: Identifies the index of the immediate parent of the artifact, if this artifact is nested.

description: The offset in bytes of the artifact within its containing artifact.

description: The length of the artifact in bytes.

description: The role or roles played by the artifact in the analysis.

enum: analysisTarget attachment responseFile resultFile standardStream tracedFile unmodified modified added deleted renamed uncontrolled driver extension translation taxonomy policy referencedOnCommandLine memoryContents directory userSpecifiedConfiguration toolSpecifiedConfiguration debugOutputFile

description: The MIME type (RFC 2045) of the artifact.

description: The contents of the artifact.

$ref: #/definitions/artifactContent

description: Specifies the encoding for an artifact object that refers to a text file.

description: Specifies the source language for any artifact object that refers to a text file that contains source code.

description: A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.

description: The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

format: date-time

description: Key/value pairs that provide additional information about the artifact.

description: A change to a single artifact.

description: The location of the artifact to change.

description: An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.

$ref: #/definitions/replacement

description: Key/value pairs that provide additional information about the change.

required: artifactLocation replacements

description: Represents the contents of an artifact.

description: UTF-8-encoded content from a text artifact.

description: MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

description: An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).

$ref: #/definitions/multiformatMessageString

description: Key/value pairs that provide additional information about the artifact content.

description: Specifies the location of an artifact.

description: A string containing a valid relative or absolute URI.

format: uri-reference

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

description: The index within the run artifacts array of the artifact object associated with the artifact location.

description: A short description of the artifact location.

description: Key/value pairs that provide additional information about the artifact location.

description: An artifact relevant to a result.

description: A message describing the role played by the attachment.

description: The location of the attachment.

description: An array of regions of interest within the attachment.

$ref: #/definitions/region

description: An array of rectangles specifying areas of interest within the image.

$ref: #/definitions/rectangle

description: Key/value pairs that provide additional information about the attachment.

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

description: A message relevant to the code flow.

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

$ref: #/definitions/threadFlow

description: Key/value pairs that provide additional information about the code flow.

description: Information about how a specific rule or notification was reconfigured at runtime.

description: Specifies how the rule or notification was configured during the scan.

$ref: #/definitions/reportingConfiguration

description: A reference used to locate the descriptor whose configuration was overridden.

description: Key/value pairs that provide additional information about the configuration override.

required: configuration descriptor

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

description: A tool object that describes the converter.

$ref: #/definitions/tool

description: An invocation object that describes the invocation of the converter.

$ref: #/definitions/invocation

description: The locations of the analysis tool's per-run log files.

description: Key/value pairs that provide additional information about the conversion.

description: Represents a directed edge in a graph.

description: A string that uniquely identifies the edge within its graph.

description: A short description of the edge.

description: Identifies the source node (the node at which the edge starts).

description: Identifies the target node (the node at which the edge ends).

description: Key/value pairs that provide additional information about the edge.

required: id sourceNodeId targetNodeId

description: Represents the traversal of a single edge during a graph traversal.

description: Identifies the edge being traversed.

description: A message to display to the user as the edge is traversed.

description: The values of relevant expressions after the edge has been traversed.

description: The number of edge traversals necessary to return from a nested graph.

description: Key/value pairs that provide additional information about the edge traversal.

description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

description: A message that describes the exception.

description: The sequence of function calls leading to the exception.

$ref: #/definitions/stack

description: An array of exception objects each of which is considered a cause of this exception.

$ref: #/definitions/exception

description: Key/value pairs that provide additional information about the exception.

description: The URI of the JSON schema corresponding to the version of the external property file format.

format: uri

description: The SARIF format version of this external properties object.

description: A stable, unique identifier for this external properties object, in the form of a GUID.

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

description: A conversion object that will be merged with a separate run.

$ref: #/definitions/conversion

description: An array of graph objects that will be merged with a separate run.

$ref: #/definitions/graph

description: Key/value pairs that provide additional information that will be merged with a separate run.

description: An array of artifact objects that will be merged with a separate run.

$ref: #/definitions/artifact

description: Describes the invocation of the analysis tool that will be merged with a separate run.

description: An array of logical locations such as namespaces, types or functions that will be merged with a separate run.

description: An array of threadFlowLocation objects that will be merged with a separate run.

description: An array of result objects that will be merged with a separate run.

description: Tool taxonomies that will be merged with a separate run.

description: The analysis tool object that will be merged with a separate run.

description: Tool extensions that will be merged with a separate run.

description: Tool policies that will be merged with a separate run.

description: Tool translations that will be merged with a separate run.

description: Addresses that will be merged with a separate run.

description: Requests that will be merged with a separate run.

description: Responses that will be merged with a separate run.

description: Key/value pairs that provide additional information about the external properties.

description: The location of the external property file.

description: A stable, unique identifier for the external property file in the form of a GUID.

description: A non-negative integer specifying the number of items contained in the external property file.

description: Key/value pairs that provide additional information about the external property file.

description: References to external property files that should be inlined with the content of a root log file.

description: An external property file containing a run.conversion object to be merged with the root log file.

description: An array of external property files containing a run.graphs object to be merged with the root log file.

description: An external property file containing a run.properties object to be merged with the root log file.

description: An array of external property files containing run.artifacts arrays to be merged with the root log file.

description: An array of external property files containing run.invocations arrays to be merged with the root log file.

description: An array of external property files containing run.logicalLocations arrays to be merged with the root log file.

description: An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.

description: An array of external property files containing run.results arrays to be merged with the root log file.

description: An array of external property files containing run.taxonomies arrays to be merged with the root log file.

description: An array of external property files containing run.addresses arrays to be merged with the root log file.

description: An external property file containing a run.driver object to be merged with the root log file.

description: An array of external property files containing run.extensions arrays to be merged with the root log file.

description: An array of external property files containing run.policies arrays to be merged with the root log file.

description: An array of external property files containing run.translations arrays to be merged with the root log file.

description: An array of external property files containing run.requests arrays to be merged with the root log file.

description: An array of external property files containing run.responses arrays to be merged with the root log file.

description: Key/value pairs that provide additional information about the external property files.

description: A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

description: A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.

description: One or more artifact changes that comprise a fix for a result.

description: Key/value pairs that provide additional information about the fix.

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

description: A description of the graph.

description: An array of node objects representing the nodes of the graph.

description: An array of edge objects representing the edges of the graph.

description: Key/value pairs that provide additional information about the graph.

description: Represents a path through a graph.

description: The index within the run.graphs to be associated with the result.

description: The index within the result.graphs to be associated with the result.

description: A description of this graph traversal.

description: Values of relevant expressions at the start of the graph traversal that may change during graph traversal.

description: Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.

description: The sequences of edges traversed by this graph traversal.

description: Key/value pairs that provide additional information about the graph traversal.

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.

description: The locations of any response files specified on the tool's command line.

description: The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

description: The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

description: The process exit code.

description: An array of configurationOverride objects that describe rules related runtime overrides.

description: An array of configurationOverride objects that describe notifications related runtime overrides.

description: A list of runtime conditions detected by the tool during the analysis.

description: A list of conditions detected by the tool that are relevant to the tool's configuration.

description: The reason for the process exit.

description: The name of the signal that caused the process to exit.

description: The numeric value of the signal that caused the process to exit.

description: The reason given by the operating system that the process failed to start.

description: Specifies whether the tool's execution completed successfully.

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

description: An absolute URI specifying the location of the analysis tool's executable.

description: The working directory for the analysis tool run.

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.

description: A file containing the standard input stream to the process that was invoked.

description: A file containing the standard output stream from the process that was invoked.

description: A file containing the standard error stream from the process that was invoked.

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.

description: Key/value pairs that provide additional information about the invocation.

description: A location within a programming artifact.

description: Value that distinguishes this location from all other locations within a single result object.

description: Identifies the artifact and region.

description: The logical locations associated with the result.

description: A message relevant to the location.

description: A set of regions relevant to the location.

description: An array of objects that describe relationships between this location and others.

description: Key/value pairs that provide additional information about the location.

description: Information about the relation of one location to another.

description: A reference to the related location.

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.

description: A description of the location relationship.

description: Key/value pairs that provide additional information about the location relationship.

description: A logical location of a construct that produced a result.

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

description: The index within the logical locations array.

description: The human-readable fully qualified name of the logical location.

description: The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

description: Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

description: The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.

description: Key/value pairs that provide additional information about the logical location.

description: Encapsulates a message intended to be read by the end user.

description: A plain text message string.

description: A Markdown message string.

description: The identifier for this message.

description: An array of strings to substitute into the message string.

description: Key/value pairs that provide additional information about the message.

description: A message string or message format string rendered in multiple formats.

description: A plain text message string or format string.

description: A Markdown message string or format string.

description: Represents a node in a graph.

description: A string that uniquely identifies the node within its graph.

description: A short description of the node.

description: A code location associated with the node.

description: Array of child nodes.

description: Key/value pairs that provide additional information about the node.

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

description: The locations relevant to this notification.

description: A message that describes the condition that was encountered.

description: A value specifying the severity level of the notification.

description: The thread identifier of the code that generated the notification.

description: The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

description: The runtime exception, if any, relevant to this notification.

description: A reference used to locate the descriptor relevant to this notification.

description: A reference used to locate the rule descriptor associated with this notification.

description: Key/value pairs that provide additional information about the notification.

description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

description: The address of the location.

description: The location of the artifact.

description: Specifies a portion of the artifact.

description: Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.

description: Key/value pairs that provide additional information about the physical location.

description: Key/value pairs that provide additional information about the object.

description: A set of distinct strings that provide additional information.

description: An area within an image.

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.

description: A message relevant to the rectangle.

description: Key/value pairs that provide additional information about the rectangle.

description: A region within an artifact where a result was detected.

description: The line number of the first character in the region.

description: The column number of the first character in the region.

description: The line number of the last character in the region.

description: The column number of the character following the end of the region.

description: The zero-based offset from the beginning of the artifact of the first character in the region.

description: The length of the region in characters.

description: The zero-based offset from the beginning of the artifact of the first byte in the region.

description: The length of the region in bytes.

description: The portion of the artifact contents within the specified region.

description: A message relevant to the region.

description: Specifies the source language, if any, of the portion of the artifact specified by the region object.

description: Key/value pairs that provide additional information about the region.

description: The replacement of a single region of an artifact.

description: The region of the artifact to delete.

description: The content to insert at the location specified by the 'deletedRegion' property.

description: Key/value pairs that provide additional information about the replacement.

description: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

description: A stable, opaque identifier for the report.

description: An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

description: A unique identifier for the reporting descriptor in the form of a GUID.

description: An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

description: A report identifier that is understandable to an end user.

description: An array of readable identifiers by which this report was known in some previous version of the analysis tool.

description: A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.

description: A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

description: A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

description: Default reporting configuration information.

description: A URI where the primary documentation for the report can be found.

description: Provides the primary documentation for the report, useful when there is no online documentation.

description: An array of objects that describe relationships between this reporting descriptor and others.

description: Key/value pairs that provide additional information about the report.

description: Information about a rule or notification that can be configured at runtime.

description: Specifies whether the report may be produced during the scan.

description: Specifies the failure level for the report.

description: Specifies the relative priority of the report. Used for analysis output only.

description: Contains configuration information specific to a report.

description: Key/value pairs that provide additional information about the reporting configuration.

description: Information about how to locate a relevant reporting descriptor.

description: The id of the descriptor.

description: The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

description: A guid that uniquely identifies the descriptor.

description: A reference used to locate the toolComponent associated with the descriptor.

description: Key/value pairs that provide additional information about the reporting descriptor reference.

description: Information about the relation of one reporting descriptor to another.

description: A reference to the related reporting descriptor.

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.

description: A description of the reporting descriptor relationship.

description: A result produced by an analysis tool.

description: The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.

description: The index within the tool component rules array of the rule object associated with this result.

description: A reference used to locate the rule descriptor relevant to this result.

description: A value that categorizes results by evaluation state.

enum: notApplicable pass fail review open informational

description: A value specifying the severity level of the result.

description: A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

description: Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.

description: The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

description: A stable, unique identifier for the result in the form of a GUID.

description: A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

description: A positive integer specifying the number of times this logically unique result was observed in this run.

description: A set of strings that contribute to the stable, unique identity of the result.

description: A set of strings each of which individually defines a stable, unique identity for the result.

description: An array of 'stack' objects relevant to the result.

description: An array of 'codeFlow' objects relevant to the result.

description: An array of zero or more unique graph objects associated with the result.

description: An array of one or more unique 'graphTraversal' objects.

description: A set of locations relevant to this result.

description: A set of suppressions relevant to this result.

description: The state of a result relative to a baseline of a previous run.

description: A number representing the priority or importance of the result.

description: A set of artifacts relevant to the result.

description: An absolute URI at which the result can be viewed.

description: The URIs of the work items associated with this result.

description: Information about how and when the result was detected.

description: An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

description: An array of references to taxonomy reporting descriptors that are applicable to the result.

description: A web request associated with this result.

description: A web response associated with this result.

description: Key/value pairs that provide additional information about the result.

description: Contains information about how and when a result was detected.

description: The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.

description: The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

description: The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.

description: An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.

description: Describes a single run of an analysis tool, and contains the reported output of that run.

description: Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

description: Describes the invocation of the analysis tool.

description: A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

description: Specifies the revision in version control of the artifacts that were scanned.

description: The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.

description: An array of artifact objects relevant to the run.

description: An array of logical locations such as namespaces, types or functions.

description: An array of zero or more unique graph objects associated with the run.

description: The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

description: Automation details that describe this run.

description: Automation details that describe the aggregate of runs to which this run belongs.

description: The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

description: An array of strings used to replace sensitive information in a redaction-aware property.

description: Specifies the default encoding for any artifact object that refers to a text file.

description: Specifies the default source language for any artifact object that refers to a text file that contains source code.

description: An ordered list of character sequences that were treated as line breaks when computing region information for the run.

description: Specifies the unit in which the tool measures columns.

description: An array of threadFlowLocation objects cached at run level.

description: An array of toolComponent objects relevant to a taxonomy in which results are categorized.

description: Addresses associated with this run instance, if any.

description: The set of available translations of the localized data provided by the tool.

description: Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

description: An array of request objects cached at run level.

description: An array of response objects cached at run level.

description: A specialLocations object that defines locations of special significance to SARIF consumers.

description: Key/value pairs that provide additional information about the run.

description: Information that describes a run's identity and role within an engineering system process.

description: A description of the identity and role played within the engineering system by this object's containing run object.

description: A hierarchical string that uniquely identifies this object's containing run object.

description: A stable, unique identifier for this object's containing run object in the form of a GUID.

description: A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

description: Key/value pairs that provide additional information about the run automation details.

description: Defines locations of special significance to SARIF consumers.

description: Provides a suggestion to SARIF consumers to display file paths relative to the specified location.

description: Key/value pairs that provide additional information about the special locations.

description: A call stack that is relevant to a result.

description: A message relevant to this call stack.

description: An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

description: Key/value pairs that provide additional information about the stack.

description: A function call within a stack trace.

description: The location to which this stack frame refers.

description: The name of the module that contains the code of this stack frame.

description: The thread identifier of the stack frame.

description: The parameters of the call that is executing.

description: Key/value pairs that provide additional information about the stack frame.

description: A suppression that is relevant to a result.

description: A stable, unique identifier for the suppression in the form of a GUID.

description: A string that indicates where the suppression is persisted.

description: A string that indicates the state of the suppression.

description: A string representing the justification for the suppression.

description: Identifies the location associated with the suppression.

description: Key/value pairs that provide additional information about the suppression.

description: An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

description: A message relevant to the thread flow.

description: Values of relevant expressions at the start of the thread flow that may change during thread flow execution.

description: Values of relevant expressions at the start of the thread flow that remain constant.

description: A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

description: Key/value pairs that provide additional information about the thread flow.

description: A location visited by an analysis tool while simulating or monitoring the execution of a program.

description: The index within the run threadFlowLocations array.

description: The code location.

description: The call stack leading to this location.

description: A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

description: An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

description: The name of the module that contains the code that is executing.

description: A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

description: An integer representing a containment hierarchy within the thread flow.

description: An integer representing the temporal order in which execution reached this location.

description: The Coordinated Universal Time (UTC) date and time at which this location was executed.

description: Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

description: A web request associated with this thread flow location.

description: A web response associated with this thread flow location.

description: Key/value pairs that provide additional information about the threadflow location.

description: The analysis tool that was run.

description: The analysis tool that was run.

description: Tool extensions that contributed to or reconfigured the analysis tool that was run.

description: Key/value pairs that provide additional information about the tool.

description: A component, such as a plug-in or the driver, of the analysis tool that was run.

description: A unique identifier for the tool component in the form of a GUID.

description: The name of the tool component.

description: The organization or company that produced the tool component.

description: A product suite to which the tool component belongs.

description: A localizable string containing the name of the suite of products to which the tool component belongs.

description: A brief description of the tool component.

description: A comprehensive description of the tool component.

description: The name of the tool component along with its version and any other useful identifying information, such as its locale.

description: The tool component version, in whatever format the component natively provides.

description: The tool component version in the format specified by Semantic Versioning 2.0.

description: The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

description: A string specifying the UTC date (and optionally, the time) of the component's release.

description: The absolute URI from which the tool component can be downloaded.

description: The absolute URI at which information about this version of the tool component can be found.

description: A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

description: An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

description: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

description: An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

description: An array of the artifactLocation objects associated with the tool component.

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

description: The kinds of data contained in this object.

description: Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

description: The semantic version of the localized strings defined in this component; maintained by components that provide translations.

description: The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

description: The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.

description: Translation metadata, required for a translation, not populated by other component types.

description: An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

description: Key/value pairs that provide additional information about the tool component.

description: The 'name' property of the referenced toolComponent.

description: An index into the referenced toolComponent in tool.extensions.

description: The 'guid' property of the referenced toolComponent.

description: Key/value pairs that provide additional information about the toolComponentReference.

description: Provides additional metadata related to translation.

description: The name associated with the translation metadata.

description: The full name associated with the translation metadata.

description: A brief description of the translation metadata.

description: A comprehensive description of the translation metadata.

description: The absolute URI from which the translation metadata can be downloaded.

description: The absolute URI from which information related to the translation metadata can be downloaded.

description: Key/value pairs that provide additional information about the translation metadata.

description: Specifies the information necessary to retrieve a desired revision from a version control system.

description: The absolute URI of the repository.

description: A string that uniquely and permanently identifies the revision within the repository.

description: The name of a branch containing the revision.

description: A tag that has been applied to the revision.

description: A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.

description: The location in the local file system to which the root of the repository was mapped at the time of the analysis.

description: Key/value pairs that provide additional information about the version control details.

description: A web request object.

description: The index within the run.webRequests array of the request object associated with this result.

description: The request protocol. Example: 'http'.

description: The request version. Example: '1.1'.

description: The target of the request.

description: The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

description: The request headers.

description: The request parameters.

description: The body of the request.

description: Key/value pairs that provide additional information about the request.

description: A web response object.

description: The index within the run.webResponses array of the response object associated with this result.

description: The response protocol. Example: 'http'.

description: The response version. Example: '1.1'.

description: The response status code. Example: 451.

description: The response reason. Example: 'Not found'.

description: The response headers.

description: The body of the response.

description: Specifies whether a response was received from the server.

description: Key/value pairs that provide additional information about the response.

description: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema: a standard format for the output of static analysis tools.

description: The URI of the JSON schema corresponding to the version.

description: The SARIF format version of this log file.

description: The set of runs contained in this log file.

description: References to external property files that share data between runs.

description: Key/value pairs that provide additional information about the log file.

title: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema


discovery.schema.json

title: JSON Schema for discovery.yml

description: Meltano (https://meltano.com) is an open source platform for building, running & orchestrating ELT pipelines

$ref: #/$defs/extractors

$ref: #/$defs/loaders

$ref: #/$defs/orchestrators

$ref: #/$defs/transformers

$ref: #/$defs/files

$ref: #/$defs/utilities

$ref: #/$defs/transforms

$ref: #/$defs/mappers

required: name namespace

description: The name of the plugin.

description: The namespace of this plugin

description: A user friendly label describing the plugin

examples:
Stripe
Facebook Ads

description: A description for what the plugin does

description: An object containing commands to be run by the plugin, the keys are the name of the command and the values are the arguments to be passed to the plugin executable.

description: A URL to the documentation for this plugin

description: The plugin's executable name, as defined in setup.py (if a Python based plugin)

description: The same of the variant.

$ref: #/$defs/requires

description: The pip hosted package name or URL

description: The URL to the repository where the plugin code lives.

description: A set consisting of one valid combination of required setting names

description: The name of the variant.

enum: properties catalog discover state about stream-maps activate-version batch test log-based

description: An object containing Singer stream and property metadata

description: An object representing override rules for a Singer stream schema

description: An array of entity selection rules in the form '<entity|*>.<attribute|*>'

$ref: #/$defs/common

description: The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to.

description: The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from.

enum: about stream-maps activate-version batch soft-delete hard-delete datatype-failsafe record-flattening

type: boolean

description: An object containing dbt model variables

description: The name of the dbt package's internal dbt project: the value of name in dbt_project.yml.

description: Name of the invokable mappings and their associated configs.

required: config name

description: The name of the setting

description: Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'

description: A user friendly label for the setting

description: The default value of this setting if not otherwise defined

description: A placeholder value for this setting

description: The type of value this setting contains

enum: oauth hidden password date_iso8601 file email integer options object array boolean string

description: A description for what this setting does

examples: The unique account identifier for your Stripe Account

description: A phrase to provide additional information on this setting

description: A link to documentation on this setting

description: A protected setting cannot be changed from the UI

description: An environment variable that will be initialized with the setting's value whenever the plugin is invoked. This is used to inject environment variables into the plugin's execution context. If the named environment variable is already defined at runtime, Meltano will use the passed value from context instead of the configured value.

description: Used with `kind: object` to process the keys in a particular way.

description: The name of a Meltano-supported OAuth provider

description: The defined value of the option.

description: A set of plugin requirements.

description: A single plugin requirement

description: The name of the required plugin

description: The variant of the required plugin


bashly.json

title: argument

description:
A positional argument of the current script or sub-command
https://bashly.dannyb.co/configuration/argument/

title: name

description:
A name of the current positional argument
https://bashly.dannyb.co/configuration/argument/#name

title: help

description:
A description of the current positional argument
https://bashly.dannyb.co/configuration/argument/#help

title: default

description:
A default value of the current positional argument
https://bashly.dannyb.co/configuration/argument/#default

title: required

description:
Whether the current positional argument is required
https://bashly.dannyb.co/configuration/argument/#required

title: allowed

description:
Valid values of the current positional argument
https://bashly.dannyb.co/configuration/argument/#allowed

description: A valid value of the current positional argument

title: repeatable

description:
Whether the current positional argument can be repeated
https://bashly.dannyb.co/configuration/argument/#repeatable

title: validate

description:
A validation function of the current positional argument
https://bashly.dannyb.co/configuration/argument/#validate

title: flag

description:
A flag of the current script or sub-command
https://bashly.dannyb.co/configuration/flag/

title: long

description:
A long form of the current flag
https://bashly.dannyb.co/configuration/flag/#long

title: short

description:
A short form of the current flag
https://bashly.dannyb.co/configuration/flag/#short

title: help

description:
A description of the current flag
https://bashly.dannyb.co/configuration/flag/#help

title: arg

description:
An argument name of the current flag
https://bashly.dannyb.co/configuration/flag/#arg

title: default

description:
A default value of the current flag
https://bashly.dannyb.co/configuration/flag/#default

title: required

description:
Whether the current flag is required
https://bashly.dannyb.co/configuration/flag/#required

title: allowed

description:
Valid values of the current flag
https://bashly.dannyb.co/configuration/flag/#allowed

title: conflicts

description:
Mutually exclusive flags of the current flag
https://bashly.dannyb.co/configuration/flag/#conflicts

description: A mutually exclusive flag of the current flag

title: completions

description:
Completions of the current flag
https://bashly.dannyb.co/configuration/flag/#completions

description: A completion of the current flag

title: private

description:
Whether the current flag is hidden from help
https://bashly.dannyb.co/configuration/flag/#private

title: repeatable

description:
Whether the current flag can be repeated
https://bashly.dannyb.co/configuration/flag/#repeatable

title: validate

description:
A validation function of the current flag
https://bashly.dannyb.co/configuration/flag/#validate

title: name

description:
A name of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#name

$comment: 'sub-command-' prefix is used as this property is marked with 'Sub-Commands Only' badge

title: alias

description:
An alias of the current sub-command
https://bashly.dannyb.co/configuration/command/#alias

description:
Aliases of the current sub-command
https://bashly.dannyb.co/configuration/command/#alias

description: An alias of the current sub-command

title: help

description:
A description of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#help

title: args

description:
Arguments of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#args

$ref: #/definitions/argument

title: flags

description:
Flags of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#flags

$ref: #/definitions/flag

title: commands

description:
Subcommands of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#commands

$ref: #/definitions/command-property

$comment: 'root-' prefix is used as this property is marked with 'Root Command Only' badge

title: version

description:
A version of the current script
https://bashly.dannyb.co/configuration/command/#version

title: default

description:
Whether to use the current command as a fallback when CLI used incorrectly
https://bashly.dannyb.co/configuration/command/#default

$comment: 'environment-variables-' prefix is used as this property is related to https://bashly.dannyb.co/configuration/environment-variable/#environment-variable

title: name

description:
A name of the current environment variable
https://bashly.dannyb.co/configuration/environment-variable/#name

title: help

description:
A description of the current environment variable
https://bashly.dannyb.co/configuration/environment-variable/#help

title: default

description:
A default value of the current environment variable
https://bashly.dannyb.co/configuration/environment-variable/#default

title: private

description:
Whether the current environment variable is hidden from help
https://bashly.dannyb.co/configuration/environment-variable/#private

title: required

description:
Whether the current environment variable is required
https://bashly.dannyb.co/configuration/environment-variable/#required

title: environment variables

description:
Environment variables of the current application
https://bashly.dannyb.co/configuration/environment-variable/#environment-variable

title: environment variable

description:
An environment variable of the current application
https://bashly.dannyb.co/configuration/environment-variable/#environment-variable

title: examples

description:
An example of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#examples

examples: cli upload profile.png -u admin -p s3cr3t

description:
Examples of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#examples

title: footer

description:
A description footer for the current script or sub-command
https://bashly.dannyb.co/configuration/command/#footer

examples: This will appear at the end of the --help message

title: group

description:
A group of the current sub-command
https://bashly.dannyb.co/configuration/command/#group

title: catch all

description:
Whether to allow additional arguments or flags for the current command
https://bashly.dannyb.co/configuration/command/#catch_all

examples: Additional arguments or flags for AWS CLI

description:
A label for the current argument or flag
https://bashly.dannyb.co/configuration/command/#catch_all

description:
A description for the current argument or flag
https://bashly.dannyb.co/configuration/command/#catch_all

description:
Whether the current argument or flag is required
https://bashly.dannyb.co/configuration/command/#catch_all

title: completions

description:
Completions of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#completions

description: A completion of the current script or sub-command

examples: <alias> <arrayvar> <binding> <builtin> <command> <directory> <disabled> <enabled> <export> <file> <function> <group> <helptopic> <hostname> <job> <keyword> <running> <service> <setopt> <shopt> <signal> <stopped> <user> <variable>

title: command

description:
Dependencies of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#command

description:
A dependency of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#command

title: help

description:
A help for the current dependency
https://bashly.dannyb.co/configuration/dependency/#help

title: dependencies

description:
Dependencies of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#dependency

description:
A dependency of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#dependency

title: expose

description:
Whether to expose the current sub-command if it has sub-commands
https://bashly.dannyb.co/configuration/command/#expose

title: extensible

description:
Whether to delegate the current unknown command to an external executable
https://bashly.dannyb.co/configuration/command/#extensible

title: filename

description:
A partial file path of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#filename

title: filters

description:
Filters of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#filters

description: A filter of the current script or sub-command

title: function

description:
An internal function for the current script or sub-command
https://bashly.dannyb.co/configuration/command/#function

title: private

description:
Whether hide the current sub-command from help
https://bashly.dannyb.co/configuration/command/#private

title: import

description:
A file import for the current sub-command
https://bashly.dannyb.co/configuration/command/#import

title: command

description:
A command of the current application
https://bashly.dannyb.co/configuration/command/#command

$ref: #/definitions/name-property

$ref: #/definitions/help-property

$ref: #/definitions/args-property

$ref: #/definitions/flags-property

$ref: #/definitions/commands-property

$ref: #/definitions/examples-property

$ref: #/definitions/footer-property

$ref: #/definitions/catch-all-property

$ref: #/definitions/completions-property

$ref: #/definitions/dependencies-property

$ref: #/definitions/filename-property

$ref: #/definitions/filters-property

$ref: #/definitions/function-property

title: cli

description:
A CLI of the current application
https://bashly.dannyb.co/usage/getting-started/

$ref: #/definitions/root-version-property


enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

description:
Consent level is meant to interpret the consent-levels of an event for decryption purposes only.

Cumulative means that the highest consent-level in an event must be greater than or equal to the single requested level
for the decrypted stream.

Granular means that the set of consent-levels in an event must enclose the set of requested event levels for the
decrypted stream.

markdownEnumDescriptions:
(or 0)
(or "CONSENT_LEVEL_TYPE_UNSPECIFIED")
(or 1)
(or "CUMULATIVE")
(or 2)
(or "GRANULAR")

title: Unknown field

title: string billing_id = 1;

title: string client_id = 2;

title: string client_secret = 3;

description: as this property is secret, it is not always returned

title: string project_id = 4;

description: Credentials to produce to the event-gateway, or to consume from egress.

title: Unknown field

title: int64 event_count = 2;

description: filled in from customer profile

title: int64 event_rate = 1;

description: filled in from customer profile

title: Unknown field

title: map<string, strmprivacy.api.entities.v1.MaskedFields.PatternList> field_patterns = 3;

description:
map of event-contract-ref vs field patterns

constraints:
 data-contract-refs should be existing data contracts
 field_patterns should be valid values (checked by events-core)
 the field_patterns list should have no duplicates.

title: string hash_type = 1;

description: Default Murmurhash3 if empty

title: string seed = 2;

description: hashing seed

title: Unknown field

title: string

title: repeated string field_patterns = 1;

title: Unknown field

title: bool enabled = 5;

description: whether or not this stream is enabled.

title: int32

title: repeated int32 consent_levels = 3;

description:
consent levels for derived streams

constraints:
if consent_level_type ==  CUMULATIVE then
size = 1
endif

title: string description = 2;

description: Stream description

title: strmprivacy.api.entities.v1.Limits limits = 6;

description: stream limits

title: strmprivacy.api.entities.v1.StreamRef ref = 1;

title: string

title: repeated string tags = 8;

description: tags are meant for customers to tag their streams

title: strmprivacy.api.entities.v1.ConsentLevelType consent_level_type = 4;

description: how event consent-levels are interpreted by decrypters.

title: string linked_stream = 7;

description: null for source streams

title: string policy_id = 12;

description: The id of the policy that should be applied to this stream's data

title: strmprivacy.api.entities.v1.Credentials

title: repeated strmprivacy.api.entities.v1.Credentials credentials = 9;

title: string kafka_topic = 11;

description: Kafka topic of the stream. Deprecated in favor of topic in message ExtendedStream

deprecationMessage: Field "kafka_topic" is marked as deprecated

title: strmprivacy.api.entities.v1.MaskedFields masked_fields = 10;

description:
field masking is defined per OUTPUT stream and event-contract ref. combination

The default empty map means no masking. Otherwise, the algorithm in the decrypter is as follows.

 A source stream is (partially) decrypted, and events that don't have enough permissions are dropped.
 the event contract ref string is used to find a MaskedFields instance.
 if present, for all field patterns in the MaskedFields instance, the hash with the specified seed is applied.

description:
Streams are source or derived streams depending on whether or not linked_stream is null.
Key streams are a separate entity in the api.

title: Unknown field

title: string billing_id = 1;

deprecationMessage: Field "billing_id" is marked as deprecated

title: string name = 2;

description:
the name of the stream
constraints: generic name

title: string project_id = 3;

description: refers to a event stream.

title: strmprivacy.api.entities.v1.Stream


backportrc.json

description: A Backport config schema

description:
A repo name for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#reponame-required

description:
A repo owner for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#repoowner-required

description:
Target branches for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required

description:
A target branch for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required

title: target branch

required: name checked

description:
Whether to pre-select a target branch for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required

description: Identifier for the GitHub project as `{owner}/{repoName}`

description: Branches to backport to

description: Labels that will be added to the pull request

description: Whether to only show the current user's commits or commits from anyone

required: repoName repoOwner targetBranchChoices


minecraft-configured-carver.json

description:
A carver for a data pack for Minecraft
https://minecraft.fandom.com/wiki/Custom_world_generation#Carvers

description:
A type for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: carver options

description:
Options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

description:
A probability that each chunk attempts to generate for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

type: number

title: height

description:
A height at which to generate the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

description:
Blocks can be carved for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

description:
A block can be carved for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: replacement options

description:
Replace blocks for debugging for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

description:
Whether to enable debug mode for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: air replacement options

description:
Air replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: water replacement options

description:
Water replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: lava replacement options

description:
Lava replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: barrier replacement options

description:
Barrier replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: vertical scaling options

description:
Vertical scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: horizontal tunnel scaling options

description:
Horizontal tunnel scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: vertical tunnel scaling options

description:
Vertical tunnel scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: floor level options

description:
Floor level options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: vertical rotation options

description:
Vertical rotation options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: ravine shape options

description:
Ravine shape for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format

title: carver


jx-requirements.json

$ref: #/definitions/Requirements

$ref: #/definitions/AzureClusterNodesConfig

$ref: #/definitions/AzureDNSConfig

$ref: #/definitions/AzureSecretConfig

$ref: #/definitions/AzureStorageConfig

$ref: #/definitions/AzureConfig

$ref: #/definitions/GKEConfig

$ref: #/definitions/IssueTracker

$ref: #/definitions/IngressConfig

$ref: #/definitions/TLSConfig

$ref: #/definitions/JiraTracker

$ref: #/definitions/MavenRepositoryConfig

$ref: #/definitions/RequirementsConfig

$ref: #/definitions/AutoUpdateConfig

$ref: #/definitions/ClusterConfig

$ref: #/definitions/EnvironmentConfig

$ref: #/definitions/UserNameEmailConfig

$ref: #/definitions/RepositoryConfig

$ref: #/definitions/StorageConfig


csslintrc.json

description:
CSS Lint rule

'false' means rule is off
'true' means it is a warning
'2' means the rule is an error

$ref: #/definitions/rule

title: JSON schema for CSS Lint configuration files


drone.json

enum: linux windows darwin freebsd netbsd openbsd dragonfly solaris

$ref: #/definitions/nonEmptyString

$ref: #/definitions/secret

$ref: #/definitions/condition

$ref: #/definitions/conditions

required: name host

required: name path

required: name temp

required: name claim

required: name image

$ref: #/definitions/commands

$ref: #/definitions/environment

const: always

$ref: #/definitions/volumes

const: signature

const: secret

required: path name

required: type name steps

const: pipeline

enum: docker kubernetes ssh exec digitalocean macstadium

$ref: #/definitions/platform

$ref: #/definitions/allConditions

const: docker

$ref: #/definitions/services

description: If specified, the pod's tolerations.

description: Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

description: HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.

description: A list of node selector terms.

description: The name of the service account to use when running the kubernetes pipeline

title: Drone CI configuration file


execution-environment.json

title: Commands to append or prepend to container build process.

title: Ansible configuration file

description: Allows adding system, python or galaxy dependencies.

markdownDescription: Example `requirements.yml`

title: Optional galaxy file

markdownDescription: Example `requirements.txt`

title: Optional python package dependencies

markdownDescription: Example `bindep.txt`

title: Optional system dependencies using bindep format

title: Dependencies

title: Version

required: version dependencies

title: Ansible Execution Environment Schema v1

description: Describes files to add to the build context

description: Relative subdirectory under build context to place file

description: File to add to build context

required: src dest

description: Ansible package installation

description: Ansible package to install via pip

description: Ansible Runner package installation

description: Ansible Runner package to install via pip

title: Optional galaxy file

title: Optional python package dependencies

description: Python package name and path

description: The python package to install via system package manager

description: Path to the python interpreter

title: Dependencies

description: Options that effect runtime behavior

description: Customize container startup behavior

description: literal value for CMD Containerfile directive

description: literal value for ENTRYPOINT Containerfile directive

description: package to install via pip for entrypoint support

description: Path to the system package manager to use

description: allows GID0 write access to /etc/passwd; currently necessary for many uses

description: Disables the check for Ansible/Runner in final image

description: Sets the username or UID

description: Default working directory, also often the homedir for ephemeral UIDs

title: Version

title: Ansible Execution Environment Schema v3

description:
See
V1: https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html
V3: https://ansible-builder.readthedocs.io/en/latest/definition/

title: Ansible Execution Environment Schema v1/v3