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

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

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

description: All explicitly defined dependencies.

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

enum: direct indirect all production development

key: dependency-type


type: object

type: boolean

type: string

type: array

enum: MultipleClientsFromOperationId MultipleClientsFromPathSegments SingleClientFromOperationId SingleClientFromPathSegments

key: clientGenerator


enum: Default CamelCase SnakeCase

enum: Integer String CamelCaseString

key: webApiToSwagger


description: Optional instruction step description.

title: Step description

key: stepDescription


description: By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. '{{Xxx}}').

title: The overriding text for use in comments.

title: The unique constant name.

description: The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code.

title: The .NET (C#) code for the constant value.

required: name value

description: The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.

title: 'Const' object (entity-driven)

key: Const


description: All properties are included in the data model by default.

title: Indicates whether the property is not to be serialized where outputting as a data model.

type: integer

title: The unique (immutable) field number required to enable gRPC support.

description: A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties).

title: The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.

description: Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.

title: The overriding argument name.

description: By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).

description: Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.

title: The overriding private name.

title: The underlying gRPC data type; will be inferred where not specified.

description: Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable.

title: Indicates whether the property should use the underlying Reference Data mapping capabilities.

enum: UseDefault None DateOnly DateTimeLocal DateTimeUtc DateTimeUnspecified

description: Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.

title: The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.

enum: Set Ignore Map Flatten

description: Defaults to 'Set'.

title: The Cosmos 'Mapper' approach for the property.

description: By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).

title: The overriding model text for use in comments.

title: Indicates whether the 'PrimaryKey' property value is automatically generated by the data source on 'Create'.

enum: UseDefault None Lower Upper Title

description: Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.

title: The 'string' casing to be performed on 'Set' and 'CleanUp'.

enum: Map Ignore Skip

description: Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.

title: The OData 'Mapper' approach for the property.

title: The corresponding reference data 'Text' property name; defaults to 'Name' + 'Text'.

description: Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'.

title: The JSON property name.

enum: string int Guid

description: Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.

title: The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).

description: This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.

title: Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').

title: Indicates whether to include the value (default or otherwise) when serializing.

enum: UseDefault None Start End Both

title: The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.

description: Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file.

title: Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').

enum: Optional Always Never

description: This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').'Optional' indicates when 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' then a value is output, 'Always' indicates that the value is _always_ output, and 'Never' indicates that feature is turned off.

title: Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.

enum: UseDefault None NullToEmpty EmptyToNull

title: The 'string' transformation to be performed on 'Set' and 'CleanUp'.

description: Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'.

title: The database 'DbType' override (versus inferring from the corresponding .NET Type).

description: Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'

title: The .NET 'Type'.

title: Indicates that the value is immutable and therefore cannot be changed once set.

description: In this instance the 'Property' will be excluded from the 'Common' entity declaration and 'Business' JSON serialization.

title: Indicates whether the property is for internal use only; declared in Business entities only.

title: Indicates whether the property is inherited and therefore should not be output within the generated Entity class.

description: Defaults to 'Set'.

title: The Entity Framework 'Mapper' approach for the property.

title: Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation).

description: This will implement 'IPartitionKey' for the generated entity.

title: Indicates whether the property is considered part of the Partition Key.

title: Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output.

description: All properties are serialized by default.

title: Indicates whether the property is not to be serialized.

title: Indicates whether the property is to be included within the data model.

description: Defaults to 'JsonName' where not specified.

title: The JSON property name for the corresponding data model (see 'Entity.DataModel').

description: Defaults to 'Set'.

title: The HttpAgent 'Mapper' approach for the property.

description: Defaults to the 'Name' as sentence case.

title: The display name used in the likes of error messages for the property.

title: The unique property name.

title: Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.

description: Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.

title: The C# code to default the value.

description: All properties are included by default.

title: Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.

title: The property annotation (e.g. attribute) declaration code.

description: Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options.

title: The data name where Entity.AutoImplement is selected.

enum: Any AnyExceptCreate AnyExceptUpdate AnyExceptGet Get Create Update Delete

description: Defaults to 'Any'.

title: The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.

description: A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Type'.

title: The data 'Converter' class name where 'Entity.AutoImplement' is selected.

description: This is also used to simplify the parameter specification for an Entity Operation by inferrence.

title: Indicates whether the property is considered part of the primary (unique) key.

description: The 'Property' object defines an 'Entity' property and its charateristics.

title: 'Property' object (entity-driven)

key: Property


enum: All ToManagerSet ToManagerCollSet

description: Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'PrimaryKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.

title: The option that determines the layers in which the parameter is passed.

title: The unique parameter name.

title: Indicates whether the .NET 'Type should be declared as nullable; e.g. 'int?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.

title: The C# code to default the value.

description: By default the 'Text' will be the 'Name' reformatted as sentence casing.

title: The overriding text for use in comments.

title: Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').

description: Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.

title: The overriding private name.

description: Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.

title: The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).

title: Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc).

title: The underlying gRPC data type; will be inferred where not specified.

description: Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.

title: The overriding argument name.

title: The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified).

title: The name of the .NET 'Type' that will perform the validation.

enum: CoreEx FluentValidation

description: Defaults to 'Operation.ValidationFramework'.

title: The 'Validation' framework to use for the entity-based validation.

enum: FromQuery FromBody FromRoute FromEntityProperties

description: Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.

title: The option for how the parameter will be delcared within the Web API Controller.

title: The data 'Converter' class name where specific data conversion is required.

title: The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined.

title: The .NET 'Type'.

description: The 'Parameter' object defines an 'Operation' parameter and its charateristics.

title: 'Parameter' object (entity-driven)

key: Parameter


enum: CSharp TsInterfaceFromDto

description: Generators are loosely coupled. Options are passed as a string dictionary. Only strings here sorry.

key: generator


enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

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

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

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

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


enum: str list dict bool int float path raw jsonarg json bytes bits

key: datatype


description: Polyfills `window.fetch` to enable Network spying and stubbing

description: Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.

description: Whether Cypress will take a screenshot when a test fails during cypress run

type: string boolean

description: Path to plugins file. (Pass false to disable)

description: Whether Cypress will watch and restart tests on test file changes

type: number

description: The distance in pixels an element must exceed over time to be considered animating

description: Time, in milliseconds, to wait for a task to finish executing during a cy.task() command

description: Whether Cypress will capture a video of the tests run with cypress run

description: Path to folder containing component test files (Pass false to disable)

description: Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent

description: Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events. Network requests are limited by the underlying operating system, and may still time out if this value is increased.

default: cypress/integration

description: Path to folder containing integration test files

type: string array

description: A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blockHosts

description: Whether Cypress will process, compress, and upload videos to the Dashboard even when all tests in a spec file are passing. This only applies when recording your runs to the Dashboard. Turn this off if you’d like to only upload the spec file’s video when there are failing tests.

description: A 6 character string use to identify this project in the Cypress Dashboard. See https://on.cypress.io/dashboard-service#Identification

description: Url used as prefix for cy.visit() or cy.request() command’s url. Example http://localhost:3030 or https://test.my-domain.com

description: Port used to host Cypress. Normally this is a randomly generated port

description: The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options

description: Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm.

description: Whether Cypress will trash assets within the screenshotsFolder and videosFolder before tests run with cypress run

description: Any values to be set as environment variables. See https://on.cypress.io/environment-variables

description: Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts

description: A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global

description: Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands

default: cypress/downloads

description: Path to folder where files downloaded during a test are saved

default: spec

description: The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters

description: Time, in milliseconds, to wait until most DOM based commands are considered timed out

description: Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command

description: Generate and save commands directly to your test suite by interacting with your app as an end user would.

description: Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security

description: Default height in pixels for the application under tests’ viewport (Override with cy.viewport() command)

description: Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)

type: object number null

description: The number of times to retry a failing. Can be configured to apply only in runMode or openMode

default: system

enum: system bundled

description: DEPRECATED: If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files.

default: cypress/fixtures

description: Path to folder containing fixture files (Pass false to disable)

default: cypress/videos

description: Path to folder where videos will be saved during cypress run

description: The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run.

description: A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match.

description: Enable experimental session support. See https://on.cypress.io/session

description: Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command

default: root project folder

description: Path to folder where application files will attempt to be served from

required: url certs

description: Requests for URLs matching this minimatch pattern will use the supplied client certificate

description: Path(s) to CA file(s) to validate certs against, relative to project root

required: cert key

description: PEM file specific properties

description: Path to the certificate, relative to project root

description: (Optional) File path to a UTF-8 text file containing the passphrase for the key, relative to project root

description: Path to the private key, relative to project root

description: PFX file specific properties

description: Path to the certificate container, relative to project root

description: (Optional) File path to a UTF-8 text file containing the passphrase for the container, relative to project root

description: Defines client certificates to use when sending requests to the specified URLs

description: Whether to wait for elements to finish animating before executing commands

type: number boolean

description: The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size).

description: Default width in pixels for the application under tests’ viewport. (Override with cy.viewport() command)

default: top

description: Viewport position to which an element should be scrolled prior to action commands. Setting `false` disables scrolling.

description: Enables including elements within the shadow DOM when using querying commands (e.g. cy.get(), cy.find()). Can be set globally in cypress.json, per-suite or per-test in the test configuration object, or programmatically with Cypress.config()

description: Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevent Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode

default: cypress/screenshots

description: Path to folder where screenshots will be saved from cy.screenshot() command or after a test fails during cypress run

key: cypressConfig


description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

pattern: must be an interpolation ref ex. $__arc__{{ secrets.example }}

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.


description: Configuration that dictates the kubernetes deploy overrides.

key: KubernetesDeploySpec


key: ScalingMetricsSpec


description: An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.

not: Only one of buildpack, dockerfile is allowed, or none should exist

required: buildpack dockerfile

description: Option to use buildpack to build an image.

additionalProperties: must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: Build args to be passed into `docker build`.

default: Dockerfile

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: The stage to build in the Dockerfile

key: BuildSpec


description: Configuration for custom certificate.

required: crt key

description: Configuration for custom certificate.

description: Custom certificate ca.

description: Custom certificate key.

description: Custom certificate.

description: Custom certificate ca.

description: Custom certificate key.

description: Custom certificate.

key: IngressTlsSpec


description: Configuration for custom certificate.

description: Configuration for custom certificate.

description: Custom certificate ca.

description: Custom certificate key.

description: Custom certificate.

description: Custom certificate ca.

description: Custom certificate key.

description: Custom certificate.


description: An empty object that optionally supports specifying a tag for backwards compatibility.

key: DependencySpec


description: Component databases let you quickly spin up a database for your service

format: uri

description: The connection uri of an existing database to use instead of provisioning a new one

errorMessage: must be of the format <engine>:<version> (e.g. postgres:13)

description: The type engine and version of database software needed for data storage.

description: Human readable description

description: Human readable description


description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

not: Only one of host_path, key is allowed, or none should exist

description: A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).

description: Marks the volume as readonly.

description: Directory at which the volume will be mounted inside the container.

description: A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).

description: Human-readable description of volume

description: Marks the volume as readonly.

description: Human-readable description of volume

key: VolumeSpec


description: Marks the volume as readonly.

description: Human-readable description of volume

description: Marks the volume as readonly.

description: Human-readable description of volume


description: Human readable description

description: Human readable description

key: DatabaseSpec


description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: Sets a default value for the secret if one is not provided

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Denotes whether the secret is required.


description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

required: path port

required: command port

required: command path

description: Delays the check from running for the specified amount of time

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s

description: The number of times to retry a failed health check before the container is considered unhealthy.

description: [Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).

description: The number of times to retry a health check before the container is considered healthy.

description: [Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).

key: LivenessProbeSpec


description: An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: The stage to build in the Dockerfile


description: An empty object that optionally supports specifying a tag for backwards compatibility.


description: Sets a default value for the secret if one is not provided

description: Denotes whether the secret is required.

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

key: SecretDefinitionSpec


description: Components can define output fields that can be used to share configuration with consuming components.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

key: OutputDefinitionSpec


description: If this is set to a number, the time of the day is the specified value.

title: Fixed Time

description: The multiplier applied to coordinates when traveling to the dimension.

title: Coordinate Scale

description: The total height in which blocks can exist within this dimension.

title: Height

description: Whether players with the Bad Omen effect can cause a raid.

title: Has Raids

description: When true, nether portals can spawn zombified piglins. When false, compasses spin randomly, and using a bed to set the respawn point or sleep, is disabled.

title: Natural

description: The resource location used for the dimension type.

title: Name

description: A resource location defining what block tag to use for infiniburn.

title: Infiniburn

description: The minimum height in which blocks can exist within this dimension.

title: Minimum Y

description: The maximum height to which chorus fruits and nether portals can bring players within this dimension. This excludes portals that were already built above the limit as they still connect normally.

title: Logical Height

description: When false, the bed blows up when trying to sleep.

title: Bed Words

description: How much light the dimension has.

title: Ambient Light

description: Whether the dimension has skylight access or not.

title: Has Skylight

description: Determines the dimension effect used for this dimension.

title: Effects

description: Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also lets stalactites drip lava and causes lava to spread faster and thinner.

title: Ultrawarm

description: Whether the dimension has a bedrock ceiling or not.

title: Has Ceiling

description: Whether piglins shake and transform to zombified piglins.

title: Piglin Safe

description: Whether players can charge and use respawn anchors.

title: Respawn Anchor Works

description: Configuration file defining a dimension type for a data pack for Minecraft.

title: dimension type

key: dimensionType


description: A list of floats. Using more values allows for greater precision. Higher absolute values seem to make the altitude reach greater absolute values.

title: Amplitudes

description: The lower the value, the smoother the changes in altitude will be, making biome edges smoother.

title: First Octave

title: noise options

key: noise


type: string array object number boolean

description: The operations to perform on the source string to get the new variable. https://localazy.com/docs/cli/transformations#operations

title: Operations

description: The source of the variable. Usually, it's a string consisting of other variables. https://localazy.com/docs/cli/variables

title: Source

description: The name of the newly created variable. It will be accessible as ${name}. https://localazy.com/docs/cli/variables

title: Name

key: transformations


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

key: oneOrMoreFlags


description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

key: script


type: string object

default: default

enum: default build

key: dependencies


key: compilationOptions


description: Internet email address conforming to most of RFC 822 syntax rules and by that allowing a majority of internalized email addresses as well.

key: EmailAddress


enum: viewScan exportData administerGe administerProjects administerCache publishScan testDistribution readCache writeCache accessAllProjects accessAnonymousProjectData

key: Role


description: Overwrite options

description: Sets whether overwriting methods must explicitly be declared through @Overwrite annotations

description: Sets whether the visibility of overwritten methods should be conformed to the target class


description: The dot-separated path to the mixin class relative to the specified package. The class must be annotated with @Mixin


description: Injection options

description: Sets the default injector group

description: Registers injection points for this configuration

description: Sets the default minimum of injections that must be successfully applied per injector

description: Sets the maximum allowed number of opcodes that can be shifted in @At annotations. This is hard capped at 5


key: dialogflowEntity


enum: INT64 INTEGER FLOAT64 FLOAT NUMERIC BIGNUMERIC BOOL BOOLEAN STRING BYTES DATE DATETIME TIME TIMESTAMP STRUCT RECORD GEOGRAPHY


required: generation type

description: The definition of an artifact

description: The artifact generation

description: The CLR Type represented by the artifact

key: artifactDefinition


description: Overrides the key to lookup the value for the property.

key: property


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

title: expose

key: sub-command-expose-property


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

title: private

key: sub-command-private-property


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

title: name

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

key: environment-variables-name-property


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

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

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

title: examples

key: examples-property


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

title: argument

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

title: name

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

title: default

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

title: required

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

title: repeatable

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

title: allowed

description: A valid value of the current positional argument

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

title: validate

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

title: help

key: argument


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

title: help

key: dependencies-help-property


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

title: default

key: sub-command-default-property


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

title: private

key: environment-variables-private-property


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

title: name

key: name-property


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

title: version

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

key: root-version-property


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

title: completions

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

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

key: completions-property


examples: Additional arguments or flags for AWS CLI

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

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

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

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

title: catch all

key: catch-all-property


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

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

description: An alias of the current sub-command

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

title: alias

key: sub-command-alias-property


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

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

title: filters

key: filters-property


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

title: required

key: environment-variables-required-property


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

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

title: footer

key: footer-property


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

title: flag

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

title: short

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

title: allowed

description: A valid value of the current positional argument

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

title: help

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

title: completions

description: A completion of the current flag

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

title: default

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

title: required

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

title: long

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

title: repeatable

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

title: private

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

title: arg

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

title: conflicts

description: A mutually exclusive flag of the current flag

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

title: validate

key: flag


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

title: group

key: sub-command-group-property


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

title: default

key: environment-variables-default-property


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

title: function

key: function-property


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

title: help

key: environment-variables-help-property


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

title: help

key: help-property


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

title: import

key: sub-command-import-property


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

title: command

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

key: dependencies-command-property


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

title: extensible

key: root-extensible-property


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

title: filename

key: filename-property


description: Style files config

description: ext glob pattern of common style files that are used by other components. Defines common rules category.

key: IStyleFilesConfig


description:
Configures default paths for new component and template files.
Refer to https://help.codux.com/kb/en/article/kb16522 for more information.

description: Path where project templates are stored.

description: Path where new components and related files will save to.

key: INewComponentConfig


description:
Includes package assets from additional sources, and creates aliases and fallbacks.
Refer to https://help.codux.com/kb/en/article/kb18719 for more information.

description:
Aliases for package requests.
Record key is the request to be mapped, value is the new target.
Alias is attempted before original request.

description:
Fallback for package requests.
Record key is the request to be mapped, value is the new target.
Original request is attempted before fallback.

description:
Aliases for all package requests in a monorepo.
Record key is the request to be mapped, value is the new target.

description: Folders to use when searching for packages.

key: IResolveConfiguration


required: classnamesPath classnamesTarget

key: IClassNamesPluginsOptions


description:
Scopes component discovery in your project.
Refer to https://help.codux.com/kb/en/article/kb37113 for more information.

description: Array of glob patterns to exclude.

description: Array of glob patterns to include.

key: ComponentsDiscoveryConfig


description:
Specifies project folders to exclude from component search.
Refer to https://help.codux.com/kb/en/article/kb14730 for more information.

key: IgnoredSubPaths


description:
Specifies environment variables to use globally across the project.
Refer to https://help.codux.com/kb/en/article/kb37722 for more information.

description: variables that are being accessed from process.env

key: PreviewConfiguration


description:
Add Panel config.
Can contain list of libraries installed in the project which provide boards for Codux.

key: AddPanelConfig


description:
Configures maximum rendered elements.
Refer to https://help.codux.com/kb/en/article/kb18414 for more information.

key: PluggableSafeModeConfig


required: activateCssModules cssModulesExt

description:
Enables CSS modules in your project.
Refer to https://help.codux.com/kb/en/article/kb25813 for more information.

description: The extension types for files to load as modules.

description: Enables or disables the use of CSS modules.

key: ICompilationConfig


required: modules resolveUrls

description:
Adds Sass support to compilations.
Refer to https://help.codux.com/kb/en/article/kb19315 for more information.

description: Array of paths to resolve Sass files from.

description:
Defines path and module extensions for Sass modules to include and/or ignore.
Input as an array of glob patterns.

description: Array of glob patterns to ignore.

description: Array of glob patterns to include.

description: Determines whether URLs in Sass files should resolve to absolute file paths before compiling them.

key: SassCompilationProjectConfigEntry


description: Scripts have a `commmand` but not an array of scripts to `run`.

description:
Initiate Git commands in Codux before running the rest of the scripts.
The array of triggers may include "setup" for when the user opens the project for the first time,
"pull" for when branch commits sync, and "checkout" for when switching branches.

description: This is the command that the script runs when executed.

description: Script description in the UI.

description:
Script title in the UI.
Will be available to use from Codux.

key: ScriptFromConfig


description: Batches have a `run` array but not a `commmand`.

description: The value of this parameter is an array of script objects to include in the batch.

description: Script description in the UI.

key: BatchFromConfig


description: deb repositories

required: type key-id url

validation-failure: {!r} is not properly configured deb repository

description: GPG keyserver to use to fetch GPG <key-id>, e.g. 'keyserver.ubuntu.com'. Defaults to keyserver.ubuntu.com if key is not found in project.

description: Deb repository suites to enable, e.g. 'xenial-updates, xenial-security').

description: Deb repository URL, e.g. 'http://archive.canonical.com/ubuntu'.

description: Architectures to enable, or restrict to, for this repository.  Defaults to host architecture.

description: Deb repository components to enable, e.g. 'main, multiverse, unstable'

description: deb types to enable.  Defaults to [deb, deb-src].

enum: deb deb-src

description: Exact path to repository (relative to URL). Cannot be used with suites or components.

description: GPG key identifier / fingerprint. May be used to identify key file in <project>/snap/keys/<key-id>.asc

key: apt-deb


description: PPA repository

required: type ppa

validation-failure: {!r} is not properly configured PPA repository

description: ppa path: e.g. 'canonical-kernel-team/unstable'

key: apt-ppa


description: environment entries

key: environment


validation-failure: {!r} is not a valid user scope. Valid scopes include: 'shared'

description: short-form user configuration (<username>: <scope>)

key: system-username-scope


required: name type configuration

enum: GET PUT POST DELETE PATCH

type: boolean string

type: integer string

required: registry imageName imageTag

required: sourceArtifactory repository chart version

required: name version sourceDistribution

required: name version

required: serviceName cityName siteName countryCodes sourceDistribution


type: boolean object

type: string number object

type: string number

key: common


description:
A minimum mob spawn in a pack for the current biome
https://minecraft.fandom.com/wiki/Custom_biome

description:
A mob namespaced entity for the current biome
https://minecraft.fandom.com/wiki/Custom_biome

description:
A mod spawn factor for the current biome
https://minecraft.fandom.com/wiki/Custom_biome

description:
A maximum mob spawn in a pack for the current biome
https://minecraft.fandom.com/wiki/Custom_biome

type: object

description:
A spawner for the current biome
https://minecraft.fandom.com/wiki/Custom_biome

title: swawner options

description:
Spawner options for the current biome
https://minecraft.fandom.com/wiki/Custom_biome

key: spawner-options


description: Container types like optional<T>, list<T>, set<T> and map<K, V> can be referenced using their lowercase names, where variables like T, K and V can be substituted for a Conjure named type, a built-in or more container types:

key: ContainerType


enum: any bearertoken binary boolean datetime double integer rid safelong string uuid

key: BuiltIn


description: Named types must be in PascalCase and be unique within a package.

key: TypeName


enum: auto path body header query

key: ArgumentDefinitionParamType


description: References to types that are not defined within Conjure.

description: The fully qualified Java type.

key: ExternalImportDefinition


description: Custom message that will be used in errors and warnings

type: boolean

enum: warning error

description: Message status

key: coreRule


description: The following steps define the reaction of a service to some triggering command or event

type: string

key: policyItem


description: An event signalling that some system state is reached

key: eventItem


description: Can be used to address data coming from another source

key: externalSystemItem


description: The title of your current workflow

key: workflowItem


description: Shows a problem/question in the workflow

key: problemItem


description: The service on which the following events are executed

key: serviceItem


description: Defines the user who is going to perform an action

key: userItem


description: A command send by a user

key: commandItem


description: data object created within a service

key: dataItem


title: The name of the 'Column' to order by.

enum: Ascending Descending

description: Defaults to 'Ascending'.

title: The corresponding sort order.

description: The 'OrderBy' object defines the query order. Only valid for 'StoredProcedure.Type' of 'GetAll'.

title: 'OrderBy' object (database-driven)

key: OrderBy


enum: Before After

description: Defaults to 'After'.

title: The location of the statement in relation to the underlying primary stored procedure statement.

title: The additional TSQL statement.

description: The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.

title: 'Execute' object (database-driven)

key: Execute


description: Defaults to 'Name'; i.e. assumes same name. See also 'ToSchema' and 'ToTable' as these all relate.

title: The name of the other join to column.

description: Defaults to 'Table.Name'; i.e. primary table. See also 'ToSchema' and 'ToColumn' as these all relate.

title: The name of the other join to table.

title: The name of the join column (from the 'Join' table).

description: Defaults to 'Table.Schema'; i.e. same schema. See also 'ToTable' and 'ToColumn' as these all relate.

title: The name of the other join to table schema.

title: The fully qualified name ('Alias.Name') of the other column being joined to or other valid SQL (e.g. function) bypassing the corresponding 'Schema', 'Table' and 'Column' logic.

description: The 'QueryJoinOn' object defines the join on characteristics for a join within a query.

title: 'QueryJoinOn' object (database-driven)

key: QueryJoinOn


title: The parameter name (without the '@' prefix).

description: Note that when the parameter value is 'NULL' it will not be included in the query.

title: Indicates whether the parameter is nullable.

description: Defaults to 'Name'.

title: The corresponding column name; used to infer characteristics.

title: Indicates whether the column value where NULL should be treated as the specified value; results in: 'ISNULL([x].[col], value)'.

title: Indicates whether the parameter is a collection (one or more values to be included 'IN' the query).

enum: EQ NE LT LE GT GE LIKE

description: Defaults to 'EQ'.

title: The where clause equality operator

title: The SQL type definition (overrides inherited Column definition) including length/precision/scale.

description: The 'Parameter' is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected 'StoredProcedure.Type'.

title: 'Parameter' object (database-driven)

key: Parameter


title: The where TSQL statement.

description: The 'QueryWhere' object defines an additional where 'Statement' to be added.

title: 'QueryWhere' object (database-driven)

key: QueryWhere


title: The where statement (TSQL).

description: The 'Where' object defines an additional where 'Statement' to be added. This is in addition to those automatically added based on the 'StoredProcedure.Type'.

title: 'Where' object (database-driven)

key: Where


description: Defaults to 'Table.Name'; i.e. primary table. See also 'Schema' and 'Column' as these all relate.

title: The name of the order by table.

description: Defaults to 'Ascending'.

title: The corresponding sort order.

description: See also 'Schema' and 'Table' as these all relate.

title: The name of the 'Column' to order by.

description: Defaults to 'Query.Schema'.

title: The name of order by table schema. See also 'Name' and 'Column' as these all relate.

description: The 'QueryOrder' object that defines the query order.

title: 'QueryOrder' object (database-driven)

key: QueryOrder


description: URL to the Cloud Foundry endpoint.

key: apiEndpoint


description: Identifier of the subaccount.

key: account


description: Version of the runtime. See runtime-version for more information.

key: runtimeVersion


description: String of VM arguments passed to the JVM.

key: vmArguments


description: Name of the application.

key: appName


description: Cloud Foundry space.

key: space


description: Manifest file that needs to be used.

key: manifest


description: The image used in the step or stage.

key: dockerImage


description: Name of the application in your account.

key: application


description: Host of the region you want to deploy to, see Regions.

key: host


description: ID to the credentials that will be used.

key: credentialsId


description: (Only for MTA-projects) Path to the mta extension description file. For more information on how to use those extension files please visit the SAP HANA Developer Guide.

key: mtaExtensionDescriptor


description: The URLs under which the app is available after deployment. Each appUrl can be a string with the URL or a map containing a property url and a property credentialId.

description: ID to the credentials that will be used to connect to the SAP Cloudplatform account.

type: array

description: Additional parameters can be passed for each end-to-end test deployment by specifying optional parameters for an application URL. These parameters are appended to the npm command during execution. These parameters must be a list of strings, where each string corresponds to one element of the parameters. For example, if the parameter `--tag scenario1` should be passed to the test, specify parameters: ['--tag', 'scenario1'].

key: appUrls


description: Cloud Foundry organization.

key: org


description: Name of the runtime: neo-java-web, neо-javaee6-wp, neо-javaee7-wp. See the runtime for more information.

key: runtime


description: (Only for MTA-projects) Map of credentials that need to be replaced in the mtaExtensionDescriptor. This map needs to be created as value-to-be-replaced:id-of-a-credential-in-jenkins

key: mtaExtensionCredentials


description: Map of environment variables in the form of KEY: VALUE.

key: environment


default: lite

description: Size of the JVM, e.g. lite, pro, prem, prem-plus.

key: size


enum: get post delete head patch put options trace

description: The type of WebHook handled by the trigger (if handling a pre-defined WebHook).

description: The function HTTP route template.

default: function

enum: anonymous function admin

description: The function HTTP authorization level.

key: httpBinding


description: A filter expression to be applied when retrieving rows.

description: The number or records to retrieve.

description: The name of the storage table.

description: An app setting (or environment variable) with the storage connection string to be used by this binding.

description: The partition key.

description: The table row key.

key: tableBinding


description: The name of the table to be monitored for changes.

enum: text storedProcedure

description: Whether the commandText is a query (text) or a stored procedure (storedProcedure).

description: Either a query string or the name of a stored procedure to execute.

description: The parameters to the query or stored procedure.

const: out

const: sql

description: The name of the table into which rows will be upserted.

description: The name of the app setting that contains the SQL connection string used to connect to the database.

key: sqlBinding


description: The name of the app setting which contains your SendGrid api key.

description: The email address to send from.

description: The text of the email.

description: The email address to send to.

description: The subject of the email.

key: sendGridBinding


description: The name of the notification hub.

description: The tag to send the notification to.

enum: apns adm gcm wns mpns

description: The notification platform to target. Sends template notification if platform is omitted.

description: The name of the app setting which contains the notification hub connection string.

key: notificationHubBinding


description: The Kusto command to execute.Can be a KQL query or a KQL function with optional parameters.

description: The parameters to the query or function. Named parameters are of the form @paramName=paramValue.

description: Dataformat to use in ingestion.The default dataformat is `multijson/json`. This has been tested for text formats

description: The table to ingest the data into.

description: An ingestion mapping ref that points to the mapping created in kusto and referenced in ingestion (optional).

description: A managed service identity that has to be attached to use the bindings.

description: Name of the app setting that contains the kusto connection string used to connect to kusto.

description: Name of the database within your kusto account to which data will be read/written.

key: kustoBinding


description: When true, your timer function will be invoked immediately after a runtime restart and on-schedule thereafter.

description: When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute.

description: A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule.

key: timerTriggerBinding


description: An app setting (or environment variable) with the storage connection string to be used by this binding.

description: The queue name.

key: queueBinding


description: The name of the app setting which contains your Twilio authentication token.

description: Optional body of SMS text message.

description: The phone number the SMS text is sent from.

description: The phone number the SMS text is sent to.

description: The name of the app setting which contains your Twilio Account Sid.

key: twilioSmsBinding


description: The path to the blob container

key: blobBinding


description: This is the id for the record to retrieve.

description: This is the name of the table within your Mobile App to which data will be written.

description: This is the app setting name that specifies the URL of your Mobile App.

description: This is app setting name that specifies the API Key for your Mobile App.

key: mobileBinding


description: This is the query to run against the collection.

description: When true, your database and collection will be created automatically.

description: This is the connection string for your DocumentDB account.

description: This is the name of the collection within your database to which data will be written.

description: This is the name of the database within your DocumentDB account to which data will be written.

key: documentDBBinding


description: An app setting (or environment variable) with the service bus connection string to be used by this binding.

enum: manage listen send

description: The permission level of the service bus connection string used by this binding.

description: The service bus queue to monitor (if using a queue)

description: The topic subscription name

description: The service bus topic to monitor (if using a queue)

key: serviceBusBinding


description: The event hub consumer group.

enum: one many

description: The cardinality hint for the input binding parameter (single message or array of messages).

description: The event hub path.

description: The event hub connection string setting.

key: eventHubBinding


required: name type direction

enum: string binary stream

description: The data type hint for the binding parameter (string, binary, or stream).

enum: in out inout

key: bindingBase


enum: serviceBusTrigger serviceBus blobTrigger blob manualTrigger eventHubTrigger eventHub timerTrigger queueTrigger queue httpTrigger http mobileTable documentDB table notificationHub twilioSms sendGrid sql sqlTrigger kusto

key: dynamicBinding


description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

key: script


enum: default build

enum: project package

description: Restrict this dependency to matching only a Project or a Package

key: dependencies


key: compilationOptions


required: name type

description: Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used.

enum: bower cargo carthage composer cpan renv gem git go hackage hex maven npm nuget paket pub pypi cocoapods swift url

description: Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution.

description: Name of the dependency. This name will be used to search for dependency in relevant registries.

key: referenced-app-dependency


enum: alpine centos debian redhat ubuntu oraclelinux busybox sles fedora

description: Name of the distribution OS.

key: os


required: name path

description: Path to directory, which will be archived and upload to provided endpoint for license scanning.

description: Version of the dependency. This will be the version associated with this vendored dependency in FOSSA's dashboard

description: Name of the dependency. This will be the name associated with this vendored dependency in FOSSA's dashboard

key: vendored-dependency


required: name url version

description: Url of the dependency's source code. This will be the downloaded by FOSSA for scanning with the analysis.

description: Version of the dependency.

description: Name of the dependency. This will be the version used in FOSSA's dashboard.

description: Homepage of the dependency. This should be web address.

description: Description of the dependency (if any)

key: remote-dependency


required: name version license

description: Version of the dependency. This will be the version used in FOSSA's dashboard.

description: Name of the dependency. This will be the name used in FOSSA's dashboard.

description: License of the dependency. This string will be used to infer license type.

description: Description of the dependency (if any)

key: custom-dependency


type: integer

format: utc-millisec


$xsd-type: InternationalStringType

key: dsb-InternationalStringType


$xsd-type: UseVerificationTimeType

default: false


required: alg val

$xsd-type: DigestInfoType

key: dsb-DigestInfoType


required: uri pre

$xsd-type: NsPrefixMappingType

key: dsb-NsPrefixMappingType


$xsd-type: ReturnTransformedDocumentType


$xsd-type: AugmentSignatureInstructionType


$xsd-type: AdditionalTimeInfoType


$xsd-type: NameIDType


description: Path to base configuration file to inherit from (requires TypeScript version 2.1 or later), or array of base files, with the rightmost files having the greater priority (requires TypeScript version 5.0 or later).

key: extendsDefinition


description: Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.

description: Specifies a list of type declarations to be included in auto type acquisition. Ex. ["jquery", "lodash"]

description: Enable auto type acquisition

description: Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]

key: typeAcquisitionDefinition


description: Specifies a list of files to be excluded from compilation. The 'exclude' property only affects the files included via the 'include' property and not the 'files' property. Glob patterns require TypeScript version 2.0 or later.

key: excludeDefinition


markdownDescription:
Build all projects, including those that appear to be up to date

See more: https://www.typescriptlang.org/tsconfig#force

markdownDescription:
Enable verbose logging

See more: https://www.typescriptlang.org/tsconfig#verbose

description: Enable verbose logging

markdownDescription:
Log paths used during the `moduleResolution` process.

See more: https://www.typescriptlang.org/tsconfig#traceResolution

markdownDescription:
Save .tsbuildinfo files to allow for incremental compilation of projects.

See more: https://www.typescriptlang.org/tsconfig#incremental

markdownDescription:
Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.

See more: https://www.typescriptlang.org/tsconfig#assumeChangesOnlyAffectDirectDependencies

key: buildOptionsDefinition


description: Project reference.

description: Path to referenced tsconfig or to folder containing tsconfig.

description: Referenced projects. Requires TypeScript version 3.0 or later.

key: referencesDefinition


description: Specifies a list of glob patterns that match files to be included in compilation. If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. Requires TypeScript version 2.0 or later.

key: includeDefinition


description: Enable Compile-on-Save for this project.

key: compileOnSaveDefinition


description: Settings for the watch mode in TypeScript.

markdownDescription:
Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.

See more: https://www.typescriptlang.org/tsconfig#synchronousWatchDirectory

markdownDescription:
Remove a list of files from the watch mode's processing.

See more: https://www.typescriptlang.org/tsconfig#excludeFiles

markdownDescription:
Specify how the TypeScript watch mode works.

See more: https://www.typescriptlang.org/tsconfig#watchFile

markdownDescription:
Specify how directories are watched on systems that lack recursive file-watching functionality.

See more: https://www.typescriptlang.org/tsconfig#watchDirectory

markdownDescription:
Specify what approach the watcher should use if the system runs out of native file watchers.

See more: https://www.typescriptlang.org/tsconfig#fallbackPolling

markdownDescription:
Remove a list of directories from the watch process.

See more: https://www.typescriptlang.org/tsconfig#excludeDirectories

key: watchOptionsDefinition


description: Instructs the TypeScript compiler how to compile .ts files.

markdownDescription:
Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

See more: https://www.typescriptlang.org/tsconfig#emitBOM

description: Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

markdownDescription:
Ensure that each file can be safely transpiled without relying on other imports.

See more: https://www.typescriptlang.org/tsconfig#isolatedModules

description: Ensure that each file can be safely transpiled without relying on other imports.

default: useFsEvents

enum: useFsEvents fixedPollingInterval dynamicPriorityPolling fixedChunkSizePolling

description: Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.

markdownDescription:
Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

See more: https://www.typescriptlang.org/tsconfig#disableSizeLimit

description: Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

markdownDescription:
When type checking, take into account `null` and `undefined`.

See more: https://www.typescriptlang.org/tsconfig#strictNullChecks

description: When type checking, take into account `null` and `undefined`.

markdownDescription:
Check for class properties that are declared but not set in the constructor.

See more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization

description: Check for class properties that are declared but not set in the constructor.

markdownDescription:
Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.

See more: https://www.typescriptlang.org/tsconfig#outFile

markdownDescription:
Disable strict checking of generic signatures in function types.

See more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks

description: Disable strict checking of generic signatures in function types.

markdownDescription:
Enable color and formatting in output to make compiler errors easier to read

See more: https://www.typescriptlang.org/tsconfig#pretty

description: Enable color and formatting in output to make compiler errors easier to read

markdownDescription:
Disable wiping the console in watch mode

See more: https://www.typescriptlang.org/tsconfig#preserveWatchOutput

description: Disable wiping the console in watch mode

markdownDescription:
Allow importing helper functions from tslib once per project, instead of including them per-file.

See more: https://www.typescriptlang.org/tsconfig#importHelpers

description: Allow importing helper functions from tslib once per project, instead of including them per-file.

markdownDescription:
Ensure overriding members in derived classes are marked with an override modifier.

See more: https://www.typescriptlang.org/tsconfig#noImplicitOverride

description: Ensure overriding members in derived classes are marked with an override modifier.

markdownDescription:
Emit ECMAScript-standard-compliant class fields.

See more: https://www.typescriptlang.org/tsconfig#useDefineForClassFields

description: Emit ECMAScript-standard-compliant class fields.

markdownDescription:
Differentiate between undefined and not present when type checking

See more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes

description: Differentiate between undefined and not present when type checking

description: Watch input files.

markdownDescription:
Include sourcemap files inside the emitted JavaScript.

See more: https://www.typescriptlang.org/tsconfig#inlineSourceMap

description: Include sourcemap files inside the emitted JavaScript.

markdownDescription:
Make keyof only return strings instead of string, numbers or symbols. Legacy option.

See more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly

description: Make keyof only return strings instead of string, numbers or symbols. Legacy option.

markdownDescription:
Include source code in the sourcemaps inside the emitted JavaScript.

See more: https://www.typescriptlang.org/tsconfig#inlineSources

description: Include source code in the sourcemaps inside the emitted JavaScript.

markdownDescription:
Use the package.json 'exports' field when resolving package imports.

See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonExports

description: Use the package.json 'exports' field when resolving package imports.

markdownDescription:
Set the newline character for emitting files.

See more: https://www.typescriptlang.org/tsconfig#newLine

enum: crlf lf

pattern: ^(CRLF|LF|crlf|lf)$

description: Set the newline character for emitting files.

markdownDescription:
Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'

See more: https://www.typescriptlang.org/tsconfig#jsxFactory

description: Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'

markdownDescription:
Conditions to set in addition to the resolver-specific defaults when resolving imports.

See more: https://www.typescriptlang.org/tsconfig#customConditions

description: Conditions to set in addition to the resolver-specific defaults when resolving imports.

markdownDescription:
Enable error reporting in type-checked JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#checkJs

description: Enable error reporting in type-checked JavaScript files.

description: Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.

markdownDescription:
Disable truncating types in error messages.

See more: https://www.typescriptlang.org/tsconfig#noErrorTruncation

description: Disable truncating types in error messages.

markdownDescription:
Create sourcemaps for d.ts files.

See more: https://www.typescriptlang.org/tsconfig#declarationMap

description: Create sourcemaps for d.ts files.

markdownDescription:
Raise an error when a function parameter isn't read

See more: https://www.typescriptlang.org/tsconfig#noUnusedParameters

description: Raise an error when a function parameter isn't read

markdownDescription:
Disable emitting file from a compilation.

See more: https://www.typescriptlang.org/tsconfig#noEmit

description: Disable emitting file from a compilation.

markdownDescription:
Only output d.ts files and not JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#emitDeclarationOnly

description: Only output d.ts files and not JavaScript files.

markdownDescription:
Specify what module code is generated.

See more: https://www.typescriptlang.org/tsconfig#module

description: Specify what module code is generated.

markdownDescription:
Disable adding 'use strict' directives in emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict

description: Disable adding 'use strict' directives in emitted JavaScript files.

markdownDescription:
Use the package.json 'imports' field when resolving imports.

See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonImports

description: Use the package.json 'imports' field when resolving imports.

markdownDescription:
Specify a list of language service plugins to include.

See more: https://www.typescriptlang.org/tsconfig#plugins

description: Plugin name.

description: Specify a list of language service plugins to include.

default: .tsbuildinfo

markdownDescription:
Specify the folder for .tsbuildinfo incremental compilation files.

See more: https://www.typescriptlang.org/tsconfig#tsBuildInfoFile

description: Specify the folder for .tsbuildinfo incremental compilation files.

markdownDescription:
Print all of the files read during the compilation.

See more: https://www.typescriptlang.org/tsconfig#listFiles

description: Print all of the files read during the compilation.

markdownDescription:
Enable error reporting for codepaths that do not explicitly return in a function.

See more: https://www.typescriptlang.org/tsconfig#noImplicitReturns

description: Enable error reporting for codepaths that do not explicitly return in a function.

markdownDescription:
Disable preferring source files instead of declaration files when referencing composite projects

See more: https://www.typescriptlang.org/tsconfig#disableSourceOfProjectReferenceRedirect

description: Disable preferring source files instead of declaration files when referencing composite projects

markdownDescription:
Output more detailed compiler performance information after building.

See more: https://www.typescriptlang.org/tsconfig#extendedDiagnostics

description: Output more detailed compiler performance information after building.

markdownDescription:
Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.

See more: https://www.typescriptlang.org/tsconfig#esModuleInterop

description: Print names of files that are part of the compilation and then stop processing.

markdownDescription:
Add `undefined` to a type when accessed using an index.

See more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess

description: Add `undefined` to a type when accessed using an index.

markdownDescription:
Disable including any library files, including the default lib.d.ts.

See more: https://www.typescriptlang.org/tsconfig#noLib

description: Disable including any library files, including the default lib.d.ts.

markdownDescription:
Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.

See more: https://www.typescriptlang.org/tsconfig#maxNodeModuleJsDepth

description: Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.

markdownDescription:
Specify the location where debugger should locate map files instead of generated locations.

See more: https://www.typescriptlang.org/tsconfig#mapRoot

description: Specify the location where debugger should locate map files instead of generated locations.

markdownDescription:
Create source map files for emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#sourceMap

description: Create source map files for emitted JavaScript files.

markdownDescription:
Enforces using indexed accessors for keys declared using an indexed type

See more: https://www.typescriptlang.org/tsconfig#noPropertyAccessFromIndexSignature

description: Enforces using indexed accessors for keys declared using an indexed type

markdownDescription:
Disable emitting declarations that have `@internal` in their JSDoc comments.

See more: https://www.typescriptlang.org/tsconfig#stripInternal

description: Disable emitting declarations that have `@internal` in their JSDoc comments.

default: react

markdownDescription:
Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.

See more: https://www.typescriptlang.org/tsconfig#jsxImportSource

description: Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.

markdownDescription:
Emit a v8 CPU profile of the compiler run for debugging.

See more: https://www.typescriptlang.org/tsconfig#generateCpuProfile

description: Emit a v8 CPU profile of the compiler run for debugging.

markdownDescription:
Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.

See more: https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax

markdownDescription:
Suppress `noImplicitAny` errors when indexing objects that lack index signatures.

See more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors

description: Suppress `noImplicitAny` errors when indexing objects that lack index signatures.

markdownDescription:
Emit more compliant, but verbose and less performant JavaScript for iteration.

See more: https://www.typescriptlang.org/tsconfig#downlevelIteration

description: Emit more compliant, but verbose and less performant JavaScript for iteration.

markdownDescription:
Disable error reporting for unused labels.

See more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels

description: Disable error reporting for unused labels.

default: classic

enum: classic node node16 nodenext bundler

markdownDescription:
Specify how TypeScript looks up a file from a given module specifier.

See more: https://www.typescriptlang.org/tsconfig#moduleResolution

description: Specify how TypeScript looks up a file from a given module specifier.

markdownDescription:
Default catch clause variables as `unknown` instead of `any`.

See more: https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables

description: Default catch clause variables as `unknown` instead of `any`.

markdownDescription:
Enable error reporting when a local variables aren't read.

See more: https://www.typescriptlang.org/tsconfig#noUnusedLocals

description: Enable error reporting when a local variables aren't read.

default: remove

enum: remove preserve error

description: Specify emit/checking behavior for imports that are only used for types.

markdownDescription:
Preserve unused imported values in the JavaScript output that would otherwise be removed

See more: https://www.typescriptlang.org/tsconfig#preserveValueImports

description: Preserve unused imported values in the JavaScript output that would otherwise be removed

markdownDescription:
Specify the base directory to resolve non-relative module names.

See more: https://www.typescriptlang.org/tsconfig#baseUrl

description: Specify the base directory to resolve non-relative module names.

markdownDescription:
Enable all strict type checking options.

See more: https://www.typescriptlang.org/tsconfig#strict

description: Enable all strict type checking options.

markdownDescription:
Enable importing .json files

See more: https://www.typescriptlang.org/tsconfig#resolveJsonModule

description: Enable importing .json files

markdownDescription:
Disable emitting comments.

See more: https://www.typescriptlang.org/tsconfig#removeComments

description: Disable emitting comments.

description: Enable tracing of the name resolution process. Requires TypeScript version 2.0 or later.

markdownDescription:
Enable constraints that allow a TypeScript project to be used with project references.

See more: https://www.typescriptlang.org/tsconfig#composite

description: Enable constraints that allow a TypeScript project to be used with project references.

markdownDescription:
Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.

See more: https://www.typescriptlang.org/tsconfig#allowJs

description: Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.

markdownDescription:
Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.

See more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions

markdownDescription:
Allow accessing UMD globals from modules.

See more: https://www.typescriptlang.org/tsconfig#allowUmdGlobalAccess

description: Allow accessing UMD globals from modules.

markdownDescription:
Disable reporting of excess property errors during the creation of object literals.

See more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors

description: Disable reporting of excess property errors during the creation of object literals.

markdownDescription:
Skip type checking all .d.ts files.

See more: https://www.typescriptlang.org/tsconfig#skipLibCheck

description: Skip type checking all .d.ts files.

markdownDescription:
Generate .d.ts files from TypeScript and JavaScript files in your project.

See more: https://www.typescriptlang.org/tsconfig#declaration

description: Generate .d.ts files from TypeScript and JavaScript files in your project.

markdownDescription:
Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

See more: https://www.typescriptlang.org/tsconfig#target

description: Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

default: React

markdownDescription:
Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.

See more: https://www.typescriptlang.org/tsconfig#reactNamespace

description: Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.

markdownDescription:
Specify the root path for debuggers to find the reference source code.

See more: https://www.typescriptlang.org/tsconfig#sourceRoot

description: Specify the root path for debuggers to find the reference source code.

markdownDescription:
Specify the root folder within your source files.

See more: https://www.typescriptlang.org/tsconfig#rootDir

description: Specify the root folder within your source files.

markdownDescription:
Disable erasing `const enum` declarations in generated code.

See more: https://www.typescriptlang.org/tsconfig#preserveConstEnums

description: Disable erasing `const enum` declarations in generated code.

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling fixedInterval priorityInterval dynamicPriority fixedChunkSize

description: Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.

markdownDescription:
Specify the output directory for generated declaration files.

See more: https://www.typescriptlang.org/tsconfig#declarationDir

description: Specify the output directory for generated declaration files.

markdownDescription:
Opt a project out of multi-project reference checking when editing.

See more: https://www.typescriptlang.org/tsconfig#disableSolutionSearching

description: Opt a project out of multi-project reference checking when editing.

markdownDescription:
Allow 'import x from y' when a module doesn't have a default export.

See more: https://www.typescriptlang.org/tsconfig#allowSyntheticDefaultImports

description: Allow 'import x from y' when a module doesn't have a default export.

markdownDescription:
Disable emitting files if any type checking errors are reported.

See more: https://www.typescriptlang.org/tsconfig#noEmitOnError

description: Disable emitting files if any type checking errors are reported.

markdownDescription:
Enable error reporting for expressions and declarations with an implied `any` type..

See more: https://www.typescriptlang.org/tsconfig#noImplicitAny

description: Enable error reporting for expressions and declarations with an implied `any` type..

markdownDescription:
Reduce the number of projects loaded automatically by TypeScript.

See more: https://www.typescriptlang.org/tsconfig#disableReferencedProjectLoad

description: Reduce the number of projects loaded automatically by TypeScript.

description: Enable incremental compilation. Requires TypeScript version 3.4 or later.

markdownDescription:
Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.

See more: https://www.typescriptlang.org/tsconfig#noResolve

description: Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.

markdownDescription:
Disable resolving symlinks to their realpath. This correlates to the same flag in node.

See more: https://www.typescriptlang.org/tsconfig#preserveSymlinks

description: Disable resolving symlinks to their realpath. This correlates to the same flag in node.

description: Path mapping to be computed relative to baseUrl option.

markdownDescription:
Specify a set of entries that re-map imports to additional lookup locations.

See more: https://www.typescriptlang.org/tsconfig#paths

description: Specify a set of entries that re-map imports to additional lookup locations.

markdownDescription:
Specify a set of bundled library declaration files that describe the target runtime environment.

See more: https://www.typescriptlang.org/tsconfig#lib

description: Specify a set of bundled library declaration files that describe the target runtime environment.

markdownDescription:
When assigning functions, check to ensure parameters and the return values are subtype-compatible.

See more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes

description: When assigning functions, check to ensure parameters and the return values are subtype-compatible.

markdownDescription:
Specify multiple folders that act like `./node_modules/@types`.

See more: https://www.typescriptlang.org/tsconfig#typeRoots

description: Specify multiple folders that act like `./node_modules/@types`.

markdownDescription:
No longer supported. In early versions, manually set the text encoding for reading files.

See more: https://www.typescriptlang.org/tsconfig#charset

description: No longer supported. In early versions, manually set the text encoding for reading files.

markdownDescription:
Emit design-type metadata for decorated declarations in source files.

See more: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata

description: Emit design-type metadata for decorated declarations in source files.

markdownDescription:
Specify an output folder for all emitted files.

See more: https://www.typescriptlang.org/tsconfig#outDir

description: Specify an output folder for all emitted files.

markdownDescription:
Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.

See more: https://www.typescriptlang.org/tsconfig#jsxFragmentFactory

description: Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.

markdownDescription:
Enable error reporting when `this` is given the type `any`.

See more: https://www.typescriptlang.org/tsconfig#noImplicitThis

description: Enable error reporting when `this` is given the type `any`.

markdownDescription:
Ensure 'use strict' is always emitted.

See more: https://www.typescriptlang.org/tsconfig#alwaysStrict

description: Ensure 'use strict' is always emitted.

markdownDescription:
Enable importing files with any extension, provided a declaration file is present.

See more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions

description: Enable importing files with any extension, provided a declaration file is present.

enum: preserve react react-jsx react-jsxdev react-native

description: Specify what JSX code is generated.

markdownDescription:
Specify type package names to be included without being referenced in a source file.

See more: https://www.typescriptlang.org/tsconfig#types

description: Specify type package names to be included without being referenced in a source file.

markdownDescription:
Allow multiple folders to be treated as one when resolving modules.

See more: https://www.typescriptlang.org/tsconfig#rootDirs

description: Allow multiple folders to be treated as one when resolving modules.

markdownDescription:
Skip type checking .d.ts files that are included with TypeScript.

See more: https://www.typescriptlang.org/tsconfig#skipDefaultLibCheck

description: Skip type checking .d.ts files that are included with TypeScript.

markdownDescription:
Disable generating custom helper functions like `__extends` in compiled output.

See more: https://www.typescriptlang.org/tsconfig#noEmitHelpers

description: Disable generating custom helper functions like `__extends` in compiled output.

markdownDescription:
Check that the arguments for `bind`, `call`, and `apply` methods match the original function.

See more: https://www.typescriptlang.org/tsconfig#strictBindCallApply

description: Check that the arguments for `bind`, `call`, and `apply` methods match the original function.

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling useFsEvents useFsEventsOnParentDirectory fixedChunkSizePolling

description: Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.

markdownDescription:
Enable error reporting for fallthrough cases in switch statements.

See more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch

description: Enable error reporting for fallthrough cases in switch statements.

markdownDescription:
Ensure that casing is correct in imports.

See more: https://www.typescriptlang.org/tsconfig#forceConsistentCasingInFileNames

description: Ensure that casing is correct in imports.

markdownDescription:
Output compiler performance information after building.

See more: https://www.typescriptlang.org/tsconfig#diagnostics

description: Output compiler performance information after building.

markdownDescription:
Disable error reporting for unreachable code.

See more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode

description: Disable error reporting for unreachable code.

markdownDescription:
Print the names of emitted files after a compilation.

See more: https://www.typescriptlang.org/tsconfig#listEmittedFiles

description: Print the names of emitted files after a compilation.

markdownDescription:
Enable experimental support for TC39 stage 2 draft decorators.

See more: https://www.typescriptlang.org/tsconfig#experimentalDecorators

description: Enable experimental support for TC39 stage 2 draft decorators.


description: If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. When a 'files' property is specified, only those files and those specified by 'include' are included.

key: filesDefinition


enum: native bytecode js

description: The compiler to use for the target

description: Name of the main module used as entry point for this target. 'entry-point' isn't used when this project is built as a dependency.

key: targetItems


description: suffix of generated js files, default to [.js]

key: suffix-spec


description: Default: `["-no-alias-deps"]`

enum: reset prefix append

description: (Not implemented yet)

key: bsc-flags


description: path to gentype, path resolution is similar to ReScript

key: gentype-specs


description: backward compatible mode, true means on with the default to be version 1 (the default value is subject to change)

title: jsx-version

key: react-jsx-version


description: es6-global generate relative `require` paths instead of relying on NodeJS' module resolution. Default: commonjs.

key: module-format


description: The shell command is running in *dev* time, and you generated could should be checked in, the depedency is tracked properly during dev time,example: `{ "name" : "ocamllex", "command" : "ocamllex.opt $in -o $out"}`

key: rule-generator


description: Note that we will add the directory path accordingly

key: build-generator


description: Paths for any folders you'd like to exclude from analysis. Useful for bindings and similar. Example: `["src/bindings"]`.

description: specify whether transitively dead items should be reported (default: false)

description: Any specific paths inside suppressed folders that you want to unsuppress. Example: ["src/bindings/SomeBinding.res"].

enum: dce exception termination

description: The types of analysis to activate. `dce` means dead code analysis, `exception` means exception analysis, and `termination` is to check for infinite loops.

key: reanalyze


title: dependency

key: bs-dependency


description: true to use the package name as namespace, false to not use

description: provide customized namespace name

key: namespace-spec


description: Tags to add

enum: platform projectType

description: The tag to modify

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

key: tags


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

description: The host identifier.

key: unsupportedHost


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

enum: setupComponent extension

description: The host id that the component applies to

description: The id of the component

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

key: requiredComponent


enum: none templateGroup shared

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

key: persistenceScope


description: Capture names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'.

key: Capture


description: A URL identifying a resource, which may be a relative local path with respect to the current resource (i.e, ../path/to/flow.yaml), or may be an external absolute URL (i.e., http://example/flow.yaml).

description: Module is either a relative URL of a TypeScript module file, or is an inline representation of a Typescript module. The module must have a exported Derivation variable which is an instance implementing the corresponding Derivation interface.

title: TypeScript module implementing this derivation.

key: DeriveUsingTypescript


description: Transform names are Unicode letters, numbers, '-', '_', or '.'.

key: Transform