key: blockGap

description:
Enables `--wp--style--block-gap` to be generated from styles.spacing.blockGap.
A value of `null` instead of `false` further disables layout styles from being generated.


key: margin

description: Allow users to set a custom margin.

type: boolean


key: padding

description: Allow users to set a custom padding.


key: units

description: List of units the user can use for spacing values.

type: array

type: string

default: px em rem vh vw %


key: customSpacingSize

description: Allow users to set custom space sizes.


key: spacingSizes

description:
Space size presets for the space size selector.
Generates a custom property (`--wp--preset--spacing--{slug}`) per preset value.

type: object


key: name

description: Name of the space size preset, translatable.


key: slug

description: Unique identifier for the space size preset. For best cross theme compatibility these should be in the form '10','20','30','40','50','60', etc. with '50' representing the 'Medium' size step.


key: size

description: CSS space-size value, including units.


key: spacingScale

description:
Settings to auto-generate space size presets for the space size selector.
Generates a custom property (--wp--preset--spacing--{slug}`) per preset value.

type: number

type: integer

enum: px em rem vh vw %

default: rem


key: operator

description: With + or * depending on whether scale is generated by increment or multiplier.


key: increment

description: The amount to increment each step by.


key: steps

description: Number of steps to generate in scale.


key: mediumStep

description: The value to medium setting in the scale.


key: unit

description: Unit that the scale uses, eg. rem, em, px.


key: typography

description: Settings related to typography.

default: normal

default: fallback

enum: auto block fallback swap optional

required: fontFamily src


key: customFontSize

description: Allow users to set custom font sizes.


key: fontStyle

description: Allow users to set custom font styles.


key: fontWeight

description: Allow users to set custom font weights.


key: fluid

description: Enables fluid typography and allows users to set global fluid typography parameters.


key: minFontSize

description: Allow users to set a global minimum font size boundary in px, rem or em. Custom font sizes below this value will not be clamped, and all calculated minimum font sizes will be, at a minimum, this value.


key: maxViewportWidth

description: Allow users to set custom a max viewport width in px, rem or em, used to set the maximum size boundary of a fluid font size.


key: minViewportWidth

description: Allow users to set a custom min viewport width in px, rem or em, used to set the minimum size boundary of a fluid font size.


key: letterSpacing

description: Allow users to set custom letter spacing.


key: lineHeight

description: Allow users to set custom line height.


key: textColumns

description: Allow users to set the number of text columns.


key: textDecoration

description: Allow users to set custom text decorations.


key: writingMode

description: Allow users to set the writing mode.


key: textTransform

description: Allow users to set custom text transforms.


key: dropCap

description: Enable drop cap.


key: fontSizes

description:
Font size presets for the font size selector.
Generates a single class (`.has-{slug}-color`) and custom property (`--wp--preset--font-size--{slug}`) per preset value.


key: name

description: Name of the font size preset, translatable.


key: slug

description: Kebab-case unique identifier for the font size preset.


key: size

description: CSS font-size value, including units.


description: Specifies the minimum and maximum font size value of a fluid font size. Set to `false` to bypass fluid calculations and use the static `size` value.


key: min

description: A min font size for fluid font size calculations in px, rem or em.


key: max

description: A max font size for fluid font size calculations in px, rem or em.


key: fontFamilies

description:
Font family presets for the font family selector.
Generates a single custom property (`--wp--preset--font-family--{slug}`) per preset value.


description: Name of the font family preset, translatable.


description: Kebab-case unique identifier for the font family preset.


key: fontFamily

description: CSS font-family value.


key: fontFace

description: Array of font-face declarations.


key: fontStyle

description: CSS font-style value.


key: fontWeight

description: List of available font weights, separated by a space.


key: fontDisplay

description: CSS font-display value.


key: src

description: Paths or URLs to the font files.


key: fontStretch

description: CSS font-stretch value.


key: ascentOverride

description: CSS ascent-override value.


key: descentOverride

description: CSS descent-override value.


key: fontVariant

description: CSS font-variant value.


key: fontFeatureSettings

description: CSS font-feature-settings value.


key: fontVariationSettings

description: CSS font-variation-settings value.


key: lineGapOverride

description: CSS line-gap-override value.


key: sizeAdjust

description: CSS size-adjust value.


key: unicodeRange

description: CSS unicode-range value.


key: custom

description: Generate custom CSS custom properties of the form `--wp--custom--{key}--{nested-key}: {value};`. `camelCased` keys are transformed to `kebab-case` as to follow the CSS property naming schema. Keys at different depth levels are separated by `--`, so keys should not include `--` in the name.


key: behaviors

description: Settings related to behaviors.


key: lightbox

description: Allow users to enable/disable lightbox.


key: border

description: Border styles.


key: color

description: Sets the `border-color` CSS property.


key: radius

description: Sets the `border-radius` CSS property.


key: topLeft

description: Sets the `border-top-left-radius` CSS property.


key: topRight

description: Sets the `border-top-right-radius` CSS property.


key: bottomLeft

description: Sets the `border-bottom-left-radius` CSS property.


key: bottomRight

description: Sets the `border-bottom-right-radius` CSS property.


key: style

description: Sets the `border-style` CSS property.


key: width

description: Sets the `border-width` CSS property.


description: Sets the `border-top-color` CSS property.


description: Sets the `border-top-style` CSS property.


description: Sets the `border-top-width` CSS property.


description: Sets the `border-right-color` CSS property.


description: Sets the `border-right-style` CSS property.


description: Sets the `border-right-width` CSS property.


description: Sets the `border-bottom-color` CSS property.


description: Sets the `border-bottom-style` CSS property.


description: Sets the `border-bottom-width` CSS property.


description: Sets the `border-left-color` CSS property.


description: Sets the `border-left-style` CSS property.


description: Sets the `border-left-width` CSS property.


description: Color styles.


key: background

description: Sets the `background-color` CSS property.


key: gradient

description: Sets the `background` CSS property.


key: text

description: Sets the `color` CSS property.


key: dimensions

description: Dimensions styles


key: minHeight

description: Sets the `min-height` CSS property.


key: spacing

description: Spacing styles.


key: blockGap

description: Sets the `--wp--style--block-gap` CSS custom property when settings.spacing.blockGap is true.


key: margin

description: Margin styles.


key: top

description: Sets the `margin-top` CSS property.


key: right

description: Sets the `margin-right` CSS property.


key: bottom

description: Sets the `margin-bottom` CSS property.


key: left

description: Sets the `margin-left` CSS property.


key: padding

description: Padding styles.


description: Sets the `padding-top` CSS property.


description: Sets the `padding-right` CSS property.


description: Sets the `padding-bottom` CSS property.


description: Sets the `padding-left` CSS property.


key: typography

description: Typography styles.


key: fontFamily

description: Sets the `font-family` CSS property.


key: fontSize

description: Sets the `font-size` CSS property.


key: fontStyle

description: Sets the `font-style` CSS property.


key: fontWeight

description: Sets the `font-weight` CSS property.


key: letterSpacing

description: Sets the `letter-spacing` CSS property.


key: lineHeight

description: Sets the `line-height` CSS property.


key: textColumns

description: Sets the `column-count` CSS property.


key: textDecoration

description: Sets the `text-decoration` CSS property.


key: writingMode

description: Sets the `writing-mode` CSS property.


key: textTransform

description: Sets the `text-transform` CSS property.


key: filter

description: CSS and SVG filter styles.


key: duotone

description: Sets the duotone filter.


key: shadow

description: Box shadow styles.


key: outline

description: Outline styles.


key: color

description: Sets the `outline-color` CSS property.


key: offset

description: Sets the `outline-offset` CSS property.


key: style

description: Sets the `outline-style` CSS property.


key: width

description: Sets the `outline-width` CSS property.


key: css

description: Sets custom CSS to apply styling not covered by other theme.json properties.


key: $schema

description: JSON schema URI for theme.json.


key: version

description: Version of theme.json to use.


key: title

description: Title of the global styles variation. If not defined, the file name will be used.


key: description

description: Description of the global styles variation.


key: behaviors

description: A list of blocks that have behaviors. This setting controls the display of the Behaviors UI in the block editor.


key: settings

description:
Settings for the block editor and individual blocks. These include things like:
- Which customization options should be available to the user.
- The default colors, font sizes... available to the user.
- CSS custom properties and class names used in styles.
- And the default layout of the editor (widths and available alignments).


key: blocks

description: Settings defined on a per-block basis.


key: styles

description: Organized way to set CSS properties. Styles in the top-level will be added in the `body` selector.


key: elements

description: Styles defined on a per-element basis using the element's selector.


description: Styles defined on a per-block basis using the block's selector.


key: customTemplates

description: Additional metadata for custom templates defined in the templates folder.

required: name title


key: name

description: Filename, without extension, of the template in the templates folder.


description: Title of the template, translatable.


key: postTypes

description: List of post types that can use this custom template.


key: templateParts

description: Additional metadata for template parts defined in the parts folder.

default: uncategorized


description: Filename, without extension, of the template in the parts folder.


key: area

description: The area the template part is used for. Block variations for `header` and `footer` values exist and will be used when the area is set to one of those.


key: patterns

description: An array of pattern slugs to be registered from the Pattern Directory.


key: direct

description: All explicitly defined dependencies.


key: indirect

description: Dependencies of direct dependencies (also known as sub-dependencies, or transient dependencies).


key: all

description: All explicitly defined dependencies. For bundler, pip, composer, cargo, also the dependencies of direct dependencies.


key: production

description: Only dependencies in the 'Product dependency group'.


key: development

description: Only dependencies in the 'Development dependency group'.


key: lockfile-only

description: Only create pull requests to update lockfiles updates. Ignore any new versions that would require package manifest changes.


key: auto

description: Follow the default strategy described above.


key: widen

description: Relax the version requirement to include both the new and old version, when possible.


key: increase

description: Always increase the version requirement to match the new version.


key: increase-if-necessary

description: Increase the version requirement only when required by the new version.


key: allow

description: Customize which updates are allowed


key: assignees

description: Assignees to set on pull requests


key: commit-message

description: Commit message preferences

default: scope


key: directory

description: Location of package manifests


key: ignore

description: Ignore certain dependencies or versions


key: insecure-external-code-execution

description: Allow or deny code execution in manifest files


key: labels

description: Labels to set on pull requests


key: milestone

description: Milestone to set on pull requests


key: open-pull-requests-limit

description: Limit number of open pull requests for version updates


key: package-ecosystem

description: Package manager to use


key: pull-request-branch-name

description: Pull request branch name preferences


key: separator

description: Change separator for PR branch name


key: rebase-strategy

description: Disable automatic rebasing

enum: auto disabled

default: auto


key: reviewers

description: Reviewers to set on pull requests


key: schedule

description: Schedule preferences


key: day

description: Specify an alternative day to check for updates


key: time

description: Specify an alternative time of day to check for updates (format: hh:mm)


key: timezone

description: The time zone identifier must be from the Time Zone database maintained by IANA


key: target-branch

description: Branch to create pull requests against


key: vendor

description: Update vendored or cached dependencies


key: versioning-strategy

description: How to update manifest version requirements


key: registry

description: The top-level registries key is optional. It allows you to specify authentication details that Dependabot can use to access private package registries.

enum: composer-repository docker-registry git hex-organization hex-repository maven-repository npm-registry nuget-feed python-index rubygems-server terraform-registry


key: type

description: Identifies the type of registry.


key: url

description: The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, https:// is assumed. Dependabot adds or ignores trailing slashes as required.


key: username

description: The username that Dependabot uses to access the registry.


key: password

description: A reference to a Dependabot secret containing the password for the specified user.


key: key

description: A reference to a Dependabot secret containing an access key for this registry.


key: token

description: A reference to a Dependabot secret containing an access token for this registry.


key: replaces-base

description: For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).


key: enable-beta-ecosystems

description: Enable ecosystems that have beta-level support


key: items

description: Element for each one package manager that you want GitHub Dependabot to monitor for new versions


description: Configuration for Dart tests

format: uri

examples: compact expanded json


key: timeout

description: Indicates that tests should never time out.


description: Exact timeout duration for a test.


description: Timeout is applied as a multiple of the default value (30 seconds)


key: executable

description: The executable to run. Can be a plain basename, an absolute path or a relative path on Windows.


key: arguments

description: The arguments are parsed in the same way as the POSIX shell


description: This field controls whether or not traces caused by errors are trimmed to remove internal stack frames. This includes frames from the Dart core libraries, the stack_trace package, and the test package itself.


description: Disabling stack trace chaining will improve performance for heavily async code at the cost of debuggability.


description: Whether or not stack traces caused by errors while running Dart compiled to JS are converted back to Dart style.


key: retry

description: This field controls how many times a test is retried upon failure.


description: Adds additional tags. This is usually used in a tag definition to enable tag inheritance.


key: presets

description: A preset used in a test configuration can contain test configuration.


description: Applies test options when a specific operating system is used


key: filename

description: Filename pattern that the test runner uses to find test files in directories.


key: names

description: Only run tests whose names match the given regular expressions A test's name must match all regular expressions in names in order to be run.


description: This field causes the runner to only run tests whose names contain the given strings. A test's name must contain all strings in order to be run.


description: This field causes the runner to only run tests whose tags match the given boolean selector.


description: This field causes the runner to only run tests whose tags match the given boolean selector. This takes precedence over include_tags


key: platforms

description: The platforms on which tests should be run.


key: concurrency

description: The default number of test suites to run in parallel. This defaults to approximately half the number of processors on the current machine. Setting it to 1 will disable concurrency


description: Indicates that the test runner should pause for debugging after each test suite is loaded but before its tests are executed. This disables concurrency and timeouts.


description: Run tests even if they're marked as skipped.


key: reporter

description: This field indicates the default reporter to use.


description: Specifies additional reporters that will write their output to a file rather than stdout


description: This field specifies the path of the HTML template to be used for tests run in an HTML environment.


description: Commonly used in a preset, it can be used to enable present inheritance by adding the configuration from another preset.


description: Applies test or runner options when a specific operating system is used


key: identifiers

description: A flag indicating whether to limit the search to nodes with matching identifiers


key: ignore

description: A regular expression used for matching paths to ignore


key: jsx

description: A flag indicating whether to process JSX files


description: The name of the reporter to be used

default: default

enum: default json pmd


key: suppress

description: The number of lines at which diffs should be suppressed. A value of 0 is off.


key: threshold

description: A threshold determining the smallest subset of nodes to analyze


description: Configuration file definition for sfdx-hardis Salesforce DX plugin

enum: sandbox scratch

enum: caseentitlement dashboards datadotcom destructivechanges localfields listViewsMine minimizeProfiles productrequest systemDebug

value: feat

value: fix

required: globPattern xpaths

label: Custom commands

label: Generate manifest

tooltip: Generates a manifest package.xml using local sfdx source files

command: sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest

label: List all orgs

tooltip: List all orgs that has already been authenticated using sfdx

command: sfdx force:org:list --all

label: Another custom menu

label: Echo something

tooltip: Useless commands just to show that we can use not sfdx commands too

command: echo "Something"

required: id label command

required: id label

default: first

enum: first last

examples: first last

examples: mo-dx-plugin shane-sfdx-plugins

required: dataPath importInScratchOrgs

default: developpement

examples: developpement dev_lot2 hotfixes

label: Import EmailTemplate records

dataPath: scripts/data/EmailTemplate

label: Deploy EmailTemplate

label: Deploy Flow-Workflow

examples:
Deploy EmailTemplate
Import EmailTemplate records

required: label order

examples: MyPermissionSet MyPermissionSetGroup

type: object string

SubscriberPackageName: Declarative Lookup Rollup Summaries Tool

SubscriberPackageNamespace: dlrs

installationkey: MyInstallationKey

SubscriberPackageName: Files Attachment Notes


key: allowedOrgTypes

description: Types of orgs allowed for config & development. If not set, sandbox and scratch are allowed by default


key: autoCleanTypes

description: When saving a sfdx-hardis task, the list of cleanings will be automatically applied to sfdx sources


key: autoRemoveUserPermissions

description: When saving a sfdx-hardis task, these permissions will be removed from profiles


key: autoRetrieveWhenPull

description: When calling hardis:scratch:pull, if you define metadatas (named or not), they will also be retrieved using force:source:retrieve


key: apexTestsMinCoverageOrgWide

description: Minimum percentage of apex code coverage accepted


key: availableProjects

description: List of business projects that are managed in the same repository. Will be used to build git branch name when using hardis:work:new


key: availableTargetBranches

description: List of git branches that can be used as target for merge requests


key: branchPrefixChoices

description: When calling hardis:work:new, you can override the default branch prefixes. Input title, value and description for each of them


key: default

description: New feature, evolution of an existing feature... If you don't know, just select Feature


description: A bug has been identified and you are the right person to solve it !


key: examples


key: cleanXmlPatterns

description: List of patterns to automatically clean XML files


key: items

description: Clean XML pattern and xpaths


key: globPattern

description: Glob pattern to identify XML files to clean


key: xpaths

description: XPaths to identify elements to remove


key: customCommands

description: List of custom commands for VsCode SFDX-Hardis extension


description: Custom command definition


key: id

description: Identifier of the menu (can be any string)


key: label

description: Label of the menu


key: commands

description: List of commands of the menu


description: Custom command definition


description: Identifier of the command (can be any string)


description: Label of the command that will appear in menu


key: icon

description: Icon (can be any of svg icons of this list: https://github.com/hardisgroupcom/vscode-sfdx-hardis/tree/master/resources


key: tooltip

description: Text that will appear when user will hover the command


key: command

description: Command line to run when clicking on the menu


key: helpUrl

description: URL for help page of the command


key: customCommandsPosition

description: Position of custom commands in the menu (first or last)


key: customOrgColors

description: Custom colors set by VsCode SFDX Hardis


key: customPlugins

description: List of additional plugins that will be displayed in VsCode SFDX-Hardis Dependencies panel


description: Plugin definition


key: name

description: Name of the plugin npm package


description: Url of plugin documentation


key: dataPackages

description: List of data packages


description: Data package


key: dataPath

description: Path to SFDMU project


key: importInScratchOrgs

description: Path to SFDMU project


key: defaultPackageInstallationKey

description: When generating a new package version protected with password, use this value as default package installation key


key: developmentBranch

description: When creating a new sfdx-hardis task, this git branch is used as base to create the feature/debug sub branch. The merge request will later have this branch as target.


key: deploymentPlan

description: Deployment plan that will be performed during deployments. Can be based on packageXmlFile for sources or on dataPath for sfdmu data deployments


key: packages

description: During deployment, main package.xml will be split into these packages. Can also contain data packages


key: items

description: Source or data package to deploy


key: waitAfter

description: Delay to wait before installing the next package


key: devHubAlias

description: Dev Hub alias, usually DevHub_ProjectName


key: devHubUsername

description: Dev Hub username, used to authenticate to DevHub from CI jobs


key: extends

description: You can base your local sfdx-hardis configuration on a remote config file. That allows you to have the same config base for all your projects


key: initPermissionSets

description: When creating a scratch org, Admin user will be automatically assigned to those permission sets


description: Permission Set or Permission Set Group


description: Permission Set or Permission Set Group name


key: installedPackages

description: Defines the list of packages installed on the project. Use


description: Salesforce package info (managed, unlocked or unmanaged)


key: installDuringDeployments

description: If true, during deployments this package will be installed in target org if not installed yet


key: installOnScratchOrgs

description: If true, this package will be installed when creating a new scratch org with sfdx-hardis


key: installationkey

description: Installation key for key-protected package


key: installPackagesDuringCheckDeploy

description: When calling deployment check command, installs any package referred within installedPackages property


key: instanceUrl

description: Salesforce instance URL used by CI for deployment or backups


key: listViewsToSetToMine

description: List of ListView items to set to Mine after a delivery (that does not accept value 'Everything')


key: sourcesToRetrofit

description: List of metadata to retrieve for retrofit job

examples: CustomField Layout PermissionSet


key: msTeamsWebhookUrl

description: Url of the Ms Teams channel Web Hook that can be used to send ALL notifications


key: msTeamsWebhookUrlCritical

description: Url of the Ms Teams channel Web Hook that can be used to send CRITICAL notifications


key: msTeamsWebhookUrlSevere

description: Url of the Ms Teams channel Web Hook that can be used to send SEVERE notifications


key: msTeamsWebhookUrlWarning

description: Url of the Ms Teams channel Web Hook that can be used to send WARNING notifications


key: msTeamsWebhookUrlInfo

description: Url of the Ms Teams channel Web Hook that can be used to send INFO notifications


key: poolConfig

description: Configuration allowing to generate and fetch scratch orgs from scratch org pool


key: minScratchOrgRemainingDays

description: When pool scratch org is less than this number, it is deleted and another one is created


key: maxScratchOrgsNumber

description: Maximum number of active scratch orgs in the scratch org pool


key: maxScratchOrgsNumberToCreateOnce

description: Maximum number of scratch orgs to create in one CI job


key: storageService

description: Remote service allowing to store scratch org pool details


key: productionBranch

description: Name of the git branch corresponding to production environment

examples: master main production


key: projectName

description: Identifier for the project (can be the client and project)


key: retrofitBranch

description: Name of the git branch where retrofit merge requests targets to

examples: preprod dev maintenance


key: retrofitIgnoredFiles

description: When calling hardis:org:retrieve:sources:retrofit, list of files to ignore (discard just after retrieve)


key: scratchOrgInitApexScripts

description: Apex scripts to call after scratch org initialization


key: sfdmuCanModify

description: Instance host name to allow SFDMU to deploy data in a production org


key: skipUpdateForceIgnore

description: Defines if sfdx-hardis will propose to upgrade local .forceignore file


key: skipUpdateGitIgnore

description: Defines if sfdx-hardis will propose to upgrade local .gitignore file


key: targetUsername

description: Salesforce username used by CI for deployment or backups


key: linterIgnoreRightMetadataFile

description: Ignore profiles or permission sets


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

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

format: date-time

required: artifactLocation replacements

format: uri-reference

required: configuration descriptor

required: id sourceNodeId targetNodeId

format: uuid

enum: notApplicable pass fail review open informational


key: address

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


key: absoluteAddress

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


key: relativeAddress

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


key: length

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


key: kind

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.


key: name

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


key: fullyQualifiedName

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


key: offsetFromParent

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


key: index

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


key: parentIndex

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


key: properties

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


key: artifact

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


key: description

description: A short description of the artifact.


key: location

description: The location of the artifact.


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


key: offset

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


description: The length of the artifact in bytes.


key: roles

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


key: mimeType

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


key: contents

description: The contents of the artifact.


key: encoding

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


key: sourceLanguage

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


key: hashes

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.


key: lastModifiedTimeUtc

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.


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


key: artifactChange

description: A change to a single artifact.


key: artifactLocation

description: The location of the artifact to change.


key: replacements

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


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


key: artifactContent

description: Represents the contents of an artifact.


key: text

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


key: binary

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


key: rendered

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


key: properties

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


description: Specifies the location of an artifact.


key: uri

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


key: uriBaseId

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


key: index

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


key: description

description: A short description of the artifact location.


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


key: attachment

description: An artifact relevant to a result.


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


description: The location of the attachment.


key: regions

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


key: rectangles

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


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


key: codeFlow

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


key: message

description: A message relevant to the code flow.


key: threadFlows

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


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


key: configurationOverride

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


key: configuration

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


key: descriptor

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


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


key: conversion

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.


key: tool

description: A tool object that describes the converter.


key: invocation

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


key: analysisToolLogFiles

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


key: properties

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


key: edge

description: Represents a directed edge in a graph.


key: id

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


key: label

description: A short description of the edge.


key: sourceNodeId

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


key: targetNodeId

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


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


key: edgeTraversal

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


key: edgeId

description: Identifies the edge being traversed.


key: message

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


key: finalState

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


key: stepOverEdgeCount

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.


key: exception

description: Describes a runtime exception encountered during the execution of an analysis tool.


key: kind

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.


key: stack

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


key: innerExceptions

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


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


key: externalProperties

description: The top-level element of an external property file.


key: schema

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


key: version

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


key: guid

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


key: runGuid

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


key: conversion

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


key: graphs

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


key: externalizedProperties

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


key: artifacts

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


key: invocations

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


key: logicalLocations

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


key: threadFlowLocations

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


key: results

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


key: taxonomies

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


key: driver

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


key: extensions

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


key: policies

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


key: translations

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


key: addresses

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


key: webRequests

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


key: webResponses

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


key: properties

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


key: externalPropertyFileReference

description: Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.


key: location

description: The location of the external property file.


key: guid

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


key: itemCount

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.


key: externalPropertyFileReferences

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


key: conversion

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


key: graphs

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


key: externalizedProperties

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


key: artifacts

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


key: invocations

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


key: logicalLocations

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


key: threadFlowLocations

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


key: results

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


key: taxonomies

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


key: addresses

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


key: driver

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


key: extensions

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


key: policies

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


key: translations

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


key: webRequests

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


key: webResponses

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


key: properties

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


key: fix

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.


key: description

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


key: artifactChanges

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


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


key: graph

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.


key: nodes

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


key: edges

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


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


key: graphTraversal

description: Represents a path through a graph.


key: runGraphIndex

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


key: resultGraphIndex

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


description: A description of this graph traversal.


key: initialState

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


key: immutableState

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


key: edgeTraversals

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


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


key: invocation

description: The runtime environment of the analysis tool run.


key: commandLine

description: The command line used to invoke the tool.


key: arguments

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


key: responseFiles

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


key: startTimeUtc

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


key: endTimeUtc

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


key: exitCode

description: The process exit code.


key: ruleConfigurationOverrides

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


key: notificationConfigurationOverrides

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


key: toolExecutionNotifications

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


key: toolConfigurationNotifications

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


key: exitCodeDescription

description: The reason for the process exit.


key: exitSignalName

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


key: exitSignalNumber

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


key: processStartFailureMessage

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


key: executionSuccessful

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


key: machine

description: The machine on which the invocation occurred.


key: account

description: The account under which the invocation occurred.


key: processId

description: The id of the process in which the invocation occurred.


key: executableLocation

description: An absolute URI specifying the location of the executable that was invoked.


key: workingDirectory

description: The working directory for the invocation.


key: environmentVariables

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


key: stdin

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


key: stdout

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


key: stderr

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


key: stdoutStderr

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


key: properties

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


key: location

description: A location within a programming artifact.


key: id

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


key: physicalLocation

description: Identifies the artifact and region.


key: logicalLocations

description: The logical locations associated with the result.


key: message

description: A message relevant to the location.


key: annotations

description: A set of regions relevant to the location.


key: relationships

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


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


key: locationRelationship

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


key: target

description: A reference to the related location.


key: kinds

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


key: description

description: A description of the location relationship.


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


key: logicalLocation

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


key: name

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


key: index

description: The index within the logical locations array.


key: fullyQualifiedName

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


key: decoratedName

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.


key: parentIndex

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.


key: kind

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.


key: properties

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


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


key: text

description: A plain text message string.


key: markdown

description: A Markdown message string.


key: id

description: The identifier for this message.


key: arguments

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


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


key: multiformatMessageString

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.


key: node

description: Represents a node in a graph.


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


key: label

description: A short description of the node.


key: location

description: A code location associated with the node.


key: children

description: Array of child nodes.


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


key: notification

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

default: warning

enum: none note warning error


key: locations

description: The locations relevant to this notification.


key: message

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


key: level

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


key: threadId

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


key: timeUtc

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


key: exception

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


key: descriptor

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


key: associatedRule

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


key: properties

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


key: physicalLocation

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.


key: address

description: The address of the location.


key: artifactLocation

description: The location of the artifact.


key: region

description: Specifies a portion of the artifact.


key: contextRegion

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.


key: propertyBag

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


key: tags

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


key: rectangle

description: An area within an image.


key: top

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


key: left

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


key: bottom

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


key: right

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


key: message

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.


key: startLine

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


key: startColumn

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


key: endLine

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


key: endColumn

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


key: charOffset

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


key: charLength

description: The length of the region in characters.


key: byteOffset

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


key: byteLength

description: The length of the region in bytes.


key: snippet

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


description: A message relevant to the region.


key: sourceLanguage

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


key: properties

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


key: replacement

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


key: deletedRegion

description: The region of the artifact to delete.


key: insertedContent

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


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


key: reportingDescriptor

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


key: id

description: A stable, opaque identifier for the report.


key: deprecatedIds

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


key: guid

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


key: deprecatedGuids

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.


key: name

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


key: deprecatedNames

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


key: shortDescription

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.


key: fullDescription

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


key: messageStrings

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.


key: defaultConfiguration

description: Default reporting configuration information.


key: helpUri

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


key: help

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


key: relationships

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


key: properties

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


key: reportingConfiguration

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


key: enabled

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


key: level

description: Specifies the failure level for the report.


key: rank

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


key: parameters

description: Contains configuration information specific to a report.


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


key: reportingDescriptorReference

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


key: id

description: The id of the descriptor.


key: index

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


key: guid

description: A guid that uniquely identifies the descriptor.


key: toolComponent

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.


key: reportingDescriptorRelationship

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


key: target

description: A reference to the related reporting descriptor.


key: kinds

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'.


key: description

description: A description of the reporting descriptor relationship.


key: result

description: A result produced by an analysis tool.

default: fail

enum: new unchanged updated absent


key: ruleId

description: The stable, unique identifier of the rule, if any, to which this result is relevant.


key: ruleIndex

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


key: rule

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


key: kind

description: A value that categorizes results by evaluation state.


key: level

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


key: message

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


key: analysisTarget

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.


key: locations

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.


key: correlationGuid

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


key: occurrenceCount

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


key: partialFingerprints

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


key: fingerprints

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


key: stacks

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


key: codeFlows

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


key: graphs

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


key: graphTraversals

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


key: relatedLocations

description: A set of locations relevant to this result.


key: suppressions

description: A set of suppressions relevant to this result.


key: baselineState

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


key: rank

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


key: attachments

description: A set of artifacts relevant to the result.


key: hostedViewerUri

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


key: workItemUris

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


key: provenance

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


key: fixes

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


key: taxa

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


key: webRequest

description: A web request associated with this result.


key: webResponse

description: A web response associated with this result.


key: properties

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


key: resultProvenance

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


key: firstDetectionTimeUtc

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.


key: lastDetectionTimeUtc

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.


key: firstDetectionRunGuid

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


key: lastDetectionRunGuid

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


key: invocationIndex

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


key: conversionSources

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


key: run

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

default: en-US


key: tool

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.


key: invocations

description: Describes the invocation of the analysis tool.


key: conversion

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


key: language

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).


key: versionControlProvenance

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


key: originalUriBaseIds

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


key: artifacts

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


key: logicalLocations

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


key: graphs

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


key: results

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.


key: automationDetails

description: Automation details that describe this run.


key: runAggregates

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


key: baselineGuid

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


key: redactionTokens

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


key: defaultEncoding

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


key: defaultSourceLanguage

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


key: newlineSequences

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


key: columnKind

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


key: externalPropertyFileReferences

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


key: threadFlowLocations

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


key: taxonomies

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


key: addresses

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


key: translations

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


key: policies

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).


key: webRequests

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


key: webResponses

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


key: specialLocations

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


key: properties

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


key: runAutomationDetails

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


key: description

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


key: id

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


key: guid

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


key: correlationGuid

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.


key: displayBase

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.


key: stack

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


key: message

description: A message relevant to this call stack.


key: frames

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.


key: stackFrame

description: A function call within a stack trace.


key: location

description: The location to which this stack frame refers.


key: module

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


key: threadId

description: The thread identifier of the stack frame.


key: parameters

description: The parameters of the call that is executing.


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


key: suppression

description: A suppression that is relevant to a result.

enum: inSource external

enum: accepted underReview rejected


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


key: kind

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


key: status

description: A string that indicates the review status of the suppression.


key: justification

description: A string representing the justification for the suppression.


description: Identifies the location associated with the suppression.


key: properties

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


key: threadFlow

description: Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.


key: id

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


description: A message relevant to the thread flow.


key: initialState

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


key: immutableState

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


key: locations

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.


key: threadFlowLocation

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

enum: important essential unimportant

default: important


key: index

description: The index within the run threadFlowLocations array.


description: The code location.


key: stack

description: The call stack leading to this location.


key: kinds

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'.


key: taxa

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


key: module

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


key: state

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.


key: nestingLevel

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


key: executionOrder

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


key: executionTimeUtc

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


key: importance

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".


key: webRequest

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


key: webResponse

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


key: properties

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


key: tool

description: The analysis tool that was run.


key: driver

description: The analysis tool that was run.


key: extensions

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.


key: toolComponent

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

default: localizedData nonLocalizedData

enum: localizedData nonLocalizedData


key: guid

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


key: name

description: The name of the tool component.


key: organization

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


key: product

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


key: productSuite

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


key: shortDescription

description: A brief description of the tool component.


key: fullDescription

description: A comprehensive description of the tool component.


key: fullName

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


key: version

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


key: semanticVersion

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


key: dottedQuadFileVersion

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).


key: releaseDateUtc

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


key: downloadUri

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


key: informationUri

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


key: globalMessageStrings

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.


key: notifications

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


key: rules

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


key: taxa

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


key: locations

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


key: language

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).


key: contents

description: The kinds of data contained in this object.


key: isComprehensive

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.


key: localizedDataSemanticVersion

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.


key: associatedComponent

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.


key: translationMetadata

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


key: supportedTaxonomies

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


key: properties

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


key: toolComponentReference

description: Identifies a particular toolComponent object, either the driver or an extension.


key: name

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


key: index

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


key: guid

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.


key: fullName

description: The full name associated with the translation metadata.


key: shortDescription

description: A brief description of the translation metadata.


key: fullDescription

description: A comprehensive description of the translation metadata.


key: downloadUri

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


key: informationUri

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.


key: versionControlDetails

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


key: repositoryUri

description: The absolute URI of the repository.


key: revisionId

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


key: branch

description: The name of a branch containing the revision.


key: revisionTag

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


key: asOfTimeUtc

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.


key: mappedTo

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


key: properties

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


key: webRequest

description: Describes an HTTP request.


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


key: protocol

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


key: version

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


key: target

description: The target of the request.


key: method

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


key: headers

description: The request headers.


key: parameters

description: The request parameters.


key: body

description: The body of the request.


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


key: webResponse

description: Describes the response to an HTTP request.


key: index

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'.


key: statusCode

description: The response status code. Example: 451.


key: reasonPhrase

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


description: The response headers.


description: The body of the response.


key: noResponseReceived

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


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


key: $schema

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


description: The SARIF format version of this log file.


key: runs

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


key: inlineExternalProperties

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


key: properties

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


description: Prometheus rules file

required: record expr

required: alert expr


description: A string which is template-expanded before usage.


key: record

description: The name of the time series to output to. Must be a valid metric name.


key: expr

description: The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and the result recorded as a new set of time series with the metric name as given by 'record'.


key: labels

description: Labels to add or overwrite before storing the result.


key: alert

description: The name of the alert. Must be a valid metric name.


description: The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.


key: for

description: Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending.


description: Labels to add or overwrite for each alert.


key: annotations

description: Annotations to add to each alert.


key: name

description: The name of the group. Must be unique within a file.


key: interval

description: How often rules in the group are evaluated.


key: limit

description: Limit the number of alerts an alerting rule and series a recording rule can produce. 0 is no limit.


key: commonTypes

description: Some of the reusable base types

enum: NANOS MICROS MILLIS SECONDS MINUTES HOURS HALF_DAYS DAYS WEEKS MONTHS YEARS DECADES CENTURIES MILLENNIA ERAS FOREVER

enum: GET POST


key: charSet

description: Standard character sets.


key: chronoUnit

description: The chrono unit we want to use.


key: httpHeaders

description: HTTP header map.


key: httpMethod

description: Supported HTTP methods.


key: jsonPath

description: A JSON Path selecting one or more nodes of the parsed JSON document.


description: A single JSON key name


key: functionTypes

description: Definition of known function types

const: absoluteValue

required: name scale

const: add

required: name operand scale

const: changeCase

required: name to

const: cloneKey

required: from name to

const: divide

const: dividend

const: epochMillisDateAdd

required: amount name unit

const: httpResource

const: httpResourceByUri

const: jsonParse

const: multiply

const: regex

required: name pattern replacement

const: replace

required: find name replace

const: roundDecimal

const: stringDateAdd

required: amount formatter name unit

const: subtract

const: subtractFrom

enum: changeCase httpResourceByUri jsonParse regex replace stringDateAdd

enum: changeCase httpResourceByUri regex replace stringDateAdd

enum: absoluteValue add divide dividend epochMillisDateAdd multiply roundDecimal subtract subtractFrom

enum: absoluteValue add changeCase cloneKey divide dividend epochMillisDateAdd httpResource httpResourceByUri jsonParse multiply regex replace roundDecimal stringDateAdd subtract subtractFrom


key: functionAbsoluteValue

description: Absolute value function

const: absoluteValue


description: The name of the component.


key: scale

description: The number of digits we want to keep right of the decimal point.


key: functionAdd

description: Decimal add function

const: add


description: The name of the component.


key: operand

description: Second operand of the calculation.


key: functionChangeCase

description: Change case

const: changeCase


description: The name of the component.


key: to

description: Defines what is the desired case change operation we want to do.


key: functionCloneKey

description: Clone key function

const: cloneKey


key: name

description: The name of the component.


key: from

description: The name of the key we need to duplicate.


description: The name of the destination key.


key: functionDivide

description: Decimal divide function

const: divide


description: The name of the component.


key: functionDividend

description: Decimal dividend function

const: dividend


description: The name of the component.


description: First operand of the calculation.


key: functionEpochMillisDateAdd

description: Epoch millis date add function

const: epochMillisDateAdd


description: The name of the component.


key: amount

description: The amount of time units we need to add to the date time.


key: unit

description: The time unit we want to use to interpret the amount.


key: functionHttpResource

description: HTTP resource content map function

const: httpResource


description: The name of the component.


key: uriFunction

description: The function that is calculating the request URI based on the input map.


key: methodFunction

description: The function that is calculating the request method based on the input map.


key: headerFunction

description: The function that is calculating the request headers based on the input map.


key: uri

description: The default request URI as a fallback.


key: httpMethod

description: The default request method as a fallback. Defaults to GET.


key: httpHeaders

description: The default request headers as a fallback.


key: charset

description: The charset used to read the response. Defaults to UTF-8.


key: functionHttpResourceByUri

description: HTTP resource by URI function

const: httpResourceByUri


description: The name of the component.


key: functionJsonParse

description: JSON parse function

const: jsonParse


key: name

description: The name of the component.


key: functionMultiply

description: Decimal multiply function

const: multiply


description: The name of the component.


key: operand

description: Second operand of the calculation.


key: scale


key: functionRegex

description: RegEx replace function

const: regex


description: The name of the component.


key: pattern

description: A regex pattern that will be matched against the input, capturing certain named groups for later use.


key: replacement

description: Defines how the captured groups should be used to piece together the output value using EL-like syntax.


key: functionReplace

description: Literal replace function

const: replace


description: The name of the component.


key: find

description: A literal we need to find in the input String.


key: replace

description: The replacement we need to use.


key: functionRoundDecimal

description: Round decimal function

const: roundDecimal


description: The name of the component.


key: functionStringDateAdd

description: String date add function

const: stringDateAdd


description: The name of the component.


key: formatter

description: The format String we need to use for date time parsing. [See](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html)


key: amount


key: unit


key: functionSubtract

description: Decimal subtract function

const: subtract


description: The name of the component.


description: Second operand of the calculation.


key: functionSubtractFrom

description: Decimal subtract from function

const: subtractFrom


key: name

description: The name of the component.


description: First operand of the calculation.


key: predicateTypes

description: Definition of known predicate types

const: allMatch

required: from name

const: anyMatch

const: anyString

const: containsKey

required: key name

const: evalOn

required: childPath name predicate

const: isNull

const: noneMatch

const: notNull

required: name pattern

const: SpEL

required: expression name

enum: SpEL allMatch anyMatch anyString isNull noneMatch notNull regex

enum: SpEL allMatch anyMatch containsKey evalOn isNull noneMatch notNull

enum: SpEL allMatch anyMatch anyString containsKey evalOn isNull noneMatch notNull regex


key: predicateAllMatch

description: All Match predicate


description: The name of the component.


key: predicateAnyMatch

description: Any Match predicate


description: The name of the component.


key: predicateAnyString

description: Any String predicate


description: The name of the component.


key: predicateContainsKey

description: Contains key predicate


description: The name of the component.


key: key

description: The name of the key we want to check.


key: predicateEvalOn

description: Eval on predicate


description: The name of the component.


key: childPath

description: The desired navigation we want to perform relative to the Map/Object we operate on.


key: predicate

description: The Predicate we need to evaluate after the navigation is done.


key: predicateIsNull

description: Is null predicate


description: The name of the component.


key: predicateNoneMatch

description: None Match predicate


description: The name of the component.


key: predicateNotNull

description: Not null predicate


description: The name of the component.


key: predicateRegex

description: RegEx predicate


description: The name of the component.


key: pattern

description: The regular expression we want to match.


key: predicateSpEL

description: SpEL predicate


description: The name of the component.


key: expression

description: The SpEL expression we want to match.


key: supplierTypes

description: Definition of known supplier types

const: converting

required: converter name stringSource

const: epochMillisRelativeDate

const: file

required: name path

const: httpResource

required: name uri

const: jsonSchema

required: name source

const: relativeStringDate

const: schemaStore

required: name schemaName

const: staticBoolean

required: name value

const: staticDecimal

const: staticInteger

const: staticJson

const: staticString

enum: file httpResource relativeStringDate schemaStore staticString

enum: converting epochMillisRelativeDate file httpResource jsonSchema relativeStringDate schemaStore staticBoolean staticDecimal staticInteger staticJson staticString


key: supplierConverting

description: Converting supplier


key: name

description: The name of the component.


key: stringSource

description: The supplier of the raw String data we will use as input.


key: converter

description: The function that will convert the string data.


key: supplierEpochMillisRelativeDate

description: Epoch Millis Relative Date supplier


description: The name of the component.


key: amount

description: The amount of time units we need to add to the current date time.


key: unit

description: The time unit we want to use to interpret the amount.


key: relativeTo

description: The value we want to be relative to (in case it is not the current time).


key: supplierFile

description: File content supplier


description: The name of the component.


key: path

description: The path of the file we want to use as input.


key: charset

description: The charset used for reading the contents of the file. Defaults to UTF-8.


key: supplierHttpResource

description: HTTP resource content supplier


description: The name of the component.


key: uri

description: The URI we want to send the request to.


key: httpMethod

description: The HTTP request method we want to use. Defaults to GET.


key: httpHeaders

description: HTTP headers we want to send with our request.


description: The charset used for reading the contents of the response. Defaults to UTF-8.


key: supplierJsonSchema

description: JSON schema supplier


description: The name of the component.


key: source

description: The supplier of the String of the JSON Schema which we will use as input.


key: supplierRelativeStringDate

description: Relative String Date supplier


key: name

description: The name of the component.


key: formatter


key: supplierSchemaStore

description: SchemaStore schema supplier


description: The name of the component.


key: schemaName

description: The name of the JSON schema as found in the SchemaStore.org catalog.


key: supplierStaticBoolean

description: Static Boolean supplier


description: The name of the component.


key: value

description: The static value that must be returned each time the supplier is called.


key: supplierStaticDecimal

description: Static BigDecimal supplier


description: The name of the component.


key: supplierStaticInteger

description: Static BigInteger supplier


description: The name of the component.


key: supplierStaticJson

description: Static JSON supplier


description: The name of the component.


description: The static JSON value we want to supply every time our supplier is called.


key: supplierStaticString

description: Static String supplier


description: The name of the component.


key: ruleTypes

description: Definition of known rule types

const: add

required: key value

required: name params path

const: calculate

const: copy

required: key to

const: delete

const: deleteFrom

const: rename

required: newKey oldKey

const: replace

const: replaceMap

const: validate

enum: ABORT SKIP_REST CONTINUE

required: transformation violation

required: onFailure schema

enum: add calculate copy delete deleteFrom rename replace replaceMap validate


key: ruleAdd

description: Add


description: The name of the component.


key: params

description: Additional parameters of the rule.


key: key

description: The supplier that will define the key of the new node.


description: The supplier that will define the value assigned to the new node identified by the key.


key: ruleCalculate

description: Calculate


description: The name of the component.


description: Additional parameters of the rule.


key: predicate

description: The predicate that will determine whether we should apply the function.


key: numberFunction

description: The function that will tell the rule what kind of calculation needs to be done.


key: ruleCopy

description: Copy


key: name

description: The name of the component.


description: Additional parameters of the rule.


description: The supplier that will define the key we want to copy.


description: The destination path where this rule will attempt to create the copied node.


key: ruleDelete

description: Delete


description: The name of the component.


key: ruleDeleteFrom

description: Delete from


description: The name of the component.


description: Determines whether any deletion should be performed for the matching node


key: keepKey

description: The predicate that will be used to test whether a key should be kept, keeping only the matching keys.


key: deleteKey

description: The predicate that will be used to test whether a key should be deleted, deleting all the matching keys.


key: keepValue


key: deleteValue

description: The predicate that will be used to test whether an entry should be deleted, deleting all of them with matching values.


key: ruleRename

description: Rename


description: The name of the component.


description: Additional parameters of the rule.


key: oldKey

description: Provides the name of the key we want to rename under the node matching the `path` parameter at the time of evaluation.


key: newKey

description: Provides the new name we want to use after the child node was renamed.


key: ruleReplace

description: Replace


description: The name of the component.


key: params

description: Additional parameters of the rule.


description: Adds an opportunity to filter by value before we apply the replace `stringFunction`.


key: stringFunction

description: Defines how the existing value needs to change during the operation.


key: ruleReplaceMap

description: Replace map


description: The name of the component.


key: predicate

description: The predicate that will determine whether we need to run the rule on the matching path.


key: mapFunction

description: The function that defines the transformation which needs to be done on the selected map/object.


key: ruleValidate

description: JSON Schema validate


key: name

description: The name of the component.


key: path

description: Must be the root JSON Path as the validator cannot work on sub-schema.


description: Additional parameters of the rule.


key: schema

description: The supplier providing the schema we will use for validation.


key: transformation

description: Defines how the transformation should handle a validation failure.


key: violation

description: Defines how the rule should document/report the violations.


description: The name of the rule.


description: The optional parameter map to allow configuration of the selected rule.


key: actionName

description: The name of the action (rule list) to allow selecting it when we want to start transformation.


key: rules

description: The array of rules representing the sequentially triggered steps of the transformation action.


key: actions

description: The array of transformation action we will be able to select from at startup.


key: paths

description: A string or an array of paths to watch. Supports globbing.

default: ./src


key: root

description: The root path from which all other paths will be resolved.


key: ignored

description: Paths, globs or regular expressions to ignore.


key: exec

description: The command to execute on file change.

examples:
babel-node src/server
ts-node src/server


key: port

description: The port on which the server should run. This is passed to your application as `process.env.PORT` which should be used by you.


key: logLevel

description: The level of logging. 0 - fatal, 1 - error, 2 - warning, 3 - info, 4 - debug