chutzpah.json

description: The options to configure the chosen browser engine for Chutzpah to use.

description: The path to the chrome/chromium executable on the machine

description: Server settings let you enable to configure Chutzpah web server mode.

description: Determines if the web server mode is enabled.

description: The default port to use. If this port is taken Chutzpah will try incrementing until it finds an available one.

description: The root path of the server. All file paths are relative to this and should be in a directory below or equal to this. Defaults to drive root.

description: The way the template is injected into the HTML page.

enum: Raw Script

default: Raw

description: If in script mode what Id to place on the script tag.

description: If in script mode what Type to place on script tag

description: The path to either a file or a folder. If given a folder, it will be scanned recursively. This path can be relative to the location of the chutzpah.json file.

description: This is an optional array of include glob patterns. Only files matching the Include pattern will be added.

description: This is an optional array of exclude glob patterns.  Only files not matching the Exclude patterns will be added.

description: This determines if the reference should be injected into the test harness. When referencing files like .d.ts or files that you plan to load using require.js you should set this to false. Defaults to true.

description: Indicated that this references should be placed directly after the test framework files in the test harness. This ensures that this file is injected into the test harness before almost all other files. Defaults to false.

$ref: #/definitions/templateOptions

description: The source file/directory

description: The file/directory that source file/directory is mapped to. Specifying a file OutputPath and a directory for SourcePath indicated the files are being concatenated into one large file

description: The type (file or folder) that the output path refers to. If not specified Chutzpah will try to take a best guess by assuming it is a file if it has a .js extension

enum: File Folder

default: Folder

description: The name of the transform to execute

description: The file for the transform to save its output to.

description: This setting lets you describe in the Chutzpah.json file how to execute a command which can compile your source files to .js files. You tell Chutzpah what to execute and some information about what your executable does (like where to find the generated .js files). Then after running the executable Chutzpah can associate each source file with each output file to still give the nice behavior of mapping tests back to their original files.

description: The extensions of the files which are getting compiled (e.g. .ts).

description: The extensions of files which take part in compile but have no build output. This is used for cases like TypeScript declaration files which share a .ts extension. They have .d.ts extension and are part of compilation but have no output. You must tell Chutzpah about these if you want the SkipIfUnchanged setting to work. Otherwise Chutzpah will think these are missing output.

description: The collection of path mapping from source directory/file to output directory/file.

$ref: #/definitions/compilePathMap

description: This is the working directory of the process which executes the command.

description: The path to an executable which Chutzpah executes to perform the batch compilation. Chutzpah will try to resolve the path relative to the settings directory. But if can't find the file there you must give it a full path.

description: The arguments to pass to the command.

description: How long to wait for compile to finish in milliseconds?

description: Skips the execution if all files Chutzpah knows about are older than all of the output files. This is defaulted to true but if you hit issues since it is possible Chutzpah might not know about all the files your compilation is using then you can turn this off. Ideally you should tell Chutzpah about these files using the references and tests settings since this setting helps Chutzpah not need to even invoke the executable if it figures out it's not needed.

description: Determines how this compile setting is used. By default it is in Executable mode where it will require you provide an executable which Chutzpah will run if it sees it finds missing .js for input file. If you set this to External then Chutzpah will ignore the Executable, Arguments settings and assume you have some external process which is compiling. In this case Chutzpah will use the SourceDirectory and OutDirectory options to try to find your .js files for the input files. If it can't find them it will trace an error but still attempt to proceed.

enum: Executable External

default: External

description: Configures whether .map files should be loaded (if available) to convert under-test JS line numbers to those of their original source files.

description: Should Chutzpah ignore files it expects to find compiled. If set to true Chutzpah will log an error otherwise it will throw

description: Determines what testing framework to use. This will override the other detection methods.

enum: qunit jasmine mocha

description: Tells Chutzpah if it should use a different version of on of the test frameworks than the default one. Currently, the only framework this works for is Jasmine. As of the 3.1.0 release Chutzpah default to Jasmine 2.0 but if you want to use the 1.0 line for Jasmine still pass '1' for FrameworkVersion.

description: The references setting allows you to specify which files/folders to use/scan to find references. This is useful since it replaces the need to the ///<reference comments.

$ref: #/definitions/referenceSettings

$ref: #/definitions/testSettings

description: The browser engine to use to run the tests. Default is Phantom but JSDOM and Chrome are available. If you choose Chrome you must have an instance of Chrome or Chromium on the machine that Chutzpah can find.

enum: Phantom JSDom Chrome

$ref: #/definitions/engineOptions

$ref: #/definitions/serverSettings

description: List of transformers to run after testing to generate output files

$ref: #/definitions/transformConfig

$ref: #/definitions/compileSettings

description: The time to wait for tests in a file to finish in milliseconds.

description: Determines where to place the generated html test harness files. The default mode is TestFileAdjacent which means the harness is placed in the same directory as the test file. SettingsFileAdjacent means it is placed in the same directory as the chutzpah.json file. Custom mode lets you specify a custom path to the directory.

enum: Normal AMD

description: When TestHarnessLocationMode is set to Custom this is either the relative or absolute path to the directory where to place the test harness.

description: This property determines what directory a rooted reference path refers to.

enum: DriveRoot SettingsFileDirectory

default: DriveRoot

description: The timeout in milliseconds for how long to wait to instrument each file for code coverage. Defaults to 5000ms.

description: If Always, forces code coverage to run always. If Manual/null/not set, allows code coverage to run if invoked using test adapter, command line or context menu options (default). If Never, forces code coverage to never run.

enum: Manual Always Never

description: The percentage of lines needing to be covered to show the coverage output as success or failure. By default this is 60.

description: The collection code coverage file patterns to include in coverage. These are in glob format. If you specify none all files are included.

description: The collection code coverage file patterns to exclude in coverage. These are in glob format. If you specify none no files are excluded.

description: The CustomTestHarnessPath setting allows you to override the default template Chutzpah uses for the HTML test harness. This is an advanced feature which should only be used as a last resort.

description: The name of the Mocha interface to use. Overrides the default detection mechanism.

enum: bdd tdd qunit

description: Set the baseurl for Chutzpah to use when generating the test harness. Defaults to the test harness directory if not set.

description: Sets the root directory for your AMD paths. This is only needed if your baseUrl is a different location than your source directory. This is common if you are compiling from another language to JavaScript and copying those compiled files to a different folder. For example if you have all your .ts files in /src and you compile them to a /out directory then your AMDBaseUrl is /out and AMDAppDirectory is /src. Defaults to the test harness directory if not set.

description: The user agent to use when making web requests

description: When Chutzpah reports test results it also tells you what line they are on. The way this is accomplished is by having a regex for each testing framework which describes where to find the names of your tests.

format: regex

description: Determines if batch all test files for this chutzpah.json file should be batched into one test harness. This will often make your test run much faster.

description: Determines if this settings file should inherit and merge with the settings of its parent settings file. The parent is found by recursively walking up the tree.

description: Suppress errors that are reported when a script request to load a url (e.g. xhr/script/image) fails.

description: Logs tracing information to a log file.

description: The path to write the trace file to. Defaults tp %temp%/chutzpah.log.

description: Max degree of parallelism for running tests. Defaults to number of CPUs

description: The dictionary of browser name (keys) to corresponding browser arguments (values), i.e.; { 'chrome': '--allow-file-access-from-files' }.

title: JSON schema for Chutzpah test runner settings files


repository-configuration-schema.json

title: ORT repository configuration

description: The OSS-Review-Toolkit (ORT) provides a possibility to configure exclusions, resolutions and more in a file called `.ort.yml`. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-ort-yml.md.

type: object

description: Defines which parts of a repository should be excluded.

type: array

description: A glob to match the path of the project definition file, relative to the root of the repository.

type: string

$ref: #/definitions/pathExcludeReason

required: pattern reason

$ref: #/definitions/scopeExcludeReason

description: Curations for artifacts in a repository.

$ref: #/definitions/licenseFindingCurations

description: A configuration for a specific package and provenance.

description: A configuration to select a license from a multi-licensed package.

type: integer string

type: integer

required: path concluded_license reason


foundryvtt-module-manifest.json

description: A stable URL that describes the latest release version of your manifest file. This URL is used for automatic module installation in the Foundry VTT setup screen. This manifest URL is consulted during the module update check to see whether a new version is available for download. It is important that this address remain stable, otherwise updates will not be detected.

description: The library field is a boolean that indicates whether the package is a library intended for other packages to depend on and consume. This field should be true if your package does not present any user-facing features, but rather provides functionality for other packages to utilize and rely upon. Packages with this field set to true may be hidden from third party package lists to avoid confusing users. When omitted the default value of this field is false.

type: boolean

description: (undocumented)

title: JSON schema for Foundry VTT module manifest files - module.json


vercel.json

description: Ignored. Can be set to get completions, validations and documentation in some editors.

description: Aliases that will get assigned when the deployment is `READY` and the target is `production`. The client needs to make a `GET` request to its API to ensure the assignment

description: An object containing another object with information to be passed to the Build Process

description: An object containing the deployment's environment variable names and values to be passed to Builds. Secrets can be referenced by prefixing the value with `@`

description: A list of build descriptions whose src references valid source files.

description: Optionally, an object including arbitrary metadata to be passed to the Builder

description: A glob expression or pathname. If more than one file is resolved, one build will be created per matched file. It can include `*` and `**`

description: An npm module to be installed by the build process. It can include a semver compatible version (e.g.: `@org/proj@1`)

description: When set to `true`, all HTML files and Serverless Functions will have their extension removed. When visiting a path that ends with the extension, a 308 response will redirect the client to the extensionless path.

description: An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@`

description: An object describing custom options for your Serverless Functions. Each key must be glob pattern that matches the paths of the Serverless Functions you would like to customize (like `api/*.js` or `api/test.js`).

description: A glob pattern to match files that should be excluded from your Serverless Function. If you’re using a Community Runtime, the behavior might vary.

description: A glob pattern to match files that should be included in your Serverless Function. If you’re using a Community Runtime, the behavior might vary.

description: An integer defining how long your Serverless Function should be allowed to run on every request in seconds (between 1 and the maximum limit of your plan).

type: number

description: An integer defining the memory your Serverless Function should be provided with (between 128 and 3008).

description: The npm package name of a Runtime, including its version

description: Specifies the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is `true` by default.

description: When set to `false`, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.

description: When set to `false`, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.

description: When set to false, Vercel for GitHub will not apply the alias upon merge.

description: When set to `true`, Vercel for GitHub will stop commenting on pull requests and commits.

description: A list of header definitions.

required: source headers

description: An array of key/value pairs representing each response header.

required: key value

description: An array of requirements that are needed to match

required: type value

description: The type of request element to check

description: A regular expression used to match the value. Named groups can be used in the destination

required: type key

description: The type of request element to check

enum: header cookie query

description: The name of the element contained in the particular type

description: The type of request element to check

description: The type of request element to check

enum: inline attachment

enum: image/avif image/webp image/jpeg image/png

enum: http https

description: A name for the deployment

description: Whether a deployment's source and logs are available publicly

title: Redirects

description: A list of redirect definitions.

required: source destination

description: A pattern that matches each incoming pathname (excluding querystring).

description: A location destination defined as an absolute pathname or external URL.

description: A boolean to toggle between permanent and temporary redirect. When `true`, the status code is `308`. When `false` the status code is `307`.

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: An array of the regions the deployment's Serverless Functions should be deployed to

description: A list of rewrite definitions.

description: An absolute pathname to an existing resource or an external URL.

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: A list of routes objects used to rewrite paths to point towards other internal or external paths

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

enum: error filesystem hit miss resource rewrite

description: This property determines the scope (user or team) under which the project will be deployed by Vercel CLI.

description: When `false`, visiting a path that ends with a forward slash will respond with a `308` status code and redirect to the path without the trailing slash.

description: The build command for this project. When `null` is used this value will be automatically detected

description: The dev command for this project. When `null` is used this value will be automatically detected

description: The framework that is being used for this project. When `null` is used no framework is selected

description: The install command for this project. When `null` is used this value will be automatically detected

description: The output directory of the project. When `null` is used this value will be automatically detected

description: An array of cron jobs that should be created for production Deployments.


workflows.json

description: A subworkflow.

description: The name of the parameter variable.

description: An array of objects with a single step.

$ref: #/definitions/stepArray

description: An array of objects with a single step.

description: An object with a single step.

description: A single workflow step.

$ref: #/definitions/step

description: A single workflow step.

$ref: #/definitions/assign

$ref: #/definitions/call

$ref: #/definitions/args

$ref: #/definitions/result

$ref: #/definitions/next

$ref: #/definitions/switch

$ref: #/definitions/for

$ref: #/definitions/parallel

$ref: #/definitions/raise

$ref: #/definitions/try

$ref: #/definitions/retry

$ref: #/definitions/except

$ref: #/definitions/return

description: A list of variable assignment maps.

description: A single variable assignment.

description: Run a function and return a result.

description: Standard library module for HTTP/S request support.

description: Standard library module for common system interface.

description: Standard library module for event support.

description: A subworkflow.

description: A Google Cloud API connector.

description: Pass arguments and their values when calling a function that accepts parameters.

format: uri

description: An expression that results to a URL where the request is sent. Required if using call type http.request.

description: The type of HTTP request method to use. Required if using call type http.request.

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH

description: Header fields to supply input to the API.

description: Body fields to supply input to the API.

description: Query fields to supply input to the API.

description: Required if the API being called requires authentication.

description: The type of authentication.

description: Specify token scope to limit an application's access to a user's account.

description: List of scope strings.

description: Scope string.

$ref: #/definitions/scopes

description: Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.

description: Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.

description: Connector-specific parameters.

description: Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.

description: Polling policy.

description: Time in seconds. Only applies to long-running operation calls.

description: If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds

description: OAuth2 scopes to pass to the Google API.

description: Assign the result from a call to this variable.

description: Define what step Workflows should execute next.

description: The step name.

description: Stop a workflow's execution without returning a value.

const: end

description: Terminate the current iteration of a for loop and continue with the next iteration.

const: continue

description: Terminate iteration of a for loop.

const: break

description: Stop a workflow's execution and return a value, variable, or expression.

description: Iterates over a sequence of numbers or through a collection of data, such as a list or map.

required: value steps

description: A loop variable name. Contains the value of the currently iterated element.

description: An index variable name. Contains the value to the current offset of the iteration.

description: An expression that evaluates into a list or a list definition. Required, if not using 'range'.

description: A list.

description: An expression that evaluates into a list.

description: A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.

description: Array specifying the beginning and end of the range, both inclusive.

description: The expressions must evaluate into incrementable values; that is, integer or double. Make sure that you do not use multiple expressions inside a list like this: [${rangeStart}, ${rangeEnd}]).

description: Each iteration the steps will be executed.

description: Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.

description: The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.

const: continueAll

description: A list of writable variables with parent scope that allow assignments within the 'parallel' step.

description: The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.

description: Branches that can run concurrently. Required, if not using 'for'.

$ref: #/definitions/branches

description: A loop where iterations can run concurrently. Required, if not using 'branches'.

description: Execute parallel branches concurrently and the steps in each branch sequentially.

description: A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.

$ref: #/definitions/condition

description: Define conditional expressions for a switch block.

description: An expression to switch on.

description: Raise an exception.

description: Error message string.

description: Error message map.

description: Error code.

description: Error message string.

description: A try/except structure for error handling.

description: A step.

description: A list of steps.

description: The name of a map variable that contains the error message.

description: A list of steps.

description: Define a retry policy to retry steps that return a specific error code.

description: Retry block. Optional, if using a default retry policy.

description: Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.

description: Maximum number of times a step will be retried, not counting the initial step execution attempt.

description: Block that controls how retries occur.

description: Delay in seconds between the initial failure and the first retry.

description: Maximum delay in seconds between retries.

description: Multiplier applied to the previous delay to calculate the delay for the subsequent retry.

description: Default retry policy. Optional, if using retry block. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}.

description: List of scope strings.

description: Scope string.

description: Space and comma-separated strings

description: Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.

description: The main workflow.

description: The name of the parameter variable.

description: An array of objects with a single step.

description: A list of steps.

title: Google Cloud Workflows


openweather.current.json

description: API responses from the OpenWeather Current Weather Data API from https://openweathermap.org/current

required: lat lon

required: id main description icon

required: speed deg

required: type id message country sunrise sunset

required: coord weather base main visibility wind clouds dt sys timezone id name cod

title: OpenWeather Current Weather Data API


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

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

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

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

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

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

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

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

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

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

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

$ref: #/definitions/propertyBag

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

description: A short description of the artifact.

$ref: #/definitions/message

description: The location of the artifact.

$ref: #/definitions/artifactLocation

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

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

description: The length of the artifact in bytes.

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

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

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

description: The contents of the artifact.

$ref: #/definitions/artifactContent

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

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

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

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

format: date-time

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

description: A change to a single artifact.

description: The location of the artifact to change.

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

$ref: #/definitions/replacement

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

required: artifactLocation replacements

description: Represents the contents of an artifact.

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

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

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

$ref: #/definitions/multiformatMessageString

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

description: Specifies the location of an artifact.

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

format: uri-reference

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

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

description: A short description of the artifact location.

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

description: An artifact relevant to a result.

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

description: The location of the attachment.

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

$ref: #/definitions/region

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

$ref: #/definitions/rectangle

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

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

description: A message relevant to the code flow.

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

$ref: #/definitions/threadFlow

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

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

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

$ref: #/definitions/reportingConfiguration

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

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

required: configuration descriptor

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

description: A tool object that describes the converter.

$ref: #/definitions/tool

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

$ref: #/definitions/invocation

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

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

description: Represents a directed edge in a graph.

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

description: A short description of the edge.

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

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

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

required: id sourceNodeId targetNodeId

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

description: Identifies the edge being traversed.

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

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

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

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

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

description: A message that describes the exception.

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

$ref: #/definitions/stack

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

$ref: #/definitions/exception

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

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

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

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

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

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

$ref: #/definitions/conversion

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

$ref: #/definitions/graph

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

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

$ref: #/definitions/artifact

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

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

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

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

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

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

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

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

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

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

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

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

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

description: The location of the external property file.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: A description of the graph.

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

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

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

description: Represents a path through a graph.

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

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

description: A description of this graph traversal.

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

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

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

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

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

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

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

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

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

description: The process exit code.

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

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

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

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

description: The reason for the process exit.

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

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

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

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

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

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

description: The working directory for the analysis tool run.

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

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

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

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

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

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

description: A location within a programming artifact.

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

description: Identifies the artifact and region.

description: The logical locations associated with the result.

description: A message relevant to the location.

description: A set of regions relevant to the location.

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

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

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

description: A reference to the related location.

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

description: A description of the location relationship.

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

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

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

description: The index within the logical locations array.

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

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

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

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

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

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

description: A plain text message string.

description: A Markdown message string.

description: The identifier for this message.

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

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

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

description: A plain text message string or format string.

description: A Markdown message string or format string.

description: Represents a node in a graph.

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

description: A short description of the node.

description: A code location associated with the node.

description: Array of child nodes.

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

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

description: The locations relevant to this notification.

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

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

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

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

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

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

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

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

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

description: The address of the location.

description: The location of the artifact.

description: Specifies a portion of the artifact.

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

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

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

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

description: An area within an image.

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

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

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

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

description: A message relevant to the rectangle.

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

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

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

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

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

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

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

description: The length of the region in characters.

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

description: The length of the region in bytes.

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

description: A message relevant to the region.

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

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

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

description: The region of the artifact to delete.

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

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

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

description: A stable, opaque identifier for the report.

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

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

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

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

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

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

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

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

description: Default reporting configuration information.

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

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

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

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

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

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

description: Specifies the failure level for the report.

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

description: Contains configuration information specific to a report.

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

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

description: The id of the descriptor.

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

description: A guid that uniquely identifies the descriptor.

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

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

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

description: A reference to the related reporting descriptor.

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

description: A description of the reporting descriptor relationship.

description: A result produced by an analysis tool.

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

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

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

description: A value that categorizes results by evaluation state.

enum: notApplicable pass fail review open informational

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

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

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

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

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

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

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

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

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

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

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

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

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

description: A set of locations relevant to this result.

description: A set of suppressions relevant to this result.

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

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

description: A set of artifacts relevant to the result.

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

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

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

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

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

description: A web request associated with this result.

description: A web response associated with this result.

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

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

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

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

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

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

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

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

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

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

description: Describes the invocation of the analysis tool.

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

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

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

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

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

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

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

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

description: Automation details that describe this run.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Defines locations of special significance to SARIF consumers.

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

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

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

description: A message relevant to this call stack.

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

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

description: A function call within a stack trace.

description: The location to which this stack frame refers.

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

description: The thread identifier of the stack frame.

description: The parameters of the call that is executing.

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

description: A suppression that is relevant to a result.

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

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

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

description: A string representing the justification for the suppression.

description: Identifies the location associated with the suppression.

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

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

description: A message relevant to the thread flow.

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

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

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

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

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

description: The index within the run threadFlowLocations array.

description: The code location.

description: The call stack leading to this location.

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

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

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

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

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

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

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

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

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

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

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

description: The analysis tool that was run.

description: The analysis tool that was run.

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

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

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

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

description: The name of the tool component.

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

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

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

description: A brief description of the tool component.

description: A comprehensive description of the tool component.

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

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

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

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

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

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

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

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

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

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

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

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

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

description: The kinds of data contained in this object.

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

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

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

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

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

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

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

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

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

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

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

description: Provides additional metadata related to translation.

description: The name associated with the translation metadata.

description: The full name associated with the translation metadata.

description: A brief description of the translation metadata.

description: A comprehensive description of the translation metadata.

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

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

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

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

description: The absolute URI of the repository.

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

description: The name of a branch containing the revision.

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

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

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

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

description: A web request object.

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

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

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

description: The target of the request.

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

description: The request headers.

description: The request parameters.

description: The body of the request.

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

description: A web response object.

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

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

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

description: The response status code. Example: 451.

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

description: The response headers.

description: The body of the response.

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

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

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

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

description: The SARIF format version of this log file.

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

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

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

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


schema.json

title: Angular CLI Configuration

$ref: #/definitions/fileVersion

$ref: #/definitions/cliOptions

$ref: #/definitions/schematicOptions

description: Path where new projects will be created.

description: Default project name used in commands.

$ref: #/definitions/project

description: The default schematics collection to use.

description: Specify which package manager tool to use.

enum: npm cnpm yarn pnpm

description: Control CLI specific console warnings

description: Show a warning when the global version is newer than the local one.

type: boolean string

description: Share anonymous usage data with the Angular Team at Google.

description: Specifies the change detection strategy.

enum: Default OnPush

default: Default

description: Specifies if the style will contain `:host { display: block; }`.

description: Specifies if the component is an entry component of declaring module.

description: Specifies if declaring module exports the component.

description: Flag to indicate if a directory is created.

description: Specifies if the style will be in the ts file.

description: Specifies if the template will be in the ts file.

description: Allows specification of the declaring module.

format: html-selector

description: The prefix to apply to generated selectors.

description: The selector to use for the component.

description: Flag to skip the module import.

description: The file extension or preprocessor to use for style files.

default: css

enum: css scss sass less styl

description: Specifies the view encapsulation strategy.

enum: Emulated Native None ShadowDom

description: When true, does not create test files.

description: Specifies if declaring module exports the directive.

default: app

description: The selector to use for the directive.

description: Flag to skip the module import.

description: When true, does not create test files.

description: Generates a routing module.

enum: Child Root

description: The scope for the generated routing.

default: Child

description: Flag to control whether the CommonModule is imported.

description: When true, does not create test files.

description: When true, does not create test files.

description: Allows for skipping the module import.

description: Specifies if declaring module exports the pipe.

description: When true, does not create test files.

description: File format version

description: Root of the project files.

description: The root of the source files, assets and index.html file structure.

description: Project type.

enum: application library

required: root projectType

required: targets architect

description: Project i18n options

description: Specifies the source locale of the application.

default: en-US

$comment: IETF BCP 47 language tag (simplified)

description: Localization options to use for the source locale

description: Specifies the locale code of the source locale

description: HTML base HREF to use for the locale (defaults to the locale code)

description: Localization file to use for i18n

description: Localization files to use for i18n

description: Localization options to use for the locale

description: Localization file to use for i18n

description: Localization files to use for i18n

description: The builder used for this package.

description: A map of alternative target options.

description: App Shell target options for Architect.

description: Target to build.

description: Server target to use for rendering the app shell.

description: Script that exports the Server AppModule to render. This should be the main JavaScript outputted by the server target. By default we will resolve the outputPath of the serverTarget and find a bundle named 'main' in it (whether or not there's a hash tag).

description: The route to render.

description: The input path for the index.html file. By default uses the output index.html of the browser target.

description: The output path of the index.html file. By default will overwrite the input file.

title: Webpack browser schema for Architect.

description: Browser target options

description: List of static application assets.

description: The name of the main entry-point file.

description: The name of the polyfills file.

description: The name of the TypeScript configuration file.

description: Global scripts to be included in the build.

description: Global styles to be included in the build.

description: Options to pass to style preprocessors.

description: Paths to include. Paths will be resolved to project root.

description: Enables optimization of the build output.

description: Enables optimization of the scripts output.

description: Enables optimization of the styles output.

description: Replace compilation source files with other compilation source files in the build.

description: Path where output will be placed.

description: The path where style resources will be placed, relative to outputPath.

description: Build using Ahead of Time compilation.

description: Output sourcemaps.

description: Output sourcemaps for all scripts.

description: Output sourcemaps for all styles.

description: Output sourcemaps used for error reporting tools.

description: Resolve vendor packages sourcemaps.

description: Use a separate bundle containing only vendor libraries.

description: Use a separate bundle containing code used across multiple bundles.

description: Base url for the application being built.

description: URL where files will be deployed.

description: Adds more details to output logging.

description: Log progress to the console while building.

description: Localization file to use for i18n.

description: Format of the localization file specified with --i18n-file.

description: Locale to use for i18n.

description: Extract css from global styles onto css files instead of js ones.

description: Run build when files change.

description: Define the output filename cache-busting hashing mode.

description: Enable and define the file watching poll time period in milliseconds.

description: Delete the output path before building.

description: Do not use the real path when resolving modules.

description: Extract all licenses in a separate file, in the case of production builds only.

description: Show circular dependency warnings on builds.

description: Enables @angular-devkit/build-optimizer optimizations when using the 'aot' option.

description: Use file name for lazy loaded chunks.

description: Enables the use of subresource integrity validation.

description: Generates a service worker config for production builds.

description: Path to ngsw-config.json.

description: Configures the generation of the application's HTML index.

description: The path of a file to use for the application's HTML index. The filename of the specified path will be used for the generated file and will be created in the root of the application's configured output path.

description: The path of a file to use for the application's generated HTML index.

description: The output path of the application's generated HTML index file. The full provided path will be used and will be considered relative to the application's configured output path.

description: Generates a 'stats.json' file which can be analyzed using tools such as 'webpack-bundle-analyzer'.

description: Run the TypeScript type checker in a forked process.

description: List of additional NgModule files that will be lazy loaded. Lazy router modules with be discovered automatically.

description: Budget thresholds to ensure parts of your application stay within boundaries which you set.

description: Change root relative URLs in stylesheets to include base HREF and deploy URL. Use only for compatibility and transition. The behavior of this option is non-standard and will be removed in the next major release.

description: TypeScript configuration for Web Worker modules.

description: Define the crossorigin attribute setting of elements that provide CORS support.

description: Concatenate modules with Rollup before bundling them with Webpack.

description: A list of CommonJS packages that are allowed to be used without a build time warning.

description: The pattern to match.

description: The input path dir in which to apply 'glob'. Defaults to the project root.

description: Absolute path within the output.

description: An array of globs to ignore.

description: The file to include.

description: The file to include.

description: The bundle name for this extra entry point.

description: If the bundle will be lazy loaded.

description: If the bundle will be referenced in the HTML file.

description: The file to include.

description: The type of budget.

enum: all allScript any anyScript anyComponentStyle bundle initial

description: The name of the bundle.

description: The baseline size for comparison.

description: The maximum threshold for warning relative to the baseline.

description: The maximum threshold for error relative to the baseline.

description: The minimum threshold for warning relative to the baseline.

description: The minimum threshold for error relative to the baseline.

description: The threshold for warning relative to the baseline (min & max).

description: The threshold for error relative to the baseline (min & max).

description: Dev Server target options for Architect.

description: Target to serve.

description: Port to listen on.

description: Host to listen on.

description: Proxy configuration file.

description: Serve using HTTPS.

description: SSL key to use for serving HTTPS.

description: SSL certificate to use for serving HTTPS.

description: When true, open the live-reload URL in default browser.

description: When true, reload the page on change using live-reload.

description: The URL that the browser client (or live-reload client, if enabled) should use to connect to the development server. Use for a complex dev server setup, such as one with reverse proxies.

description: List of hosts that are allowed to access the dev server.

description: The pathname where the app will be served.

description: When true, don't verify that connected clients are part of allowed hosts.

description: When true, enable hot module replacement.

description: When true, rebuild on change.

description: When true, show a warning when the --hmr option is enabled.

description: When true, show a warning when deploy-url/base-href use unsupported serve path values.

description: Enable optimization of the build output.

description: When true, enable optimization of the scripts output.

description: When true, enable optimization of the styles output.

description: Build using ahead-of-time compilation.

description: When true, output sourcemaps.

description: When true, output sourcemaps for all scripts.

description: When true, output sourcemaps for all styles.

description: When true, resolve vendor packages sourcemaps.

description: When true, use a separate bundle containing only vendor libraries.

description: When true, use a separate bundle containing code used across multiple bundles.

description: URL where files will be deployed.

description: When true, add more details to output logging.

description: When true, log progress to the console while building.

description: Extract i18n target options for Architect.

description: Target to extract from.

description: Output format for the generated file.

description: Output format for the generated file.

description: Specifies the source language of the application.

x-deprecated: Use 'i18n' project level sub-option 'sourceLocale' instead.

description: Use Ivy compiler to extract translations.

description: Log progress to the console.

description: Path where output will be placed.

description: Name of the file to output.

description: Karma target options for Architect.

description: The name of the main entry-point file.

description: The name of the Karma configuration file.

description: The name of the polyfills file.

description: List of static application assets.

description: Options to pass to style preprocessors

description: Defines the build environment.

description: Output sourcemaps.

description: Output sourcemaps for all scripts.

description: Output sourcemaps for all styles.

description: Resolve vendor packages sourcemaps.

description: Run build when files change.

description: Override which browsers tests are run against.

description: Output a code coverage report.

description: Globs to exclude from code coverage.

description: Karma reporters to use. Directly passed to the karma runner.

description: The pattern to match.

description: The input path dir in which to apply 'glob'. Defaults to the project root.

description: Absolute path within the output.

description: An array of globs to ignore.

description: The file to include.

description: The file to include.

description: If the bundle will be lazy loaded.

description: The file to include.

description: Protractor target options for Architect.

description: The name of the Protractor configuration file.

description: Dev server target to run tests against.

description: Execute specs whose names match the pattern, which is internally compiled to a RegExp.

description: Invert the selection specified by the 'grep' option.

description: Override specs in the protractor config.

description: Spec name.

description: Override suite in the protractor config.

description: Try to update webdriver.

description: Compile and Serve the app.

description: The port to use to serve the application.

description: Host to listen on.

description: Base URL for protractor to connect to.

title: Angular Webpack Architect Builder Schema

description: The name of the main entry-point file.

description: Options to pass to style preprocessors

description: Path where output will be placed.

description: Output sourcemaps.

description: Output sourcemaps for all scripts.

description: Output sourcemaps for all styles.

description: Resolve vendor packages sourcemaps.

description: Adds more details to output logging.

description: Localization file to use for i18n.

description: Locale to use for i18n.

description: delete-output-path

description: Use file name for lazy loaded chunks.

description: Available on server platform only. Which external dependencies to bundle into the module. By default, all of node_modules will be bundled.

description: Exclude the listed external dependencies from being bundled into the bundle. Instead, the created bundle relies on these dependencies to be available during runtime.

description: TSlint target options for Architect.

description: The name of the TSLint configuration file.

description: Fixes linting errors (may overwrite linted files).

description: Controls the type check for linting.

description: Succeeds even if there was linting errors.

description: Show output text.

description: Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist, codeFrame).

enum: checkstyle codeFrame filesList json junit msbuild pmd prose stylish tap verbose vso

description: Files to exclude from linting.

description: Files to include in linting.

description: How to handle missing translations for i18n.

description: Translate all locales.

description: List of locales ID's to translate.