description: Configuration that is specific to the Android platform.

description: The manifest for the Android version of your app will be written to this path during publish.

description: The bundle for the Android version of your app will be written to this path during publish.

description: The package name for your Android standalone app. You make it up, but it needs to be unique on the Play Store. See [this StackOverflow question](http://stackoverflow.com/questions/6273892/android-package-name-convention).

description: Version number required by Google Play. Increment by one for each release. Must be a positive integer. [Learn more](https://developer.android.com/studio/publish/versioning.html)

description: The background color for your Android app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.

description: Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.

enum: light dark automatic

description: @deprecated A Boolean value that indicates whether the app should use the new notifications API.

description: Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` key. We recommend that you use a 1024x1024 png file (transparency is recommended for the Google Play Store). This icon will appear on the home screen and within the Expo app.

description: Settings for an Adaptive Launcher Icon on Android. [Learn more](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive)

description: Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` and the `android.icon` keys. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen.

description: Local path or remote URL to a background image for your app's Adaptive Icon on Android. If specified, this overrides the `backgroundColor` key. Must have the same dimensions as  foregroundImage`, and has no effect if `foregroundImage` is not specified. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive).

description: Color to use as the background for your app's Adaptive Icon on Android. Defaults to white, `#FFFFFF`. Has no effect if `foregroundImage` is not specified.

description: URL to your app on the Google Play Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.

description:
List of permissions used by the standalone app.

 To use ONLY the following minimum necessary permissions and none of the extras supported by Expo in a default managed app, set `permissions` to `[]`. The minimum necessary permissions do not require a Privacy Policy when uploading to Google Play Store and are:
• receive data from Internet
• view network connections
• full network access
• change your audio settings
• prevent device from sleeping

 To use ALL permissions supported by Expo by default, do not specify the `permissions` key.

  To use the minimum necessary permissions ALONG with certain additional permissions, specify those extras in `permissions`, e.g.

 `[ "CAMERA", "ACCESS_FINE_LOCATION" ]`.

  You can specify the following permissions depending on what you need:

- `ACCESS_COARSE_LOCATION`
- `ACCESS_FINE_LOCATION`
- `ACCESS_BACKGROUND_LOCATION`
- `CAMERA`
- `RECORD_AUDIO`
- `READ_CONTACTS`
- `WRITE_CONTACTS`
- `READ_CALENDAR`
- `WRITE_CALENDAR`
- `READ_EXTERNAL_STORAGE`
- `WRITE_EXTERNAL_STORAGE`
- `USE_FINGERPRINT`
- `USE_BIOMETRIC`
- `WRITE_SETTINGS`
- `VIBRATE`
- `READ_PHONE_STATE`
- `com.anddoes.launcher.permission.UPDATE_COUNT`
- `com.android.launcher.permission.INSTALL_SHORTCUT`
- `com.google.android.c2dm.permission.RECEIVE`
- `com.google.android.gms.permission.ACTIVITY_RECOGNITION`
- `com.google.android.providers.gsf.permission.READ_GSERVICES`
- `com.htc.launcher.permission.READ_SETTINGS`
- `com.htc.launcher.permission.UPDATE_SHORTCUT`
- `com.majeur.launcher.permission.UPDATE_BADGE`
- `com.sec.android.provider.badge.permission.READ`
- `com.sec.android.provider.badge.permission.WRITE`
- `com.sonyericsson.home.permission.BROADCAST_BADGE`

description: [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. Including this key automatically enables FCM in your standalone app.

description: Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.

description: [Branch](https://branch.io/) key to hook up Branch linking services.

description: Your Branch API key

description: [Google Maps Android SDK](https://developers.google.com/maps/documentation/android-api/signup) configuration for your standalone app.

description: Your Google Maps Android SDK API key

description: [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID.

description: A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Client and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)

description: @deprecated Use `googleServicesFile` instead. [Google Sign-In Android SDK](https://developers.google.com/identity/sign-in/android/start-integrating) keys for your standalone app.

description: The Android API key. Can be found in the credentials section of the developer console or in `google-services.json`.

description: The SHA-1 hash of the signing certificate used to build the APK without any separator (`:`). Can be found in `google-services.json`. https://developers.google.com/android/guides/client-auth

description: Configuration for loading and splash screen for managed and standalone Android apps.

description: Color to fill the loading screen background

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`.

enum: cover contain native

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Natural sized image (baseline)`

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 1.5x`

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 2x`

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 3x`

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 4x`

description: Configuration for setting an array of custom intent filters in Android manifest. [Learn more](https://developer.android.com/guide/components/intents-filters)

description: You may also use an intent filter to set your app as the default handler for links (without showing the user a dialog with options). To do so use `true` and then configure your server to serve a JSON file verifying that you own the domain. [Learn more](developer.android.com/training/app-links)

description: the scheme of the URL, e.g. `https`

description: the hostname, e.g. `myapp.io`

description: the port, e.g. `3000`

description: an exact path for URLs that should be matched by the filter, e.g. `/records`

description: a regex for paths that should be matched by the filter, e.g. `.*`

description: a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`

description: a MIME type for URLs that should be matched by the filter

description: the scheme of the URL, e.g. `https`

description: the hostname, e.g. `myapp.io`

description: the port, e.g. `3000`

description: Allows your user's app data to be automatically backed up to their Google Drive. If this is set to false, no backup or restore of the application will ever be performed (this is useful if your app deals with sensitive information). Defaults to the Android default, which is `true`.

description: Determines how the software keyboard will impact the layout of your application. This maps to the `android:windowSoftInputMode` property. Defaults to `resize`. Valid values: `resize`, `pan`.

enum: resize pan

description: Specifies the JavaScript engine. Supported only on EAS Build. Defaults to `jsc`. Valid values: `hermes`, `jsc`.

enum: hermes jsc

description: the scheme of the URL, e.g. `https`

description: the hostname, e.g. `myapp.io`

description: the port, e.g. `3000`

description: Configuration that is specific to the iOS platform.

description: The manifest for the iOS version of your app will be written to this path during publish.

description: The bundle for the iOS version of your app will be written to this path during publish.

description: The bundle identifier for your iOS standalone app. You make it up, but it needs to be unique on the App Store. See [this StackOverflow question](http://stackoverflow.com/questions/11347470/what-does-bundle-identifier-mean-in-the-ios-project).

description: Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). (Note: Transporter will pull the value for `Version Number` from `expo.version` and NOT from `expo.ios.buildNumber`.)

description: The background color for your iOS app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.

description:
Local path or remote URL to an image to use for your app's icon on iOS. If specified, this overrides the top-level `icon` key. Use a 1024x1024 icon which follows Apple's interface guidelines for icons, including color profile and transparency.

 Expo will generate the other required sizes. This icon will appear on the home screen and within the Expo app.

description: Merchant ID for use with Apple Pay in your standalone app.

description: URL to your app on the Apple App Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.

description: Your Branch API key

description: Sets `ITSAppUsesNonExemptEncryption` in the standalone ipa's Info.plist to the given boolean value.

description: [Google Maps iOS SDK](https://developers.google.com/maps/documentation/ios-sdk/start) key for your standalone app.

description: A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Go and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`.](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)

description: [Google Sign-In iOS SDK](https://developers.google.com/identity/sign-in/ios/start-integrating) keys for your standalone app.

description: The reserved client ID URL scheme. Can be found in `GoogleService-Info.plist`.

description: [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase.

description: Whether your standalone iOS app supports tablet screen sizes. Defaults to `false`.

description: If true, indicates that your standalone iOS app does not support handsets, and only supports tablets.

description: If true, indicates that your standalone iOS app does not support Slide Over and Split View on iPad. Defaults to `true` currently, but will change to `false` in a future SDK version.

description: Dictionary of arbitrary configuration to add to your standalone app's native Info.plist. Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.

description: Dictionary of arbitrary configuration to add to your standalone app's native *.entitlements (plist). Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.

description: An array that contains Associated Domains for the standalone app. [Learn more](https://developer.apple.com/documentation/safariservices/supporting_associated_domains).

description: A boolean indicating if the app uses iCloud Storage for `DocumentPicker`. See `DocumentPicker` docs for details.

description: A boolean indicating if the app uses Apple Sign-In. See `AppleAuthentication` docs for details.

description: A Boolean value that indicates whether the app may access the notes stored in contacts. You must [receive permission from Apple](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes) before you can submit your app for review with this capability.

description: Configuration for loading and splash screen for standalone iOS apps.

description: @deprecated Apple has deprecated `.xib` splash screens in favor of `.storyboard` files. Local path to a XIB file as the loading screen. It overrides other loading screen options. Note: This will only be used in the standalone app (i.e., after you build the app). It will not be used in the Expo Go.

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.

description: Configuration for loading and splash screen for standalone apps.

description: Configuration that is specific to the web platform.

description: Relative path of an image to use for your app's favicon.

description: Defines the title of the document, defaults to the outer level name

description: A short version of the app's name, 12 characters or fewer. Used in app launcher and new tab pages. Maps to `short_name` in the PWA manifest.json. Defaults to the `name` property.

description: Specifies the primary language for the values in the name and short_name members. This value is a string containing a single language tag.

description: Defines the navigation scope of this website's context. This restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it returns to a normal web page inside a browser tab/window. If the scope is a relative URL, the base URL will be the URL of the manifest.

description: Defines the color of the Android tool bar, and may be reflected in the app's preview in task switchers.

description: Provides a general description of what the pinned website does.

description: Specifies the primary text direction for the name, short_name, and description members. Together with the lang member, it helps the correct display of right-to-left languages.

description: Defines the developers' preferred display mode for the website.

enum: fullscreen standalone minimal-ui browser

description: The URL that loads when a user launches the application (e.g., when added to home screen), typically the index. Note: This has to be a relative URL, relative to the manifest URL.

description: Defines the default orientation for all the website's top level browsing contexts.

enum: any natural landscape landscape-primary landscape-secondary portrait portrait-primary portrait-secondary

description: Defines the expected "background color" for the website. This value repeats what is already available in the site's CSS, but can be used by browsers to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded. This creates a smooth transition between launching the web application and loading the site's content.

description: If content is set to default, the status bar appears normal. If set to black, the status bar has a black background. If set to black-translucent, the status bar is black and translucent. If set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar.

description: Hints for the user agent to indicate to the user that the specified native applications (defined in expo.ios and expo.android) are recommended over the website.

description: Experimental features. These will break without deprecation notice.

description: Configuration for PWA splash screens.

description: Firebase web configuration. Used by the expo-firebase packages on both web and native. [Learn more](https://firebase.google.com/docs/reference/js/firebase.html#initializeapp)

description: The name of your app as it appears both within Expo Go and on your home screen as a standalone app.

description: A short description of what your app is and why it is great.

description: The friendly URL name for publishing. For example, `myAppName` will refer to the `expo.io/@project-owner/myAppName` project.

description: The Expo account name of the team owner, only applicable if you are enrolled in the EAS Priority Plan. If not provided, defaults to the username of the current user.

description: The auto generated Expo account name and slug used for display purposes. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value may change when a project is transferred between accounts or renamed.

description: The auto generated Expo account name and slug used for services like Notifications and AuthSession proxy. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value will not change when a project is transferred between accounts or renamed.

description: Defaults to `unlisted`. `unlisted` hides the project from search results. `hidden` restricts access to the project page to only the owner and other users that have been granted access. Valid values: `public`, `unlisted`, `hidden`.

description: The Expo sdkVersion to run the project on. This should line up with the version specified in your package.json.

description: Runtime versions are a property that guarantees compatibility between a build's native code and an update. When a project is made into a build, the build will contain some native code that cannot be changed with an update. Therefore, an update must be compatible with a build's native code to run on the build.

description: Your app version. In addition to this field, you'll also use `ios.buildNumber` and `android.versionCode` — read more about how to version your app [here](https://docs.expo.io/distribution/app-stores/#versioning-your-app). On iOS this corresponds to `CFBundleShortVersionString`, and on Android, this corresponds to `versionName`. The required format can be found [here](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring).

description: Platforms that your project explicitly supports. If not specified, it defaults to `["ios", "android"]`.

description: If you would like to share the source code of your app on Github, enter the URL for the repository here and it will be linked to from your Expo project page.

description: Locks your app to a specific orientation with portrait or landscape. Defaults to no lock. Valid values: `default`, `portrait`, `landscape`

description: The background color for your app, behind any of your React views. This is also known as the root view background color.

description: On Android, this will determine the color of your app in the multitasker. Currently this is not used on iOS, but it may be used for other purposes in the future.

description: Local path or remote URL to an image to use for your app's icon. We recommend that you use a 1024x1024 png file. This icon will appear on the home screen and within the Expo app.

description: Configuration for remote (push) notifications.

description: (Android only) Local path or remote URL to an image to use as the icon for push notifications. 96x96 png grayscale with transparency. We recommend following [Google's design guidelines](https://material.io/design/iconography/product-icons.html#design-principles). If not provided, defaults to your app icon.

description: (Android only) Tint color for the push notification image when it appears in the notification tray. Defaults to `#ffffff`

description: Whether or not to display notifications when the app is in the foreground on iOS. `_displayInForeground` option in the individual push notification message overrides this option. [Learn more.](https://docs.expo.io/push-notifications/receiving-notifications/#foreground-notification-behavior) Defaults to `false`.

description: Show each push notification individually (`default`) or collapse into one (`collapse`).

description: If `androidMode` is set to `collapse`, this title is used for the collapsed notification message. For example, `'#{unread_notifications} new interactions'`.

description: By default, Expo looks for the application registered with the AppRegistry as `main`. If you would like to change this, you can specify the name in this property.

description: Configuration for the status bar on Android. For more details please navigate to [Configuring StatusBar](https://docs.expo.io/guides/configuring-statusbar/).

description: Configures the status bar icons to have a light or dark color. Valid values: `light-content`, `dark-content`. Defaults to `dark-content`

description: Specifies the background color of the status bar. Defaults to `#00000000` (transparent) for `dark-content` bar style and `#00000088` (semi-transparent black) for `light-content` bar style

description: Instructs the system whether the status bar should be visible or not. Defaults to `false`

description: Sets `android:windowTranslucentStatus` in `styles.xml`. When false, the system status bar pushes the content of your app down (similar to `position: relative`). When true, the status bar floats above the content in your app (similar to `position: absolute`). Defaults to `true` to match the iOS status bar behavior (which can only float above content).

description: Configuration for the bottom navigation bar on Android.

description:
Determines how and when the navigation bar is shown. [Learn more](https://developer.android.com/training/system-ui/immersive). Valid values: `leanback`, `immersive`, `sticky-immersive`

 `leanback` results in the navigation bar being hidden until the first touch gesture is registered.

 `immersive` results in the navigation bar being hidden until the user swipes up from the edge where the navigation bar is hidden.

 `sticky-immersive` is identical to `'immersive'` except that the navigation bar will be semi-transparent and will be hidden again after a short period of time

description: Configure the navigation bar icons to have a light or dark color. Supported on Android Oreo and newer. Valid values: `'light-content'`, `'dark-content'`

description: Specifies the background color of the navigation bar.

description: Settings that apply specifically to running this app in a development client

description: If true, the app will launch in a development client with no additional dialogs or progress indicators, just like in a standalone app.

description: **Standalone Apps Only**. URL scheme to link into your app. For example, if we set this to `'demo'`, then demo:// URLs would open your app when tapped.

description: The relative path to your main JavaScript file.

description: Any extra fields you want to pass to your experience. Values are accessible via `Expo.Constants.manifest.extra` ([Learn more](https://docs.expo.io/versions/latest/sdk/constants/#constantsmanifest))

description: @deprecated Use a `metro.config.js` file instead. [Learn more](https://docs.expo.io/guides/customizing-metro/)

description: Configuration for how and when the app should request OTA JavaScript updates

description: If set to false, your standalone app will never download any code, and will only use code bundled locally on the device. In that case, all updates to your app must be submitted through app store review. Defaults to true. (Note: This will not work out of the box with ExpoKit projects)

description: By default, Expo will check for updates every time the app is loaded. Set this to `ON_ERROR_RECOVERY` to disable automatic checking unless recovering from an error. Must be one of `ON_LOAD` or `ON_ERROR_RECOVERY`

description: How long (in ms) to allow for fetching OTA updates before falling back to a cached version of the app. Defaults to 0. Must be between 0 and 300000 (5 minutes).

description: URL from which expo-updates will fetch update manifests

description: Provide overrides by locale for System Dialog prompts like Permissions Boxes

description: Used for all Facebook libraries. Set up your Facebook App ID at https://developers.facebook.com.

description: Whether the Facebook SDK should be initialized automatically. The default in Expo (Client and in standalone apps) is `false`.

description: Whether the Facebook SDK log app events automatically. If you don't set this property, Facebook's default will be used. (Applicable only to standalone apps.) Note: The Facebook SDK must be initialized for app events to work. You may autoinitialize Facebook SDK by setting `facebookAutoInitEnabled` to `true`

description: Whether the Facebook SDK should collect advertiser ID properties, like the Apple IDFA and Android Advertising ID, automatically. If you don't set this property, Facebook's default policy will be used. (Applicable only to standalone apps.)

description: Used for native Facebook login.

description: Used for Facebook native login. Starts with 'fb' and followed by a string of digits, like 'fb1234567890'. You can find your scheme [here](https://developers.facebook.com/docs/facebook-login/ios)in the 'Configuring Your info.plist' section (only applicable to standalone apps and custom Expo Go apps).

description: Is app detached

description: Extra fields needed by detached apps

description: An array of file glob strings which point to assets that will be bundled within your standalone app binary. Read more in the [Offline Support guide](https://docs.expo.io/guides/offline-support/)

description: Config plugins for adding extra functionality to your project. [Learn more](https://docs.expo.io/guides/config-plugins/).

description: Your Branch API key

description: Your Branch API key

description: Your Google Maps Android SDK API key

description: the scheme of the URL, e.g. `https`

description: the hostname, e.g. `myapp.io`

description: the port, e.g. `3000`

description: the scheme of the URL, e.g. `https`

description: the hostname, e.g. `myapp.io`

description: the port, e.g. `3000`

description: Configuration for PWA splash screens.

description: Configuration for scripts to run to hook into the publish process

description: Enable experimental features that may be unstable, unsupported, or removed without deprecation notices.

description: Enables Turbo Modules, which are a type of native modules that use a different way of communicating between JS and platform code. When installing a Turbo Module you will need to enable this experimental option (the library still needs to be a part of Expo SDK already, like react-native-reanimated v2). Turbo Modules do not support remote debugging and enabling this option will disable remote debugging.

description: Sets the JS Engine that will interpret your code

description: Internal properties for developer tools

description: List of plugins already run on the config

title: JSON schema for Expo SDK 46 app manifest


replit.json

description: Command to run REPL

type: string

type: array

description: Language name used in REPL

$comment: List is taken from https://replit.com/talk/learn/How-to-Get-a-List-of-All-Replit-Langauges/34411

enum: clojure haskell kotlin qbasic forth lolcode brainf*** emoticon bloop react_native unlambda javascript babel coffeescript scheme apl lua python ruby roy php python3 nodejs enzyme go java cpp cpp11 c csharp fsharp web_project html rust swift python_turtle basic jest django express sinatra rails rlang nextjs gatsbyjs reactjs reactts reactre flow bash quil polygott crystal julia perl6 elixir nim dart gatsbyjsv2 reason_nodejs tcl erlang typescript ocaml pygame love2d reason Tkinter tkinter java_swing php_server nodejs_prybar elisp php7 sqlite java10 php_cli nodejs_beta pyxel static go_beta nodejs_static python3_beta raku testj wasm java10_beta python_beta html_beta testj_beta scala riddlejs java_maven

description: Enable/disable system-wide audio in REPL

type: boolean

description: Universal Package Manager (UPM) configuration

type: object

description: Command to run on new package install

description: List of ignored path

description: List of ignored packages

description: Language name

enum: python-python3-poetry python-python2-poetry nodejs-npm nodejs-yarn ruby-bundler elisp-cask dart-pub java-maven rlang dotnet rust

description: Universal Package Manager (UPM) features

description: Enable/disable package search panel

description: Enable/disable guessing required packages

description: Language configuration

description: Language configuration

description: Glob for language files

description: Language Server Protocol (LSP) configuration

description: Command to run server

title: Repl.it config schema (.replit)

authors: Emily Grace Seville (https://github.com/EmilySeville7cfg)


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.

type: number

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


title: Red-DiscordBot Сog metadata file

description: List of names of authors of the cog

description: A long description of the cog or repo. For cogs, this is displayed when a user executes [p]cog info.

description: The message that gets displayed when a cog is installed or a repo is added

description: A short description of the cog or repo. For cogs, this info is displayed when a user executes [p]cog list

description: A statement explaining what end user data the cog is storing. This is displayed when a user executes [p]cog info. If the statement has changed since last update, user will be informed during the update.

description: Min version number of Red in the format MAJOR.MINOR.MICRO

description: Max version number of Red in the format MAJOR.MINOR.MICRO, if min_bot_version is newer than max_bot_version, max_bot_version will be ignored

description: Min version number of Python in the format [MAJOR, MINOR, PATCH]

type: integer

description: Determines if a cog is visible in the cog list for a repo.

description: Determines if a cog is available for install.

description: A dict of required cogs that this cog depends on in the format {cog_name : repo_url}. Downloader will not deal with this functionality but it may be useful for other cogs.

description: List of required libraries that are passed to pip on cog install.

description: A list of strings that are related to the functionality of the cog. Used to aid in searching.

description: Optional, defaults to COG. Must be either COG or SHARED_LIBRARY. If SHARED_LIBRARY then hidden will be True.

format: uri


solidaritySchema.json

description: CLI Rule

type: string integer

enum: darwin macos freebsd linux sunos win32 windows

required: rule binary

description: Dir Rule

enum: dir directory

required: rule location

description: File Rule

description: ENV Rule

required: rule variable

description: Shell Rule

description: A regexp to search the output.

required: rule match

description: Custom Rule

description: A regexp to search the output.

required: rule plugin name

description: A rule-set and config for the Solidarity JSON checker

description: Identify what kind output should happen when a check is called

description: List of requirement rules for your particular environment

$ref: #/definitions/cli

$ref: #/definitions/dir

$ref: #/definitions/file

$ref: #/definitions/env

$ref: #/definitions/shell

$ref: #/definitions/custom

title: Solidarity


github-funding.json

description: You can add a sponsor button in your repository to increase the visibility of funding options for your open source project.

title: CommunityBridge

description: Project name on CommunityBridge.

title: GitHub Sponsors

description: Username or usernames on GitHub.

title: IssueHunt

description: Username on IssueHunt.

title: Ko-fi

description: Username on Ko-fi.

title: Liberapay

description: Username on Liberapay.

title: Open Collective

description: Username on Open Collective.

title: Otechie

description: Username on Otechie.

title: Patreon

description: Username on Pateron.

title: Tidelift

description: Platform and package on Tidelift.

title: Custom URL

description: Link or links where funding is accepted on external locations.

type: string array null

format: uri-reference

title: Link

description: Link to an external location.

title: GitHub Funding


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.


bitrise-step.json

$ref: #/definitions/StepModel

$ref: #/definitions/BrewDepModel

$ref: #/definitions/AptGetDepModel

$ref: #/definitions/CheckOnlyDepModel

format: date-time

$ref: #/definitions/StepSourceModel

$ref: #/definitions/DependencyModel

$ref: #/definitions/StepToolkitModel

$ref: #/definitions/DepsModel

$ref: #/definitions/BashStepToolkitModel

$ref: #/definitions/GoStepToolkitModel


title: Mini update manifest

description: Manifest containing metadata of the detached, downloadable, complete update manifest.

$ref: #/definitions/fileId

title: Update manifest file

description: Map of '#/definitions/fileId' to file metadata.

required: detachedManifestFileId files

title: Complete update manifest.

description: Full update manifest containing metadata of the update being deployed.

title: Installation instructions

title: Installation steps

title: Update files

title: Created date & time

description: Date & time update was created in ISO 8601 format.

required: compatibility instructions files createdDateTime

title: Update file id

description: Server generated file identifier to be used for retrieving file metadata and download URL.

title: Inline installation step

description: Installation instruction step that performs code execution.

title: Step update files

description: 'fileId' of update files that agent will pass to handler.

required: handler files

title: Reference installation step

description: Installation instruction step that installs another update.

required: type detachedManifestFileId

description: JSON schema of update manifest sent by Device Update for IoT Hub to device agent during deployment.

Toaster

provider: Microsoft

deviceManufacturer: Microsoft

deviceModel: Toaster

$ref: #/definitions/miniUpdateManifest

$ref: #/definitions/fullUpdateManifest

description: JSON schema reference

title: Update manifest schema version

required: updateId manifestVersion

title: JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0


description: Optional Url type

description: Package moniker or tag

description: A representation of a multiple-file manifest representing app metadata in other locale in the OWC. v1.0.0

description: The package unique identifier

description: The package version

description: The package meta-data locale

description: The publisher name

$ref: #/definitions/Url

description: The publisher home page

description: The publisher support page

description: The publisher privacy page or the package privacy page

description: The package author

description: The package name

description: The package home page

description: The package license

description: The license page

description: The package copyright

description: The package copyright page

description: The short package description

description: The full package description

$ref: #/definitions/Tag

description: The most common package term

description: List of additional package search terms

default: locale

const: locale

description: The manifest type

description: The manifest syntax version

required: PackageIdentifier PackageVersion PackageLocale ManifestType ManifestVersion


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.


title: Installation instructions

description: Update installation instructions.

title: Installation steps

title: Step description

description: Optional instruction step description.

title: Inline installation step

$ref: #/definitions/stepDescription

title: Step update files

description: Names of update files that agent will pass to handler.

title: Reference installation step

required: type updateId

description: Schema for import manifest used for importing an update to Device Update for IoT Hub.

description: Example update

description: pre-install script

description: JSON schema reference.

title: Update description

description: Optional update description.

title: Update files

description: List of update payload files. Sum of all file sizes may not exceed 2 GB. May be empty or null if all instruction steps are reference steps.

title: Import manifest schema version

description: Import manifest schema version. Must be 5.0.

title: Created date & time

description: Date & time import manifest was created in ISO 8601 format.

required: updateId compatibility instructions manifestVersion createdDateTime

title: JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0


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