chrome-manifest.json

type: object

type: string

description: Tooltip for the main toolbar icon.

$ref: #/definitions/uri

description: The popup appears when the user clicks the icon.

description: FIXME: String form is deprecated.

description: Icon for the main toolbar.

$ref: #/definitions/icon

description: Tooltip for the main toolbar icon.

$comment: Global shortcuts change the acceptable pattern for the suggested_key.

type: boolean

description: Whether this command should work while Chrome does not have focus. Keyboard shortcut suggestions for global commands are limited to Ctrl+Shift+[0..9]

description: This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.

format: content-security-policy

default: script-src 'self'; object-src 'self'

format: glob-pattern

format: match-pattern

format: mime-type

type: array

format: permission

description: An array of resources to be exposed. Resources are specified as strings and may contain * for wildcard matches. For example, "/images/*" exposes everything in the extension's /images directory recursively while "*.png" exposes all PNG files.

description: A list of URL match patterns specifying which pages can access the resources. Only the origin is used to match URLs; subdomains patterns (*.google.com) and paths are ignored.

description: A list of extension IDs, specifying which extensions can access the resources.

description: If true, only allow resources to be accessible through dynamic ID. The dynamic ID is generated per session. It's regenerated on browser restart or extension reload.

description: The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.

description: When false, makes the background page an event page (loaded only when needed).

$ref: #/definitions/page

description: Specify the HTML of the background page.

$ref: #/definitions/scripts

description: A background page will be generated by the extension system that includes each of the files listed in the scripts property.

description: Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup.

description: Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.

description: An array of strings specifying the paths (relative to the package root) of packaged resources that are expected to be usable in the context of a web page.

type: number

description: One integer specifying the version of the manifest file format your package requires.

description: The name of the extension

description: One to four dot-separated integers identifying the version of this extension.

description: Specifies the subdirectory of _locales that contains the default strings for this extension.

default: en

description: A plain text description of the extension

description: One or more icons that represent the extension, app, or theme. Recommended format: PNG; also BMP, GIF, ICO, JPEG.

description: Used as the favicon for an extension's pages and infobar.

description: Used on the extension management page (chrome://extensions).

description: Used during installation and in the Chrome Web Store.

description: Override pages are a way to substitute an HTML file from your extension for a page that Google Chrome normally provides.

description: The page that appears when the user chooses the Bookmark Manager menu item from the Chrome menu or, on Mac, the Bookmark Manager item from the Bookmarks menu. You can also get to this page by entering the URL chrome://bookmarks.

description: The page that appears when the user chooses the History menu item from the Chrome menu or, on Mac, the Show Full History item from the History menu. You can also get to this page by entering the URL chrome://history.

description: The page that appears when the user creates a new tab or window. You can also get to this page by entering the URL chrome://newtab.

description: Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.

$ref: #/definitions/command

description: Content scripts are JavaScript files that run in the context of web pages.

description: Specifies which pages this content script will be injected into.

description: Excludes pages that this content script would otherwise be injected into.

description: The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.

description: The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.

description: The JavaScript world for a script to execute within.

enum: ISOLATED MAIN

default: ISOLATED

description: Controls when the files in js are injected.

description: Controls whether the content script runs in all frames of the matching page, or only the top frame.

description: Applied after matches to include only those URLs that also match this glob. Intended to emulate the @include Greasemonkey keyword.

description: Applied after matches to exclude URLs that match this glob. Intended to emulate the @exclude Greasemonkey keyword.

description: Whether to insert the content script on about:blank and about:srcdoc.

description: A DevTools extension adds functionality to the Chrome DevTools. It can add new UI panels and sidebars, interact with the inspected page, get information about network requests, and more.

description: Declares which extensions, apps, and web pages can connect to your extension via runtime.connect and runtime.sendMessage.

description: The IDs of extensions or apps that are allowed to connect. If left empty or unspecified, no extensions or apps can connect.

description: The URL patterns for web pages that are allowed to connect. This does not affect content scripts. If left empty or unspecified, no web pages can connect.

description: Indicates that the extension would like to make use of the TLS channel ID of the web page connecting to it. The web page must also opt to send the TLS channel ID to the extension via setting includeTlsChannelId to true in runtime.connect's connectInfo or runtime.sendMessage's options.

description: You can use this API to enable users to upload files to your website.

description: Used by event handling code to differentiate between multiple file handlers

description: What the button will display.

description: Filetypes to match.

description: The URL of the homepage for this extension.

description: Specify how this extension will behave if allowed to run in incognito mode.

description: Allows your extension to handle keystrokes, set the composition, and manage the candidate window.

required: name type id description language layouts

description: This value can be used to control the unique ID of an extension, app, or theme when it is loaded during development.

description: The version of Chrome that your extension, app, or theme requires, if any.

description: One or more mappings from MIME types to the Native Client module that handles each type.

description: The location of a Native Client manifest (a .nmf file) within the extension directory.

description: The MIME type for which the Native Client module will be registered as content handler.

description: Use the Chrome Identity API to authenticate users: the getAuthToken for users logged into their Google Account and the launchWebAuthFlow for users logged into a non-Google account.

description: You need to register your app in the Google APIs Console to get the client ID.

description: Whether the app or extension is expected to work offline. When Chrome detects that it is offline, apps with this field set to true will be highlighted on the New Tab page.

description: The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.

description: The keyword that will trigger your extension.

description: Use the chrome.permissions API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary.

description: To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, a link to it will be provided from the extensions management page at chrome://extensions. Clicking the Options link opens a new tab pointing at your options page.

description: To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, an Options link will be shown on the extensions management page at chrome://extensions which opens a dialogue containing your options page.

description: The path to your options page, relative to your extension's root.

description: If true, a Chrome user agent stylesheet will be applied to your options page. The default value is false, but we recommend you enable it for a consistent UI with Chrome.

description: If true, your extension's options page will be opened in a new tab rather than embedded in chrome://extensions. The default is false, and we recommend that you don't change it. This is only useful to delay the inevitable deprecation of the old options UI! It will be removed soon, so try not to use it. It will break.

description: Permissions help to limit damage if your extension or app is compromised by malware. Some permissions are also displayed to users before installation, as detailed in Permission Warnings.

description: Technologies required by the app or extension. Hosting sites such as the Chrome Web Store may use this list to dissuade users from installing apps or extensions that will not work on their computer.

description: The '3D' requirement denotes GPU hardware acceleration.

description: List of the 3D-related features your app requires.

description: Indicates if an app or extension requires NPAPI to run. This requirement is enabled by default when the manifest includes the 'plugins' field.

description: Defines an collection of app or extension pages that are to be served in a sandboxed unique origin, and optionally a Content Security Policy to use with them.

description: The short name is typically used where there is insufficient space to display the full name.

description: If you publish using the Chrome Developer Dashboard, ignore this field. If you host your own extension or app: URL to an update manifest XML file.

description: Register itself as a speech engine.

description: Voices the extension can synthesize.

description: Identifies the name of the voice and the engine used.

description: Almost always, a voice can synthesize speech in just a single language. When an engine supports more than one language, it can easily register a separate voice for each language.

description: If your voice corresponds to a male or female voice, you can use this parameter to help clients choose the most appropriate voice for their application.

description: Events sent to update the client on the progress of speech synthesis.

description: In addition to the version field, which is used for update purposes, version_name can be set to a descriptive version string and will be used for display purposes if present.

description: The service worker js file.

description: Used to control the toolbar button for your extension in Chrome's UI.

description: This policy covers pages in your extension, including html files and service workers.

description: This policy covers any sandboxed extension pages that your extension uses.

description: An array of objects that declare resource access rules. Each object maps an array of extension resources to an array of URLs and/or extension IDs that can access those resources.

$comment: browser_action and page_action are no longer present in v3

title: JSON schema for Google Chrome extension manifest files


foundryvtt-system-manifest.json

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

description: Specifies the default initiative formula if applicable to the system.

description: Integer specifying the default size of a grid space.

description: A label that specifies the default unit of measure used by the system.

examples: ft m

description: An attribute path within the system data model that points to an object that contains both a `value` and a `max` key. The prototype Token will automatically set its primary attribute to this value.

description: An attribute path within the system data model that points to an object that contains both a `value` and a `max` key. The prototype Token will automatically set its secondary attribute to this value.

title: JSON schema for Foundry VTT system files - system.json.


adonisrc.schema.json

description: Is project written in Typescript or not

description: Http server exception handler namespace

description: The driver to use for assets bundling

enum: encore vite fake

enum: web console test repl

required: name files

required: typescript providers


mason-registry.json

$comment: SPDX license list; releaseDate=2022-12-15; source=https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json

enum:
.NET
1С:Enterprise
AWK
Ada
Angular
Ansible
Antlers
Apex
Arduino
Assembly
Astro
Azure Pipelines
Bash
Bazel
Beancount
Bicep
Blade
BrighterScript
C
C#
C++
CMake
CQL
CSS
Clarity
Clojure
ClojureScript
CodeQL
Crystal
Csh
Cucumber
Cue
D
DOT
Dart
Dhall
Django
Docker
Drools
Elixir
Elm
Ember
Emmet
Erg
Erlang
F#
Fennel
Flow
Flux
Fortran
Gleam
Glimmer
Go
Gradle
GraphQL
Groovy
HAML
HTML
Handlebargs
Handlebars
Haskell
Haxe
Helm
Hoon
JSON
JSX
Java
JavaScript
Jinja
Jq
Jsonnet
Julia
Kotlin
Ksh
LESS
LaTeX
Lelwel
Liquid
Lua
Luau
Markdown
Metamath Zero
Mksh
Move
Mustache
Nginx
Nickel
Nim
Nix
Nunjucks
OCaml
Odin
OneScript
OpenAPI
OpenCL
OpenEdge
OpenFOAM
OpenSCAD
PHP
Perl
PowerShell
Prisma
Progress
Protobuf
Puppet
PureScript
Python
R
Raku
ReScript
Reason
Robot Framework
Ruby
Rust
SCSS
SQL
Salt
Sass
Scala
Sh
Shell
Slint
Smithy
Standard ML
Snakemake
Solidity
Sphinx
Starlark
Stylelint
Svelte
SystemVerilog
TOML
Teal
Terraform
Text
Twig
TypeScript
Typst
V
Vala
Veryl
VimScript
Visualforce
Vue
WGSL
XML
YAML
YARA
Zig
Zsh

enum: Compiler DAP Formatter LSP Linter Runtime

description: List of platforms supported by the cargo package.

description: Extra gem packages required by the main package to function.

description: List of platforms supported by the gem package.

required: id download

required: id build

description: The shell script to run. Platform sensitive (bash on Unix, powershell on Windows).

description: Whether to run the build script in a staging location (defaults to true).

required: id asset

required: constraint asset

required: target file

description: Extra golang packages required by the main package to function.

description: Extra npm packages required by the main package to function.

description: Extra pypi packages required by the main package to function.

description: List of platforms supported by the pypi package.

description: A URL to where the LSP JSON schema can be downloaded from. If the provided URL is a VSCode package.json you MUST prefix the url with vscode:

description: Schema for package definitions.

description: The package name. MUST be unique within the registry it belongs to.

description: The description of the package. Usually sourced upstream.

format: uri

description: A URL to the package's homepage.

required: name description homepage licenses languages categories source

title: Mason Registry package schema


helmfile.json

description: Default values to set for args along with dedicated keys that can be set by contributors, cli args take precedence over these.

description: limit the maximum number of revisions saved per release. Use 0 for no limit.

description: if used with charts museum allows to pull unstable charts for deployment, for example: if 1.2.3 and 1.2.4-dev versions exist and set to true, 1.2.4-dev will be pulled (default false)

$ref: #/definitions/hook

$ref: #/definitions/map

$ref: #/definitions/missingFileHandler

description: When set to `true`, skips running `helm dep up` and `helm dep build` on this release's chart.

type: integer

required: name chart

enum: Error Warn Info Debug

description: Configure a fixed list of API versions to pass to 'helm template' via the --api-versions flag with the below:

description: The list of environments managed by helmfile.

description: these labels will be applied to all releases in a Helmfile. Useful in templating if you have a helmfile per environment or customer and don't want to copy the same label to each release

description: Path to alternative helm binary (--helm-binary)

description: Helmfile runs various helm commands to converge the current state in the live cluster to the desired state defined here.

title: Helmfile config schema


markdown-lint-check.json

required: pattern replacement


appsscript.json

title: homepage trigger

description: The Google Workspace add-on manifest configuration for homepage triggers.

description: Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.

description: The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.

description: Version of the server to use when executing this project.

default: STABLE

description: The script time zone in one of the available ZoneId values such as "America/Denver".

title: dependencies

description: A list of advanced services and libraries.

description: The list of advanced services enabled for use by the script project.

title: advanced service

description: A single advanced service.

required: userSymbol serviceId version

description: The identifier used to refer to this service in the code of the Apps Script project.

default: Sheets

description: The identifier of the service that is shown in the API discovery document (e.g., drive).

default: sheets

description: The enabled version of the service (e.g., "v1").

description: The list of libraries used by the script project.

title: library

description: A single library.

required: userSymbol libraryId version

description: The label that is used in the script project code to refer to this library.

description: The script ID of the library's script project. You can find a script ID in the library script's URL or in the script editor by selecting **File > Project properties**.

description: The version of the library that is used by the script. This is either a version number or stable, meaning the last version created.

description: If true, version is ignored and the script uses the current library project saved code, even if that code has not been saved to a new version.

title: script

description: The script project's web app configuration. Only used if the project is deployed as a web app.

description: The levels of permission for running the web app.

enum: MYSELF DOMAIN ANYONE ANYONE_ANONYMOUS

default: MYSELF

description: The identity under which the web app executes.

description: The location where exceptions are logged.

description: The definition of authorization scopes used by the script project.

description: A list of HTTPS URL prefixes. If present, any URL endpoint fetched must match one of the prefixes in this list. This can help to protect user data.

format: hostname

title: api options

description: The script project's API executable configuration. Only used if the project is deployed for API execution.

description: Determines who has permission to run the script from the API.

title: sheet manifest

description: Defines manifest values specific to Sheets.

description: A list of defined macros and their associated properties.

title: macros

description: A defined macros and it's associated properties.

description: The name of the macro as it appears in the Google Sheets UI.

default: My Macro

description: The name of the Apps Script function that executes the macro. By default this matches the menuName for functions automatically created, but this is not a requirement.

default: myFunction

description: Defines the keyboard shortcut that executes the macro. This must be of the form Ctrl+Alt+Shift+Number, where Number is a single-digit. Macros without shortcuts can only be executed from the Tools > Macros menu.

required: menuName functionName defaultShortcut

title: add-on manifest

description: Data Studio add-on manifest.

description: Display name for add-on.

description: URL for logo image of add-on.

description: Company name for the add-on.

description: URL for support information of the add-on.

description: Short description about the add-on.

description: List of sources or services that can be accessed with this add-on.

description: A single source type.

title: templates

description: Map of template name to report ID.

description: Even shorter description used in gallery cards. Only a maximum of 114 characters will be shown on the card.

description: List of AuthTypes supported.

description: Types of Authorization supported by the add-on.

description: Url for privacy policy information about the add-on.

description: Url for terms of service information about the add-on.

required: name logoUrl company supportUrl description

title: add-ons

description: G Suite Add-ons

title: common options

description: Common properties between all G Suite add-on types.

description: The add-on name.

description: The logo URL.

title: layout options

description: Layout properties.

description: The color of toolbar. Defaults to grey (#424242).

description: The default color of buttons. Defaults to the primary color (if it is set); otherwise defaults to blue (#2196F3).

title: homepage trigger

description: Homepage trigger data

description: Whether or not homepage (non-contextual) cards are enabled. Defaults to true.

description: The name of the function to run

description: Universal add-on actions

title: actions

description: Actions

description: The action label.

description: The link's URL

description: Required for each defined universal action if openLink is not present. If provided, the name of the Apps Script function that executes when the user selects this action.

description: Link prefixes.

description: A link prefix.

description: Use the locale from the host application?

required: logoUrl name

title: add-on metadata

description: Gmail add-on metadata.

description: Contextual triggers.

title: contextual trigger

description: A contextual trigger.

description: The name of the Apps Script function that executes when this contextual trigger fires (that is, when a message is opened in Gmail). The function specified here must build and return an array of Card objects.

title: unconditional

description: Used to specify that the contextual trigger is fired for all Gmail messages. This is currently the only option, so this should always be an empty object.

title: homepage trigger

description: The trigger function specification for creating the add-on homepage in the Gmail host.

description: Whether or not homepage (non-contextual) cards are enabled in Gmail. Defaults to true.

title: calendar metadata

description: Calendar add-on metadata.

title: homepage trigger

description: The trigger function specification for creating the add-on homepage in the Calendar host.

title: event

description: When a Calendar event is opened

description: Event hander function

title: event

description: When a Calendar event is updated

description: Event hander function

description: Handler access to Calendar event

title: add-on options

description: Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application.

title: contextual trigger

description: A configuration for a contextual trigger that fires when the add-on presents the request file scope dialog.

title: JSON schema for Google Apps Script manifest files


gitpod-schema.json

title: Gitpod Config

description: List of exposed ports.

type: number string

description: The port number (e.g. 1337) or range (e.g. 3000-3999) to expose.

enum: open-browser open-preview notify ignore

description: What to do when a service on this port was detected. 'notify' (default) will show a notification asking the user what to do. 'open-browser' will open a new browser tab. 'open-preview' will open in the preview on the right of the IDE. 'ignore' will do nothing.

enum: private public

default: private

description: Whether the port visibility should be private or public. 'private' (default) will only allow users with workspace access to access the port. 'public' will allow everyone with the port URL to access the port.

description: Port name.

enum: http https

description: The protocol of workspace port.

description: A description to identify what is this port used for.

description: List of tasks to run on start. Each task will open a terminal in the IDE.

description: Name of the task. Shown on the tab of the opened terminal.

description: A shell command to run before `init` and the main `command`. This command is executed on every start and is expected to terminate. If it fails, the following commands will not be executed.

description: A shell command to run between `before` and the main `command`. This command is executed only on after initializing a workspace with a fresh clone, but not on restarts and snapshots. This command is expected to terminate. If it fails, the `command` property will not be executed.

description: A shell command to run after `before`. This command is executed only on during workspace prebuilds. This command is expected to terminate. If it fails, the workspace build fails.

deprecationMessage: Deprecated. Please use `init` task instead. See https://www.gitpod.io/docs/config-start-tasks.

description: The main shell command to run after `before` and `init`. This command is executed last on every start and doesn't have to terminate.

description: Environment variables to set.

enum: bottom main left right

description: The panel/area where to open the terminal. Default is 'bottom' panel.

enum: split-left split-right tab-before tab-after

description: The opening mode. Default is 'tab-after'.

type: object string

description: The Docker image to run your workspace in.

default: gitpod/workspace-full

description: Relative path to a docker file.

description: Relative path to the context path (optional). Should only be set if you need to copy files into the image.

description: List of additional repositories that are part of this project.

description: The url of the git repository to clone. Supports any context URLs.

description: Path to where the repository should be checked out relative to `/workspace`. Defaults to the simple repository name.

description: The main repository, containing the dev environment configuration.

description: Path to where the IDE's workspace should be opened. Supports vscode's `*.code-workspace` files.

description: Git config values should be provided in pairs. E.g. `core.autocrlf: input`. See https://git-scm.com/docs/git-config#_values.

description: Configures Gitpod's GitHub app

type: boolean object

description: Set to true to enable workspace prebuilds, false to disable them. Defaults to true.

description: Enable prebuilds for the default branch (typically master). Defaults to true.

description: Enable prebuilds for all branches. Defaults to false.

description: Enable prebuilds for pull-requests from the original repo. Defaults to true.

description: Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false.

description: Add a Review in Gitpod badge to pull requests. Defaults to true.

type: boolean string

description: Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true.

description: Add a label to a PR when it's prebuilt. Set to true to use the default label (prebuilt-in-gitpod) or set to a string to use a different label name. This is a beta feature and may be unreliable. Defaults to false.

description: Configure VS Code integration

description: List of extensions which should be installed for users of this workspace. The identifier of an extension is always '${publisher}.${name}'. For example: 'vscode.csharp'.

description: Configure JetBrains integration

deprecationMessage: The 'jetbrains' property is experimental.

description: List of plugins which should be installed for all JetBrains product for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

$ref: #/definitions/jetbrainsProduct

description: Configure IntelliJ integration

description: Configure GoLand integration

description: Configure PyCharm integration

description: Configure PhpStorm integration

description: Configure RubyMine integration

description: Configure WebStorm integration

description: Configure Rider integration

description: Configure CLion integration

deprecationMessage: The 'experimentalNetwork' property is deprecated.

description: Experimental network configuration in workspaces (deprecated). Enabled by default

description: Configure the default action of certain signals is to cause a process to terminate and produce a core dump file, a file containing an image of the process's memory at the time of termination. Disabled by default.

deprecationMessage: The 'coreDump' property is experimental.

description: upper limit on the size of the core dump file that will be produced if it receives a core dump signal

description: the hard limit acts as a ceiling for the soft limit. For more details please check https://man7.org/linux/man-pages/man2/getrlimit.2.html

description: List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

description: Enable warming up of JetBrains backend in prebuilds.

enum: stable latest both

description: Whether only stable, latest or both versions should be warmed up. Default is stable only.

description: Configure JVM options, for instance '-Xmx=4096m'.


codemagic-schema.json

title: Codemagic CI/CD configuration file - docs.codemagic.io

title: Workflows for building a project

description: You can use codemagic.yaml to define several workflows for building a project. Each workflow describes the entire build pipeline from triggers to publishing. For example, you may want to have separate workflows for developing, testing and publishing the app.

errorMessage: Incorrect type. Expected a dictionary

$ref: #/definitions/Workflow

title: InstanceType

description: Build machine type to use for the build.

title: DistributionType

description: An enumeration.

title: ProfileWithVariable

title: Profile reference

description: Profile reference found in Team settings -> Code signing identities

title: Environment variable

description: Name of the variable containing the profile path

title: CertificateWithVariable

title: Certificate reference

description: Certificate reference found in Team settings -> Code signing identities

title: Environment variable

description: Name of the variable containing the certificate path

title: IosSigning

title: Distribution type

description: Type of certificates and profiles to fetch from Code signing identities

errorMessage: Incorrect distribution type. Expected one of ad_hoc, app_store, development, enterprise

$ref: #/definitions/DistributionType

title: Bundle identifier

description: Bundle identifier of certificates and profiles to fetch from Code signing identities

title: Provisioning profiles

description: Provisioning profiles to fetch from Code signing identities

errorMessage: Incorrect type. Expected list of strings or dictionaries

$ref: #/definitions/ProfileWithVariable

title: Certificates

description: Certificates to fetch from Code signing identities

$ref: #/definitions/CertificateWithVariable

title: KeystoreWithVariables

title: Keystore reference

description: Keystore reference found in Team settings -> Code signing identities

title: Keystore environment variable

description: Name of the variable containing the keystore path

title: Keystore password environment variable

description: Name of the variable containing the keystore password

title: Key alias environment variable

description: Name of the variable containing the key alias

title: Key password environment variable

description: Name of the variable containing the key password

title: FlutterWithFlavor

title: Flutter version

description: Define the channel name, version (e.g. v1.13.4) or 'fvm' if using Flutter Version Management.

title: Flutter flavor

description: The name of the flavor to use when using FVM.

title: Environment

title: Environment variables

description: Define your environment variables.

errorMessage: Incorrect type. Expected a dictionary with integer, float, boolean or nonempty string as values

title: Environment variable groups

description: Define environment variable group names that have been configured in app or team settings.

errorMessage: Incorrect type. Expected a list of nonempty strings

title: iOS code signing identities

description: iOS code signing identities configured under Team settings

$ref: #/definitions/IosSigning

title: Android code signing identities

description: Android code signing identities configured under Team settings

errorMessage: Incorrect type. Expected a list

$ref: #/definitions/KeystoreWithVariables

title: Xcode version

description: Define latest, edge or version (e.g. 11.2).

default: latest

errorMessage: Incorrect type. Expected an integer, float or nonempty string

title: CocoaPods version

description: Define default or version (e.g. 1.9.1).

default: default

title: Node version

description: Define default, latest, current, lts, carbon (or another stream), nightly or version (e.g. 12.4.0).

title: Npm version

description: Define default, latest, next, lts or version (e.g. 6.13.7).

title: Ndk revision

description: Define default or revision (e.g. r19c).

title: Java platform version

description: Define default, or platform version (e.g. 11).

title: Ruby platform version

description: Define default, or platform version (e.g. 2.5.1).

title: Flutter version

errorMessage: Incorrect type. Expected an integer, float, nonempty string or dictionary

$ref: #/definitions/FlutterWithFlavor

title: Unity version

description: Define exact version (e.g. 2020.3.15f2).

errorMessage: Incorrect type. Expected a nonempty string

title: Integrations

title: Use info from Apple Developer Portal integration

description: Specify the name of the App Store Connect API key to be used from team or personal integrations to authenticate actions for code signing and publishing.

title: Cache

title: Paths to be cached

description: For example, you may consider caching the following paths: "$FLUTTER_ROOT/.pub-cache" for Dart cache, "$HOME/.gradle/caches" for gradle cache, "$HOME/Library/Caches/CocoaPods" for CocoaPods cache.

title: TriggeringEvent

description: Currently supported events are push, pull_request.

enum: push pull_request tag

title: BranchPattern

title: Exact value or glob pattern to search for a branch

description: The pattern can also be passed with an environment variable.

errorMessage: Incorrect type. Expected an integer, float, boolean or nonempty string

title: Include the pattern

description: If set to false, the matching branches will not be watched for triggering events.

title: Specify whether the watched branch is the source or the target of the pull request

description: The variable is ignored for events other than pull_request.

title: TagPattern

title: Exact value or glob pattern to search for a tag

title: Include the pattern

description: If set to false, the matching tags will not be watched for triggering events.

title: Triggering

title: List the events that trigger builds

description: Currently supported events are push, pull_request, tag.

title: Branch patterns

description: A branch pattern can match the name of a particular branch, or you can use wildcard symbols to create a pattern that matches several branches. Note that for pull request builds you have to specify whether the watched branch is the source or the target of the pull request.

errorMessage: Incorrect type. Expected a not empty list of dictionaries

title: Tag patterns

description: A tag pattern can match the name of a particular tag, or you can use wildcard symbols to create a pattern that matches several tags.

title: Cancel previous builds

description: To avoid running builds on outdated commits, set cancel_previous_builds to true to automatically cancel all ongoing and queued builds triggered by webhooks on push or pull request commit when a more recent build has been triggered for the same branch.

title: Changeset

title: Include paths to watch

title: Exclude paths from watched

title: When

title: Watched paths or path patterns

description: List of paths or path patterns to watch for changes, proceed if changes are detected.

title: Condition

description: Check if condition evaluates to true before proceeding with building workflow or script.

title: ScriptOnFailure

description: The only supported action is to proceed directly to publishing.

title: NamedScript

title: Script to be executed

description: By default the script will be run in the Bash shell. You can run the script in other languages by defining a shebang line in the beginning.

title: Script name

description: A descriptive script name can be provided to be shown in the UI. If not passed, the first line of your script will be shown in the UI for the script block.

title: Exact name or glob pattern matching the test result file location

description: You can display test results visually in the build overview. The value can be an absolute path, or a path relative to $CM_BUILD_DIR (in this case the patterns will be searched recursively). Supported test report formats are Junit XML and .JSON for Flutter's --machine report.

title: Ignore script failure

description: If set to true, the workflow will continue to run even if the script fails.

title: The action to take on script failure

title: Conditions for script to continue

description: All conditions below should be met in order for script to continue.

title: Script working directory

description: Specify directory where this script will be executed. It overrides global workflow working directory.

title: PublisherNotification

title: Publish on success

description: Set to false to not receive a notification when a build succeeds.

title: Publish on failure

description: Set to false to not receive a notification when a build fails.

title: Email

title: List the email addresses to notify about build results

description: Provide valid email addresses here.

title: Email notification settings

description: Allows to turn on or turn off email notification on build success or failure.

title: Slack

title: Specify the Slack channel for publishing

description: To allow publishing to private channels, invite the Codemagic Slack app to the channels by writing @codemagic in the channel.

title: Send a Slack notification when a build starts

description: When you set notify_on_build_start to true, the channel will be notified when a build starts.

title: Slack notification settings

description: Allows to turn on or turn off slack notification on build success or failure.

title: AppStoreConnectAuth

description: An enumeration.

title: AppStoreReleaseType

description: An enumeration.

title: AppStoreConnect

title: App Store Connect authentication method

description: Accepted value: integration. When defined, the API key info inherited from integrations is used for authenticating with App Store Connect. If you omit this key-value pair, you must define API key, key identifier and issuer identifier explicitly.

title: App Store Connect API key

description: App Store Connect API key in .p8 format that is used for authenticating application packages validation and upload to App Store Connect. It is required for TestFlight submission.

title: App Store Connect API key identifier

description: App Store Connect API key identifier that is used for authenticating application packages validation and upload to App Store Connect. It is required for TestFlight submission.

title: App Store Connect API key issuer identifier

description: App Store Connect API key issuer identifier that is used for authenticating application packages validation and upload to App Store Connect. It is required for TestFlight submission.

title: Apple ID

description: The email address used to log in to App Store Connect. It can also be passed with an environment variable.

errorMessage: Incorrect type. Expected a string in the form of an encrypted value, environment variable or plain text email

title: App-specific password

description: App-specific passwords allow you to sign in to your account securely when you use third-party apps with your Apple ID. e.g. ujlw-ypqu-dgzw-vyog. The plain or encrypted password can also be passed with en environment variable.

errorMessage: Incorrect type. Expected a string in the form of an encrypted value, environment variable or plain text password

title: Submit uploaded application package to Testflight

description: Submit published build to Testflight. Requires authentication using App Store Connect API key.

title: Expire previous build submitted to review before submitting package to Testflight

description: Expire previously submitted build that is in review before submitting published build to Testflight. Requires authentication using App Store Connect API key.

title: Release uploaded application package to the groups of beta testers

description: Published build will be made available to the specified Beta groups in App Store Connect. TestFlight submission is required in order to release builds to the groups of beta testers.

title: Submit uploaded application package to App Store review

description: Submit published build to App Store review. Requires authentication using App Store Connect API key.

description: Cancel previous submissions before submitting application package to App Store review. Requires authentication using App Store Connect API key.

title: Specify when to release the app after App Store review

description: Choose when to release the app. You can either manually release the app at a later date on the App Store Connect website, or the app version can be automatically released right after it has been approved by App Review.

errorMessage: Incorrect release type. Expected one of MANUAL, AFTER_APPROVAL, SCHEDULED

title: Specify earliest return date for scheduled release type

description: Specify earliest return date for scheduled release type. Timezone aware ISO8601 timestamp, for example 2021-11-10T14:55:41+00:00.

errorMessage: Not a valid timezone aware ISO8601 timestamp

title: The name of the person or entity that owns the exclusive rights to your app

description: The name of the person or entity that owns the exclusive rights to your app, preceded by the year the rights were obtained (for example, "2008 Acme Inc."). Do not provide a URL.

errorMessage: Incorrect type. Expected a string in the form of an environment variable or plain text

title: GooglePlay

title: Service account credentials

description: The encrypted JSON key file or the encrypted contents of the JSON key file. The value can also be passed with an environment variable.

title: Name of the track

description: Codemagic enables you to automatically publish your app to Google Play.

title: Priority of the release

description: If your application supports in-app updates, set the release priority by specifying an integer in range [0, 5]. Otherwise, in_app_update_priority can be omitted.

title: Rollout fraction

description: Codemagic supports staged releases, allowing users to choose which fraction of the testers or users get access to the application. To release to everyone, omit the rollout_fraction field.

title: Do not send changes for review

description: Indicates that the changes in this edit will not be reviewed until they are explicitly sent for review from the Google Play Console UI.

title: Create the release in draft status

description: Indicates that the artifacts generated in the build will be uploaded to Google Play as a draft release.

title: FirebaseAndroidArtifactType

description: An enumeration.

title: FirebaseType

title: Firebase application id

description: Firebase application id found in Firebase application settings.

title: Groups to be distributed to

description: Test groups that the application should be distributed to.

title: Preferable Android artifact type

description: Artifact type (aab/apk) to prioritize when uploading to Firebase App Distribution, by default app bundles are prioritized.

errorMessage: Incorrect artifact type. Expected 'apk' or 'aab'

title: Firebase

title: Firebase access token

description: Firebase access token generated using Firebase CLI; to receive the token use firebase login:ci with Firebase CLI installed.

title: Service account with Firebase distribution permission

description: The content of service account file that has "Firebase App Distribution Admin" role.

title: iOS

description: Codemagic enables you to automatically publish your iOS app to Firebase App Distribution.

title: android

description: Codemagic enables you to automatically publish your Android app to Firebase App Distribution.

title: PartnerCenter

title: Partner Center store ID

description: Store ID set up on Microsoft Partner Center.

title: Partner Center tenant id

description: Directory (tenant) ID in Azure AD portal.

title: Partner Center client id

description: Application (client) ID in Azure AD portal.

title: Partner Center client secret

description: The value of the Azure AD app key.

title: Publishing

title: Email

description: If the build finishes successfully, release notes (if passed) and the generated artifacts will be published to the provided email address(es). If the build fails, an email with a link to build logs will be sent.

title: Slack

description: Integrate Slack publishing into your Codemagic build pipeline to get notified when a build starts and receive build artifacts or logs when the build finishes. To set up publishing to Slack, you first need to connect your Slack workspace in User integrations for personal apps and in Team integrations for team apps.

title: App Store Connect

description: Codemagic enables you to automatically publish your iOS app to App Store Connect for beta testing with TestFlight or distributing the app to users via App Store.

title: Google Play

description: Codemagic enables you to automatically publish your app to the internal, alpha, beta and production tracks on Google Play. In order to do so, you will need to set up a service account in Google Play Console and add the JSON key file to your Codemagic configuration file.

title: Firebase

description: Codemagic enables you to automatically publish your app to Firebase App Distribution. In order to do so, set up an account and project on Firebase and provide Codemagic with your Firebase token, Firebase app id and test groups.

title: Partner Center

description: Codemagic enables you to automatically publish your app to Microsoft Store. In order to do so, set up an account and project on Microsoft Partner Center and provide Codemagic with your store id, client id, client secret and tenant id.

title: Custom post-publishing scripts

description: Add scripts to publish to any other service.

errorMessage: Incorrect type. Expected a not empty list of strings (inline script) or dictionaries (scripts with additional fields)

title: Workflow

title: Workflow name

description: Workflow name displayed in the Codemagic UI.

title: Instance type

title: Build timeout settings

description: By default, Codemagic builds are set to time out after 60 minutes. You can decrease or increase the maximum build duration.

title: Build environment

description: Environment contains all the environment variables and enables to specify the version of Flutter, Xcode, CocoaPods, Node, npm, ndk, Java and Ruby used for building. This is also where you can add credentials and API keys required for code signing. Make sure to encrypt the values of variables that hold sensitive data.

title: Integrations

description: Allows using info from the integrations connected in Codemagic UI. Currently supported: app_store_connect.

title: Cache

description: Define the paths to be cached and stored on Codemagic.

title: Automatic build triggering for watched branches

description: Triggering defines the events for automatic build triggering and watched branches. If no events are defined, you can start builds only manually.

title: Conditions for build to continue

description: All conditions below should be met in order for build to continue.

title: Working directory

description: Specify the default directory to run script commands. Each script will be executed inside the specified directory, unless the working directory is specified for the script itself.

title: Build scripts

description: Scripts specify what kind of application is built. This is where you can specify the commands to test, build and code sign your project. You can also run shell (sh) scripts directly in your .yaml file, or run scripts in other languages by defining the language with a shebang line or by launching a script file present in your repository.

title: Artifacts to be saved

description:
Configure the paths and names of the artifacts you would like to use in the following steps, e.g. for publishing, or have available for download on the build page. All paths are relative to the clone directory, but absolute paths are supported as well. You can also use environment variables in artifact patterns.
The pattern can match several files or folders. If it picks up files or folders with the same name, the top level file or folder name will be suffixed with _{number}.
If one of the patterns includes another pattern, duplicate artifacts are not created.
apk, aab, aar, ipa, app, proguard mapping (mapping.txt), flutter_drive.log, jar, zip, xarchive and dSYM.zip files will be available as separate items in the Artifacts section on the build page. The rest of the artifacts will be included in an archive with the following name pattern: {project-name}_{version}_artifacts.zip.

errorMessage: Incorrect type. Expected a not empty list of strings, integers, floats or booleans

title: Publishing and deployment

description: The matching artifacts will be published to the services you have configured. The available integrations currently are email, Slack, Google Play and App Store Connect. It is also possible to publish elsewhere with custom publishing scripts.

title: Build labels

description: Define label names to easily filter builds in UI. You can use environment variable as well.


aerleon-policies.schema.json

title: Aerleon Policy File

$ref: #/$defs/policyTermIncludeFile

$ref: #/$defs/policyFilterIncludeFile

$ref: #/$defs/policyFile

title: Policy File

$ref: #/$defs/filter

title: Policy File

description:
A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.

filters_include_only defines a list of filters that will not be directly converted into an ACL, but can be included by other files.

title: Policy Include File

description:
A policy include file contains a single list of terms. Other policy files can insert this list using the include directive. This file can include other files, but be careful not to exceed the include depth limit of 5.

Each entry in this list is a term and must have a 'name' property defined.

Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.

$ref: #/$defs/term

required: header terms

title: Filter Header

description: The filter header lists the generator target platforms and their options. Other filter-level settings can be defined in the header.

title: Filter Targets

description: aclgen will generate an ACL for each target platforms identified here.

title: Term List

description:
The ACL rules for this filter. Each entry in this list is a term and must have a 'name' property defined.

Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.

title: Filter List Include

description: Common filters shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.

title: Term

title: Include Term List

description: Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.


jsconfig.json

$ref: #/definitions/compilerOptionsDefinition

$ref: #/definitions/compileOnSaveDefinition

$ref: #/definitions/typeAcquisitionDefinition

$ref: #/definitions/extendsDefinition

$ref: #/definitions/watchOptionsDefinition

$ref: #/definitions/buildOptionsDefinition

$ref: #/definitions/filesDefinition

$ref: #/definitions/excludeDefinition

$ref: #/definitions/includeDefinition

$ref: #/definitions/referencesDefinition

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.

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.

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.

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

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

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

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

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

description: Enable verbose logging

markdownDescription:
Enable verbose logging

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

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

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

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

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

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

description: Settings for the watch mode in TypeScript.

description: Specify how the TypeScript watch mode works.

markdownDescription:
Specify how the TypeScript watch mode works.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Specify the output directory for generated declaration files.

markdownDescription:
Specify the output directory for generated declaration files.

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

description: Output compiler performance information after building.

markdownDescription:
Output compiler performance information after building.

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

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

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

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

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

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

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

description: Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output 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: Only output d.ts files and not JavaScript files.

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

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

description: Differentiate between undefined and not present when type checking

markdownDescription:
Differentiate between undefined and not present when type checking

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

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

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

default: .tsbuildinfo

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

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

description: Include sourcemap files inside the emitted JavaScript.

markdownDescription:
Include sourcemap files inside the emitted JavaScript.

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

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

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

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

description: Specify what JSX code is generated.

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

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

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 JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'

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 Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.

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 module specifier used to import the JSX factory functions when using `jsx: react-jsx`.

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: Print all of the files read during the compilation.

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

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

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

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

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

description: Specify what module code is generated.

markdownDescription:
Specify what module code is generated.

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

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

enum: classic node node16 nodenext bundler

default: classic

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

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

description: Set the newline character for emitting files.

enum: crlf lf

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

markdownDescription:
Set the newline character for emitting files.

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

description: Disable emitting file from a compilation.

markdownDescription:
Disable emitting file from a compilation.

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

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

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

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

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

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

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

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

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 when `this` is given the type `any`.

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

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

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

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

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

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

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

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

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

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

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

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

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: Disable strict checking of generic signatures in function types.

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

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

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

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

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

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

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

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

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

description: Specify an output folder for all emitted files.

markdownDescription:
Specify an output folder for all emitted files.

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

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

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

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

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

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

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

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

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

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

description: Disable wiping the console in watch mode

markdownDescription:
Disable wiping the console in watch mode

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

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

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

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

description: Disable emitting comments.

markdownDescription:
Disable emitting comments.

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

description: Specify the root folder within your source files.

markdownDescription:
Specify the root folder within your source files.

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

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

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

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

description: Create source map files for emitted JavaScript files.

markdownDescription:
Create source map files for emitted JavaScript files.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Watch input files.

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.

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling fixedInterval priorityInterval dynamicPriority fixedChunkSize

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

enum: useFsEvents fixedPollingInterval dynamicPriorityPolling fixedChunkSizePolling

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

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling useFsEvents useFsEventsOnParentDirectory fixedChunkSizePolling

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

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

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

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

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

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

description: Disable error reporting for unused labels.

markdownDescription:
Disable error reporting for unused labels.

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Disable error reporting for unreachable code.

markdownDescription:
Disable error reporting for unreachable code.

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

description: Ensure that casing is correct in imports.

markdownDescription:
Ensure that casing is correct in imports.

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

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

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

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

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

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

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

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

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 list of language service plugins to include.

description: Plugin name.

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

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

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

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

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

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

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

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

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

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

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

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

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

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: Disable truncating types in error messages.

markdownDescription:
Disable truncating types in error messages.

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

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

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

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

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

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

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

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

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

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

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

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: Specify a set of bundled library declaration files that describe the target runtime environment.

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

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

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

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

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

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

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: Allow importing helper functions from tslib once per project, instead of including them per-file.

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: Specify emit/checking behavior for imports that are only used for types.

description: Ensure 'use strict' is always emitted.

markdownDescription:
Ensure 'use strict' is always emitted.

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

description: Enable all strict type checking options.

markdownDescription:
Enable all strict type checking options.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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: Allow accessing UMD globals from modules.

markdownDescription:
Allow accessing UMD globals from modules.

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

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

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

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

description: Emit ECMAScript-standard-compliant class fields.

markdownDescription:
Emit ECMAScript-standard-compliant class fields.

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

description: Create sourcemaps for d.ts files.

markdownDescription:
Create sourcemaps for d.ts files.

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

description: Enable importing .json files

markdownDescription:
Enable importing .json files

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

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

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

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

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

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

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

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.

description: Output more detailed compiler performance information after building.

markdownDescription:
Output more detailed compiler performance information after building.

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

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

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

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

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

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

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

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

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

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

description: Enable auto type acquisition

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

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

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

description: Project reference.

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

title: JSON schema for a JavaScript project using TypeScript tooling


$ref: #/definitions/is-parallel-true

description: The hemtt.json or hemtt.toml file is used to configure your HEMTT Project. All examples are done using JSON, but both files support every feature of HEMTT. hemtt.toml will be used if both files are present.

$id: #/properties/name

title: The Name Schema

description: Long name of your project.

$id: #/properties/prefix

title: The Prefix Schema

description: Prefix used for CBA macros and the release directory name.

$id: #/properties/author

title: The Author Schema

description: Author of the project.

$id: #/properties/version

title: The Version Schema

description: HEMTT will look for ```addons/main/script_version.hpp``` and use it for the version number. If you are not using the CBA project structure or do not have that file you can add a version number in the HEMTT project file.

$id: #/properties/files

title: The Files Schema

description: HEMTT will copy the files to the release directory after a successful release build. Supports glob patterns.

$id: #/properties/files/items

title: The Items Schema

$id: #/properties/include

title: The Include Schema

description: HEMTT will include matching relative or absolute paths when building.

$id: #/properties/include/items

title: The Items Schema

$id: #/properties/exclude

title: The Exclude Schema

description: HEMTT will exclude matching files when building.

$id: #/properties/exclude/items

title: The Items Schema

$id: #/properties/optionals

title: The Optionals Schema

description: HEMTT will build the specified addons from the ./optionals folder.

$id: #/properties/optionals/items

title: The Items Schema

examples: tracers particles

title: The Folder_optionals Schema

description: HEMTT will by default build optionals into their own mod folders, which can be directly launched by the user. This can be turned off to build optional PBOs directly into optionals folder.

$id: #/properties/skip

title: The Skip Schema

description: HEMTT will skip building the specified addons.

$id: #/properties/skip/items

title: The Items Schema

examples: hearing zeus

$id: #/properties/headerexts

title: The Headerexts Schema

description: HEMTT will apply specified header extensions to each PBO. Supports templating.

$id: #/properties/headerexts/items

title: The Items Schema

$id: #/properties/modname

title: The Modname Schema

description: HEMTT will use the specified mod name (without @) to form @mod folder. Supports templating.

$id: #/properties/keyname

title: The Keyname Schema

description: HEMTT will use the specified key name for .bikey and .biprivatekey names. Supports templating.

$id: #/properties/signame

title: The Signame Schema

description: HEMTT will use the specified signature name as part of the full signature (.bisign) name. Supports templating.

$id: #/properties/sigversion

title: The Sigversion Schema

description: HEMTT will use the specified signature version. Currently Supported: V2, V3 (Experimental).

title: The Reuse_private_key Schema

description: If set to true, HEMTT will use (and re-use) releases/keys/{keyname}.biprivatekey. It will be generated if it doesn't exist. The default behaviour is to generate a new private key each time and discard it immediately. HEMTT strongly recommends that you only re-use the key if you are making a client-side mod where it will not matter if clients are running different versions of the mod.

$id: #/properties/postbuild

title: The Postbuild Schema

$id: #/properties/postbuild/items

title: The Items Schema

$id: #/properties/prebuild

title: The Prebuild Schema

$id: #/properties/prebuild/items

title: The Items Schema

$id: #/properties/releasebuild

title: The Releasebuild Schema

$id: #/properties/releasebuild/items

title: The Items Schema

$id: #/properties/scripts

title: The Scripts Schema

$id: #/properties/scripts/properties/

title: The  Schema

title: The Steps Schema

title: The Items Schema

examples: echo {{addon}} took {{time}} ms to build.

title: The Steps_linux Schema

description: steps_windows and steps_linux can be used to run different steps on the respective platforms.

title: The Items Schema

title: The Steps_windows Schema

title: The Items Schema

title: The Show_output Schema

description: All output is hidden by default. Setting show_output will display the command being executed and its output.

title: The Foreach Schema

description: Scripts can be ran for each addons. Inside prebuild the script will be ran for each addon that HEMTT will build, including addons that will be skipped if they are already built. Inside postbuild and releasebuild only addons that were successfully built with be used, excluding addons that were skipped for being up to date.

title: The Parallel Schema

description: Requires foreach to be true. If a script is thread safe parallel can be used to process multiple addons at a time.

required: name prefix author

title: The Root Schema


foundryvtt-template.json

description: Array of strings defining the entity subtypes defined by the schema.

description: Template schemas that can be reused by entity subtypes.

description: Definition of a template schema.

description: Custom property defined for this schema.

description: Definition of an entity subtype.

description: Array of strings specifying which template schemas to apply to this type.

$ref: #/definitions/entity

description: The top level data schema for Actor types.

description: The top level data schema for Item types.

title: JSON schema for Foundry VTT template.json files.


bigquery-table.json

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

enum: NULLABLE REQUIRED REPEATED

required: name type

enum: STRUCT RECORD

required: fields type name

$ref: #/definitions/field

description: BigQuery lets you specify a table's schema when you load data into a table or when you create an empty table. A table schema is a JSON file.