rust-toolchain.json

description:
A `toolchain` is a complete installation of the Rust compiler (`rustc`) and related tools (like `cargo`). A toolchain specification includes the release channel or version, and the host platform that the toolchain runs on.

 Get more from [`Toolchains`](https://rust-lang.github.io/rustup/concepts/toolchains.html)

description:
`channel` is a named release channel, a major and minor version number such as `1.42`, or a fully specified version number, such as `1.42.0`. Channel names can be optionally appended with an archive date, as in `nightly-2014-12-18`, in which case the toolchain is downloaded from the archive for that date. Get more from [`Toolchain specification`](https://rust-lang.github.io/rustup/concepts/toolchains.html).

Other valid channel like `stable`,`1.63`,`1.63.0`,`nightly-2022-09-20`,`stable-x86_64-pc-windows-msvc`,`1.63.0-riscv64gc-unknown-linux-gnu`,`nightly-2022-09-20-x86_64-unknown-nux-gnu`

description:
Each release of Rust includes several "components", some of
which are required (like `rustc`) and some that are optional (like [`clippy`](https://github.com/rust-lang/rust-clippy))

 Learn more from [`Components`](https://rust-lang.github.io/rustup/concepts/components.html)

enum: rustc cargo rustfmt rust-std rust-docs rls clippy miri rust-src rust rust-analysis llvm-tools rustc-docs rustc-dev rust-analyzer reproducible-artifacts rust-docs-json

enumValues:
The Rust compiler and [Rustdoc].

[rustdoc]: https://doc.rust-lang.org/rustdoc/

enumValues:
[Cargo] is a package manager and build tool.

[cargo]: https://doc.rust-lang.org/cargo/

enumValues:
[Rustfmt] is a tool for automatically formatting code.

[rustfmt]: https://github.com/rust-lang/rustfmt

enumValues:
This is the Rust [standard library]. There is a separate
  `rust-std` component for each target that `rustc` supports, such as
  `rust-std-x86_64-pc-windows-msvc`. See the [Cross-compilation] chapter for
  more detail.

[standard library]: https://doc.rust-lang.org/std/
[cross-compilation]: .https://rust-lang.github.io/rustup/cross-compilation.html

enumValues:
This is a local copy of the [Rust documentation]. Use the
  `rustup doc` command to open the documentation in a web browser. Run `rustup
  doc --help` for more options.

[rust documentation]: https://doc.rust-lang.org/

enumValues:
[RLS] is a language server that provides support for editors and
  IDEs.

[RLS]: https://github.com/rust-lang/rls

enumValues:
[Clippy] is a lint tool that provides extra checks for common
  mistakes and stylistic choices.

[clippy]: https://github.com/rust-lang/rust-clippy

enumValues:
[Miri] is an experimental Rust interpreter, which can be used for
  checking for undefined-behavior.

[miri]: https://github.com/rust-lang/miri/

enumValues:
This is a local copy of the source code of the Rust standard
  library. This can be used by some tools, such as [RLS], to provide
  auto-completion for functions within the standard library; [Miri] which is a
  Rust interpreter; and Cargo's experimental [build-std] feature, which allows
  you to rebuild the standard library locally.

[RLS]: https://github.com/rust-lang/rls
[miri]: https://github.com/rust-lang/miri/
[build-std]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#build-std

enumValues:
Metadata about the standard library, used by tools like
  [RLS].

[RLS]: https://github.com/rust-lang/rls

enumValues:
This contains a linker and platform libraries for building on
  the `x86_64-pc-windows-gnu` platform.

enumValues:
This is an experimental component which contains a
  collection of [LLVM] tools.

[LLVM]: https://llvm.org/

enumValues:
This component contains the compiler as a library. Most users
  will not need this; it is only needed for development *of* tools that link
  to the compiler, such as making modifications to [Clippy].

[clippy]: https://github.com/rust-lang/rust-clippy

$comment: Empty schema to allow for forward compatibility of new components

description:
`rustc` is capable of generating code for many platforms. The `target` specifies the platform that the code will be generated for. By default, `cargo` and `rustc` use the host toolchain's platform as the target. To build for a different `target`, usually the target's standard library needs to be installed first via the `rustup target` command. Or you can run `rustc --print target-list` to list [`"built-in" targets`](https://doc.rust-lang.org/rustc/targets/built-in.html)

 Get more from [`Platform Support`](https://doc.rust-lang.org/rustc/platform-support.html) and [`Targets`](https://doc.rust-lang.org/rustc/targets/index.html)

$comment: Allow arbitary strings for new targets or custom target JSON

$comment: From `rustc +nightly --print target-list` or targets listed in https://doc.rust-lang.org/rustc/platform-support.html

description:
[`Profiles`](https://rust-lang.github.io/rustup/concepts/profiles.htm) are groups of [`components`](https://rust-lang.github.io/rustup/concepts/components.html) you can choose to download while installing a new Rust [`toolchain`](https://rust-lang.github.io/rustup/concepts/toolchains.html).

 The `profiles` available at this time are `minimal`, `default`, and `complete`.

enum: minimal default complete

enumValues:
This profile includes as few components as possible to get a
working compiler (`rustc`, `rust-std`, and `cargo`). It's recommended to use
this component on Windows systems if you don't use local documentation (the
large number of files can cause issues with some Antivirus systems), and in
CI.

enumValues:
This profile includes all of components in the **minimal**
profile, and adds `rust-docs`, `rustfmt`, and `clippy`. This profile will be
used by `rustup` by default, and it's the one recommended for general use.

enumValues:
This profile includes all the components available through
`rustup`. This should never be used, as it includes *every* component ever
included in the metadata and thus will almost always fail. If you are
looking for a way to install devtools such as `miri` or IDE integration
tools (`rls`), you should use the `default` profile and
install the needed additional components manually, either by using `rustup
component add` or by using `-c` when installing the toolchain.

description:
Path to a custom local toolchain. Since a `path` directive directly names a local toolchain, other options
like `components`, `targets`, and `profile` have no effect. `channel`
and `path` are mutually exclusive, since a `path` already points to a
specific toolchain. A relative `path` is resolved relative to the
location of the `rust-toolchain.toml` file.

 Learn more from [`Custom toolchains`](https://rust-lang.github.io/rustup/concepts/toolchains.html#custom-toolchains)

title: Schema for rust-toolchain.toml


KSP-AVC.schema.json

title: Add-on Version Checker file

description: A KSP-AVC version file's content

type: object

description: The display name for the add-on

type: string

description: Location of a remote version file for update checking

format: uri

description: Web address where the latest version can be downloaded

description: The complete or incremental change log for the add-on

description: Populates the CHANGE_LOG field using the file at this url

description: Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified. If the latest release version is not equal to the version in the file, an update notification will not appear.

description: Your GitHub username

description: The name of the source repository

description: Include pre-releases in the latest release search

type: boolean

required: USERNAME REPOSITORY

description: URL to this mod's page on KerbalStuff

description: The version of the add-on

$ref: #/definitions/version

description: Version of KSP that the add-on was made to support

description: Minimum version of KSP that the add-on supports

description: Maximum version of KSP that the add-on supports

description: If true, don't trust KSP-AVC's idea of which game versions are compatible with which other game versions, based on user configuration

description: DO NOT USE, won't work with CKAN; name of a DLL to check for VERSION on the fly

description: DO NOT USE, won't work with CKAN; a list of versions with which this mod is compatible

type: array

description: DO NOT USE, won't work with CKAN; a list of versions with which this mod is incompatible

description: DO NOT USE, won't work with CKAN; if true, don't override properties using the remote version file

description: DO NOT USE, won't work with CKAN; if false, don't override properties using the remote version file

description: Stanza to define file location to check, used by MADLAD

required: NAME VERSION

description: A semantic(?) version

description: Change major version when you make incompatible API changes

type: integer

description: Change minor version when you add functionality in a backwards-compatible manner

description: Change patch version when you make backwards-compatible bug fixes

description: Build informaion

description: definition of the install_loc fields

description: Name of the mod, If not specified, uses the Modname from the .version file

description: Path to the directory, begins below the GameData.  Must be there, but will be empty in most cases

description: Directory where file is

description: filename to be checked.  If not specified, then it checks for the directory only

required: PATH DIRECTORY


minecraft-predicate.json

title: Terms

description: A list of conditions to join using 'or'.

title: Block

description: A block ID.

title: Properties

title: Predicate

description: Predicate applied to the damage source.

description: Test properties of an entity.

title: Entity

description: Specifies the entity to check for the condition.

enum: this killer killer_player

title: Predicate

description: Predicate applied to entity.

$ref: #/definitions/tagsCommonToAllEntities

description: Test the scoreboard scores of an entity.

title: Entity

title: Scores

description: Scores to check. All specified scores must pass for the condition to pass.

type: integer object

$ref: #/definitions/integerRange

description: Inverts condition from parameter term.

title: Term

description: The condition to be negated.

description: Test if a killer_player entity is available.

title: Inverse

description: If true, the condition passes if killer_player is not available.

description: Checks if the current location matches.

title: Offset X

description: Offsets to location.

title: Offset Y

description: Offsets to location.

title: Offset Z

description: Offsets to location.

title: Predicate

description: Predicate applied to location.

$ref: #/definitions/tagsCommonToAllLocations

description: Checks tool.

title: Predicate

description: Predicate applied to item.

$ref: #/definitions/tagsCommonToAllItems

description: Test if a random number 0.0–1.0 is less than a specified value.

title: Chance

description: Success rate.

type: number

description: Test if a random number 0.0–1.0 is less than a specified value, affected by the level of Looting on the killer entity.

title: Chance

description: Base success rate.

title: Looting Multiplier

description: Looting adjustment to the base success rate. Formula is chance + (looting_level * looting_multiplier).

description: Test if another referred condition (predicate) passes.

title: Name

description: The namespaced ID of the condition (predicate) referred to. A cyclic reference causes a parsing failure.

description: Returns true with 1/explosion radius probability.

description: Passes with probability picked from table, indexed by enchantment level.

title: Enchantment

description: Id of enchantment.

title: Chances

description: List of probabilities for enchantment level, indexed from 0.

description: Checks the current time.

title: Value

description: The time value in ticks.

title: Period

description: Time gets modulo-divided by this value (for example, if set to 24000, value operates on a time period of daytime ticks just like /time query daytime).

description: Checks for a current weather state.

title: Raining

description: If true, the condition evaluates to true only if it's raining or thundering.

title: Thundering

description: If true, the condition evaluates to true only if it's thundering.

description: Checks for range of value.

title: Value

description: The value to test.

$ref: #/definitions/numberProvider

title: Range

title: Max

description: The max value.

title: Minimum

description: The minimum value.

title: Max

description: The max value.

title: Minimum

description: The minimum value.

title: Type

description: The number provider type.

enum: minecraft:constant minecraft:uniform minecraft:binomial minecraft:score

description: A constant value.

title: Value

description: The exact value.

description: A random number following a uniform distribution between two values (inclusive).

title: Minimum

description: The minimum value.

type: number object

title: Max

description: The maximum value.

description: A random number following a binomial distribution.

title: n

description: The amount of trials.

title: p

description: The probability of success on an individual trial.

description: A scoreboard value.

title: Target

description: Scoreboard name provider.

type: string object

title: Type

description: Resource location.

enum: fixed context

const: fixed

title: Name

description: A UUID or player name.

const: context

title: Target

title: Score

description: The scoreboard objective.

title: Scale

description: Scale to multiply the score before returning it.

title: Enchantment

title: Enchantment

description: An enchantment ID.

title: Levels

description: The level of the enchantment.

title: Bypasses Armor

description: Checks if the damage bypassed the armor of the player (suffocation damage predominantly).

title: Bypasses Invulnerability

description: Checks if the damage bypassed the invulnerability status of the player (void or /kill damage).

title: Bypasses Magic

description: Checks if the damage was caused by starvation.

title: Direct Entity

description: The entity that was the direct cause of the damage.

title: Is Explosion

description: Checks if the damage originated from an explosion.

title: Is Fire

description: Checks if the damage originated from fire.

title: Is Magic

description: Checks if the damage originated from magic.

title: Is Projectile

description: Checks if the damage originated from a projectile.

title: Is Lightning

description: Checks if the damage originated from lightning.

title: Source Entity

description: Checks the entity that was the source of the damage (for example: The skeleton that shot the arrow).

title: Count

description: The amount of the item.

title: Durability

description: The durability of the item.

title: Enchantments

description: List of enchantments.

$ref: #/definitions/enchantments

title: Stored Enchantments

description: List of stored enchantments.

title: Items

description: List of item IDs.

title: NBT

description: An NBT string.

title: Potion

description: A brewed potion ID.

title: Tag

description: An item data pack tag.

title: Biome

description: The biome the entity is currently in.

title: Block

description: The block at the location.

title: Blocks

description: A list of block IDs.

title: Tag

description: The block tag.

title: NBT

description: The block NBT.

title: State

description: A map of block property names to values. Test will fail if the block doesn't match.

title: Key

description: Block property key and value pair.

type: boolean integer string object

title: Dimension

description: The dimension the entity is currently in.

title: Feature

description: Name of a structure.

title: Fluid

description: The fluid at the location.

title: Fluid

description: The fluid ID.

title: Tag

description: The fluid tag.

title: State

description: A map of fluid property names to values. Test will fail if the fluid doesn't match.

title: Light

description: The light at the location.

title: Light

description: The light Level of visible light. Calculated using: (max(sky-darkening,block)).

title: Position

title: X

description: The X position.

title: Y

description: The Y position.

title: Z

description: The Z position.

title: Smokey

description: True if the block is closely above a campfire or soul campfire.

title: Distance

title: Absolute

title: Horizontal

title: X

title: Y

title: Z

title: Effects

description: A map of status effects.

title: Effect

description: A status effect with the key name being the status effect name.

title: Ambient

description: Whether the effect is from a beacon.

title: Amplifier

description: The effect amplifier.

title: Duration

description: The effect duration in ticks.

title: Visible

description: Whether the effect has visible particles.

title: Equipment

title: Mainhand

title: Offhand

title: Head

title: Chest

title: Legs

title: Feet

title: Flags

description: Predicate Flags to be checked.

title: Is on Fire

description: Test whether the entity is or is not on fire.

title: Is Sneaking

description: Test whether the entity is or is not sneaking.

title: Is Sprinting

description: Test whether the entity is or is not sprinting.

title: Is Swimming

description: Test whether the entity is or is not swimming.

title: Is Baby

description: Test whether the entity is or is not a baby variant.

title: Lightning Bolt

description: Lightning bolt properties to be checked. Fails when entity is not a lightning bolt.

title: Blocks Set on Fire

description: Number of blocks set on fire by this lightning bolt.

title: Entity Struck

description: Entity properties of entities struck by this lightning bolt. If present, this tag must match one or more entities.

title: Location

title: NBT

description: An NBT string.

title: Passanger

description: The entity directly riding this entity.

title: Player

description: Player properties to be checked. Fails when entity is not a player.

title: Looking At

description: The entity that the player is looking at, as long as it is visible and within a radius of 100 blocks.

title: Advancements

description: A map of advancements to check.

description: An advancement ID.

title: Game Mode

description: The game mode of the player.

title: Level

description: The level of the player.

title: Recipies

description: A map of recipies to check.

title: Stats

description: List of statistics to match.

title: Type

description: The statistic base.

enum: minecraft:custom minecraft:crafted minecraft:used minecraft:broken minecraft:mined minecraft:killed minecraft:picked_up minecraft:dropped minecraft:killed_by

title: Stat

description: The statistic ID. Mostly mimics the criteria used for defining scoreboard objectives.

title: Value

description: The value of the statistic.

title: Stepping On

description: Location predicate for the block the entity is standing on.

title: Team

description: The team the entity belongs to.

title: Type

description: An entity ID.

title: Targeted Entity

description: The entity which this entity is targeting for attacks.

title: Vehicle

description: The vehicle that the entity is riding on.

description: Configuration file defining a predicate for a data pack for Minecraft.

title: Conditions

description: The condition's ID.

title: Minecraft Data Pack Predicate


$ref: #/definitions/dependencies

$ref: #/definitions/compilationOptions

default: default

enum: default build

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

enum: project package

type: string array

description:
A command line script or scripts.

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

description: Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }

description: Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

default: bin/** obj/** **/*.xproj

description: Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.

description: Copyright details for the package.

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.

description: A link to the license for the package.

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.

description: A URL for the home page of the package.

description: A short description of the package.

description: A space-delimited list of tags and keywords that describe the package.

description: The human-friendly title of the package

description: A description of the changes made in each release of the package.

description: The locale ID for the package, such as en-us.

description: The description of the project/package.

$ref: #/definitions/configType

description: Overrides the generated resource names with custom ones.

description: Contains information about the repository where the project is stored.

default: git

description: Scripts to execute during the various stages.

$ref: #/definitions/script

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*

description: Specifies the web server root for the application. In Visual Studio when running IIS this folder will be used as the root of the application. Static files should be put in here.

title: JSON schema for DNX project.json files


postcssrc.json

description: A special syntax parser (for example, SCSS).

description: A special syntax output generator (for example, Midas).

description: An object providing a syntax parser and a stringifier.

description: Source map options.

description: The input file name (most runners set it automatically).

description: The output file name (most runners set it automatically).

description: An array of plugins.

$ref: #/definitions/ConfigPlugin

description: An object of options.


venvironment-basic-schema.json

title: venvironment-basic schema

title: venvironment-basic schema

title: venvironment-basic schema

title: venvironment-basic schema

title: venvironment-basic schema

title: Version

description: Json schema version for the vEnvironment-Basic configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.

title: Include files

description: Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.

title: Global Settings

description: Global settings for all scenarios.

description:
Time source for the simulation. Operate without hardware and simulate all buses completely.
'internal-realtime': The time response of the measurement (time basis) is controlled internally.
'external-software': The time response of the measurement (time basis) is controlled by an external program.

default: internal-realtime

enum: internal-realtime external-software

examples: internal-realtime external-software

time-source: internal-realtime

title: System Variables

description: A lists of system variables to be used by the simulation.

title: Datasources

description: The definition of datasources used by application models.

title: User Files

description: List of user files.

title: Functional mockup units

description: List of functional mockup units.

title: SIL Kit

description: SIL Kit settings.

description: The URI of the registry.

description: Name used by the simulation tool to join a simulation as a participant at the start of a measurement.

description: Time length of a single simulation step. Valid only for the time-source "external-software".

description: Maximum waiting time for the other simulation participants. Valid only for the time-source "external-software".

title: Logging Block

description: Configuration of the logging for the environment.

default: application-layer bus diagnostic internal statistic system-variable test

title: Version

title: Global Settings

description: Global settings for all scenarios.

title: Version

title: Functional mockup units

description: List of functional mockup units.

title: SIL Kit

description: SIL Kit settings.

description: registry URI

description: Name used by CANoe4SW to join a simulation as a participant at the start of a measurement.

title: Logging Block

description: Configuration of the standalone logging block.

title: Version

title: Include files

title: System variables

description: Absolute or relative path to an external file containing system variables. Relative path specifications are resolved relative to the defining configuration file.

title: User files

description: Absolute or relative path to user files that can be read/written by CAPL/.NET Scripts. Relative path specifications are resolved relative to the defining configuration file.

description: Step size in seconds.

description: Is the debug output active.

description: List of the FMU variables which should be exported

description: List of the FMU variables which should be excluded from the export

title: Functional mockup unit

description: Represents a functional mockup unit used in a scenario.

required: file-path stepsize-in-sec

description: Absolute or relative path to a SIL Kit config file (.yaml or .json). Relative path specifications are resolved relative to the configuration file.

description: Name of a blf file, supporting the field codes: {ComputerName}, {LocalTime}, {MeasurementIndex}, {MeasurementStart}, {IncSize|001|100MB} and {IncTime|001|01h00m}.

description: Advanced logging configurations.

description: step size in seconds

description: Are the debug outputs on

title: Functional mockup unit

description: Advanced logging configurations

description: Absolute or relative path to a vsysvar file. Relative path specifications are resolved relative to the configuration file.

description: Reference to external datasource files (.vcdl/.vcodm). Absolute or relative path. Relative path specifications are resolved relative to the defining configuration file.

description: Absolute or relative path to a source file of a functional mockup unit (.fmu). Relative path specifications are resolved relative to the defining configuration file.

title: venvironment-basic schema


meta-schema.json

title: Meta

$id: #root/workspace

title: Workspace

title: Product name

title: Product ID

format: uuid

title: Authentication proxy

title: GitLab groups for workspace

title: GitLab groups for product name


description: The prefixes of your source imports. Ex: import sth from '@data' => '@' can considered as a sourcePrefix

description: The prefix of your section title

description: The names (which comes right after 'sectionPrefix') of your section title

description: The sign to mark the start of import block. Default is '' - the start of the file

description: The sign to mark the end of import block. Default is '' - the first empty line

description: The sign to mark the end of an import statement. Default is ';'

description: The command list run before sorting

description: string value means terminal command

description: Define command with vscode command option

description: the command you need to execute before sorting. It can be terminal command or vscode command

description: Define the system will execute the command

default: terminal

description: Command will be executed as vscode command

description: Command will be executed as terminal command

title: JSON schema for ES6 Import Sorter


grunt-clean-task.json

$ref: #/definitions/options

description: Set the options for grunt-contrib-copy

description: This overrides this task from blocking deletion of folders outside current working dir (CWD). Use with caution.

description: Will log messages of what would happen if the task was ran but doesn't actually delete the files.

title: JSON schema for the Grunt clean task


$comment: JSON Schema for CRYENGINE 5.2

title: Variable name

description: CVar name

title: Command name

description: Console command name

$ref: #/definitions/cvars

title: Value of the CVar

description: The default value of the CVar

required: name value

title: Assets folder

description: This indicates where the assets are stored

default: Assets

title: Code folder

description: This indicates where the code is stored

default: Code

title: Lib's name

title: Lib's name to import for all the supported platforms

title: Lib's name to import for the win_x64 platform

title: Lib's name to import for the win_x86 platform

title: Project name

description: This indicates the project name

title: Project GUID

title: Engine version

description: This indicates which engine version will be used

title: Plugin name

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby

title: Plugin type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one

title: This plugin will be used only by these platforms

enum: pc ps4 xboxone linux

required: path type

title: Project version

$ref: #/definitions/commands

title: Value of the command

description: Arguments that has to be passed to the command. Leave empty if it has not parameters

required: content info require version

title: CryProj schema


mason-registry.json

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

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

enum: Compiler DAP Formatter LSP Linter Runtime

description: List of platforms supported by the cargo package.

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

description: List of platforms supported by the gem package.

required: id download

required: id build

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

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

required: id asset

required: constraint asset

required: target file

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

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

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

description: List of platforms supported by the pypi package.

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

description: Schema for package definitions.

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

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

description: A URL to the package's homepage.

required: name description homepage licenses languages categories source

title: Mason Registry package schema


bitbucket-pipelines.schema.json

description: Name of the Docker image which may or may not include registry URL, tag, and digest value

description: Overrides image's default user, specified user UID must be an existing user in the image with a valid home directory

description: Username to use to fetch the Docker image

description: Password to use to fetch the Docker image

description: Email to use to fetch the Docker image

required: name username password

description: AWS access key for Amazon Elastic Container Registry (AWS ECR)

description: AWS secret key for Amazon Elastic Container Registry (AWS ECR)

required: access-key secret-key

description: Provides Pipeline with access to private Docker images hosted in an Amazon Elastic Container Registry (AWS ECR)

required: aws name

description: Maximum amount of minutes a step can execute

description: Multiplier of the resources allocated to a pipeline step

description: Contains settings to clone the repository into a container

description: Enables cloning of the repository before a step in a pipeline

description: Enables the download of LFS files in the clone (supported only for Git repositories)

description: Depth of Git clone (supported only for Git repositories)

const: full

description: Disables SSL verification during git clone, allowing the use of self-signed certificates

description: Files produced by a step to share with a following step

description: Glob pattern for the path to the artifacts

description: Enables downloading of all available artifacts at the start of a step

description: Any label assigned to a self-hosted repository or workspace Pipeline runner

enum: automatic manual

default: automatic

description: Condition on the changesets involved in a pipeline

description: Condition which holds only if any of the modified files match any of the defined patterns

description: Glob pattern to match the file path

description: Build execution unit

description: Commands to execute after the step succeeds or fails

description: Caches enabled for the step

description: Name of the cache

$ref: #/definitions/condition

description: Condition to execute the step

description: Type of environment for the deployment step, used in the Deployments dashboard

description: A flag reflecting whether other steps in a parallel group should be force stopped if this step fails

$ref: #/definitions/image

description: Name of the step

description: Enable the use of OpenID Connect to connect a pipeline step to a resource server

description: List of labels assigned to Pipeline runner

description: Commands to execute in the step

description: Services enabled for the step

description: Name of the service

$ref: #/definitions/size

$ref: #/definitions/trigger

description: Specifies if a step runs automatically or only when manually triggered by a user

description: Condition to execute the stage

description: Type of environment for the deployment stage, used in the Deployments dashboard

description: Name of the stage

description: List of steps in a stage

$ref: #/definitions/step

description: Specifies if the stage runs automatically or only when manually triggered by a user

description: Set of steps to run concurrently

$ref: #/definitions/stage

description: A flag reflecting whether all steps in a parallel group should be force stopped if any of its steps fails.

description: Command to execute

$ref: #/definitions/pipe

description: Pipe to execute

description: Pipe identifier

description: Environment variables passed to the pipe

description: Variable value

description: Array variable item value

description: Path to the directory to be cached, can be absolute or relative to the clone directory

description: Cache definition declaring a set of files as a key and path to the directory to be cached

description: Cache key definition

description: Path to a file or glob pattern of files in the repository which form the cache key

required: key path

description: Defines resources used elsewhere in the pipeline configuration

description: Defines custom caches to be used by pipelines

description: Defines services that run in separate Docker containers

description: Memory limit for the service container, in megabytes

description: Environment variables passed to the service container

description: A flag to add Docker to all build steps in all pipelines

description: Branch-specific build pipelines

description: Pipelines that can only be triggered manually or scheduled from the Bitbucket Cloud interface

description: List of variables for the custom pipeline

description: Name of a variable for the custom pipeline

description: Default value for the variable, used unless the value is manually set when the pipeline is run

description: A list of values that are allowed for the variable

description: Allowed value for the variable

description: Description of the variable

description: Pull-request-specific build pipelines

description: Tag-specific build pipelines


base.json

$id: nullable-array

$id: nullable-boolean

$id: nullable-integer

$id: nullable-number

$id: nullable-object

$id: nullable-string

$id: path

$id: nullable-path

$ref: #/definitions/path

$id: editor

$id: nullable-editor

$ref: #/definitions/editor

$id: timezone

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Nuuk America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Chile/Continental Chile/EasterIsland Cuba Egypt Eire Etc/GMT Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich GB GB-Eire Hongkong Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya Mexico/BajaNorte Mexico/BajaSur Mexico/General Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kanton Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC ROC Singapore US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa

$id: nullable-timezone

$ref: #/definitions/timezone

title: Common types for all schemas


helmfile.json

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

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

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

$ref: #/definitions/hook

$ref: #/definitions/map

$ref: #/definitions/missingFileHandler

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

required: name chart

enum: Error Warn Info Debug

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

description: The list of environments managed by helmfile.

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

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

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

title: Helmfile config schema


bettercodehub.json

enum: csharp cpp go groovy java javascript objectivec perl php python ruby scala script solidity swift typescript kotlin

title: Exclude

title: Pattern

description: A regular expression for the path(s) to exclude.

title: Include

title: Pattern

description: A regular expression for the path(s) to include.

$ref: #/definitions/excludeFileFilter

description: Configuration file for Better Code Hub to override the default configuration.

title: Component Depth

title: Languages

title: Name

title: Production

$ref: #/definitions/fileFilter

title: Test

title: Better Code Hub


netlify.json

$ref: #/definitions/fields

description: label for the collection in the editor UI; defaults to the value of name

description: singular label for certain elements in the editor; defaults to the value of label

description:
Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository.
Note: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection "must have a field that is a valid entry identifier".

$ref: #/definitions/files

description: Path

description: determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.

enum: yml yaml toml json frontmatter yaml-frontmatter toml-frontmatter json-frontmatter

description:
For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).

Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}}
{{slug}}: a url-safe version of the title field (or identifier field) for the file
{{year}}: 4-digit year of the file creation date
{{month}}: 2-digit month of the file creation date
{{day}}: 2-digit day of the month of the file creation date
{{hour}}: 2-digit hour of the file creation date
{{minute}}: 2-digit minute of the file creation date
{{second}}: 2-digit second of the file creation date

description: for folder collections only; allows users to create new items in the collection

description: hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.

description: prevents users from deleting items in a collection; defaults to true

description: unique identifier for the collection, used as the key when referenced in other contexts

description: optional filter for folder collections

description: optional text, displayed below the label when viewing a collection

description: the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items

description: The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.

description: unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)

description: label for the field in the editor UI; defaults to the value of name

$ref: #/definitions/widget

description: specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type.

description: makes a field required; defaults to true

description: add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)

description: Defaults to True

description: optionally add helper text directly below a widget.

description: add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets

description: unique identifier for the file

description: file label

description: unique filepath (relative to the base of the repo).

description: Config file for Netlify CMS

description: specifies how to access the content for your site, including authentication

description: Set this property to connect Netlify to a local Git repo instead of a live one

description: specifies the folder path where uploaded files should be saved, relative to the base of the repo.

description: specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included.

description: Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.

description: should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content.

description:
When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).
Defaults to site_url.

description: Logo at the top of the login page. Assumed to be a URL to an image file

default: en

description: shows Deploy Preview Links

description:
For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).

The slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.

Available template tags:

Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}}
{{slug}}: a url-safe version of the title field (or identifier field) for the file
{{year}}: 4-digit year of the file creation date
{{month}}: 2-digit month of the file creation date
{{day}}: 2-digit day of the month of the file creation date
{{hour}}: 2-digit hour of the file creation date
{{minute}}: 2-digit minute of the file creation date
{{second}}: 2-digit second of the file creation date

description:
unicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.
ascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).

enum: unicode ascii

default: unicode

description: Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding.

description: The replacement string used to substitute unsafe characters; defaults to -

description: The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.

$ref: #/definitions/collectionItems

description: This setting changes options for the editor view of the collection. It has one option so far: preview

description: Enable preview pane for this collection; defaults to true

description:
This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field
Template tags are the same as those for slug, with the following additions:

{{filename}} The file name without the extension part.
{{extension}} The file extension.
{{commit_date}} The file commit date on supported backends (git based backends).
{{commit_author}} The file author date on supported backends (git based backends).

description:
An optional list of sort fields to show in the UI.
Defaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.
When author field can't be inferred commit author will be used.

description:
An optional list of predefined view filters to show in the UI.
Defaults to an empty list.

required: backend media_folder collections

title: Netlify config schema


reference.json

title: ServerlessFrameworkConfiguration

description: Schema for serverless framework configuration files

$comment: You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.

$comment: The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.

$comment: Use a transform to simplify template authoring for serverless applications.

enum: HEADER AUTHORIZER

description: Optional binary media types the API might return

description: Disable the default 'execute-api' HTTP endpoint (default: false)

description: Can be used to disable the API key without removing it (default: true)

description: Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.

$ref: #/definitions/AwsDestinations

$ref: #/definitions/AwsEnvironment

$ref: #/definitions/AwsEvent

description: Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers

type: string number

$ref: #/definitions/AwsTags

$ref: #/definitions/AwsVpc

description: Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently

description: Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work

$ref: #/definitions/AwsOrigin

description: Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda

description: Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.

description: On deployment, serverless prunes artifacts older than this limit (default: 5)

description: Name of an existing bucket to use (default: created by serverless)

description: Skip the creation of a default bucket policy when the deployment bucket is created (default: false)

description: Enable bucket versioning (default: false)

title: AwsEventBridge

description: Aws Lambda function Eventbridge event source

enum:
ANY /
GET /
POST /
PUT /
PATCH /
OPTIONS /
HEAD /
DELETE /
ANY /{proxy+}
GET /{proxy+}
POST /{proxy+}
PUT /{proxy+}
PATCH /{proxy+}
OPTIONS /{proxy+}
HEAD /{proxy+}
DELETE /{proxy+}

title: AwsHttpIamAuthorizerShort

description: AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers

title: AwsHttpIamAuthorizer

title: AwsHttpCognitoAuthorizer

description: The arn of the cognito user pool

description: The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name

title: AwsHttpLambdaAuthorizer

description: The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`

title: AwsHttpExistingAuthorizer

description: Use an existing Api Gateway Authorizer created outside or in the same stack

description: The Id of the existing authorizer

title: AwsProvider

description: Configuration for Serverless AWS

description: Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)

description: URI of an existing Docker image in ECR

description: Path to the Docker context that will be used when building that image locally (default: '.')

description: Dockerfile that will be used when building the image locally (default: 'Dockerfile')

description: Change this to use a custom name for the API Gateway API

description: Note: API Gateway has a maximum timeout of 30 seconds

description: Use function versioning (enabled by default)

description: Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method

description: Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.

title: ServerlessFrameworkResourceConfiguration

description: Serverless Framework Additional Resources Configuration

title: AwsRestApiLogs

description: This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition

description: **@deprecated and doesn't work in serverless framework v3**

title: ServerlessServiceConfiguration

description: Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html

description: Enables HTTP access logs (default: true)

description: Enable execution logging (default: true)

description: Log full requests/responses for execution logging (default: true)

title: LocalPlugin

description: The path to the local .js file that contains the plugin


compile-commands.json

description: The working directory of the compilation. All paths specified in the command or file fields must be either absolute or relative to this directory.

description: The main translation unit source processed by this compilation step. This is used by tools as the key into the compilation database. There can be multiple command objects for the same file, for example if the same source file is compiled with different configurations.

description: The compile command executed. After JSON unescaping, this must be a valid command to rerun the exact compilation step for the translation unit in the environment the build system uses. Parameters use shell quoting and shell escaping of quotes, with '"' and '\' being the only special characters. Shell expansion is not supported.

description: The compile command executed as list of strings.

description: The name of the output created by this compilation step. This field is optional. It can be used to distinguish different processing modes of the same input file.

required: directory file command

required: directory file arguments

description: Describes a format for specifying how to replay single compilations independently of the build system

$ref: #/definitions/commandObject

title: LLVM compilation database


typings.json

description: The entry point to the definition (canonical to `"main"` in NPM's `package.json`).

description: A string, or map of paths, to override during resolution. See spec: https://github.com/defunctzombie/package-browser-field-spec

type: object string

description: The semver range this definition is typed for

description: Homepage url of the source package

description: Map of resolutions to install

description: Used as an alternative or to complement `main`, specify an array of files that are exported but aren't already part of the resolution from `main`.

description: Denote that this definition _must_ be installed as global.

description: A message to emit to users after typings installation.

description: The name of the definition

description: A map of dependencies required by the project.

description: A map of dependencies required by the project during development.

description: A map of dependencies expected in the parent project for this dependency to work.

description: A map of global dependencies required by the project.

description: A map of global dependencies required by the project during development.

title: JSON schema for Typings TypeScript definitions manager


markdown-lint-check.json

required: pattern replacement


zinoma-schema.json

title: Project

description:
Schema of the build flow configuration file `zinoma.yml`.

In order to use Žinoma with your project, you need to create a file named `zinoma.yml`. We recommend putting this file in the root directory of your project.

This struct describes the schema expected for this file. It assumes prior knowledge of the Yaml format.

__Example__

`zinoma.yml`:

```yaml targets: download_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install

test: input: - download_dependencies.output - paths: [package.json, src, test] build: npm test

lint: input: - download_dependencies.output - paths: [package.json, src, test] build: npm run lint

check: dependencies: [test, lint]

start: input: - download_dependencies.output - paths: [package.json, src] service: exec npm run start

build: dependencies: [check] input: - paths: - Dockerfile - package.json - package-lock.json - src output: - paths: [lambda.zip] build: | docker build -t build-my-project:latest . docker create -ti --name build-my-project build-my-project:latest bash docker cp build-my-project:/var/task/lambda.zip ./ docker rm -f build-my-project ```

In this example:

- `zinoma check` will ensure the code complies to the test suites and the coding standards. - `zinoma start --watch` will run the application and restart it whenever the sources are updated. - `zinoma --clean build` will generate a clean artifact, ready to be deployed.

A fully functional and more advanced example project is available in [fbecart/zinoma-node-example](https://github.com/fbecart/zinoma-node-example).

description:
Import definitions from other Žinoma projects.

`imports` should be an object, the keys being the project names and the values their respective paths.

Before importing a project, you should make sure this project has its name defined. You should use the same name as key in the `imports` object.

Once a project is imported, targets from that project can be referenced by specifying their fully qualified name: `imported_project_name::target_name`.

__Example__

`packages/api/zinoma.yml`:

```yaml name: api

targets: test: build: cargo test ```

`packages/webapp/zinoma.yml`:

```yaml name: webapp

targets: test: build: cargo test ```

`./zinoma.yml`:

```yaml imports: api: packages/api webapp: packages/webapp

targets: test_all: dependencies: [api::test, webapp::test] ```

In this example, the target `test_all` depend from targets defined in different projects.

description:
Name of the project.

A project name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.

Project names should be unique. Two projects cannot have the same name.

__Example__

```yaml name: my_project ```

description:
Targets (aka tasks) of this project.

[`Targets`] represent commands and scripts to execute in your build flow.

[`Targets`]: struct.Target.html

Targets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.

[`dependencies`]: enum.Target.html#variant.Build.field.dependencies

Each target must have a unique name inside the project. The target name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.

__Example__

```yaml targets: speak_cow: build: echo 'Moo' speak_dog: build: echo 'Woof!' ```

In this example:

- `zinoma speak_cow` will print `Moo` - `zinoma speak_dog` will print `Woof!` - `zinoma speak_cow speak_dog` will print both `Moo` and `Woof!` (not necessarily in this order)

$ref: #/definitions/Target

description:
List of [`targets`] that must complete successfully before this target can be built.

[`targets`]: enum.Target.html

It should be an array of strings.

If any of the dependencies fails to complete, this target will not be executed.

__Example__

```yaml targets: target1: dependencies: [] target2: dependencies: [target1] target3: dependencies: [target2] ```

In this example, `target1` must complete successfully before `target2` begins, while `target3` waits for `target2` to complete.

`zinoma target2` will run sequentially `target1` and `target2`.

`zinoma target3` will run sequentially `target1`, `target2` and `target3`.

description:
Output resources of another target.

It should be a string with the format `<project_name>::<target_name>.output`. If the other target is located in the same project, the project name can be skipped. The `input` would then have this format: `<target_name>.output`.

When such an input is used:

- all the output resources of the other target become input resources for this target; - the other target implicitly becomes a dependency to this target.

__Example__

```yaml targets: node_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install

compile: input: - node_dependencies.output - paths: [package.json, tsconfig.json, src] output: - paths: [dist] build: tsc

run: input: - node_dependencies.output - paths: [package.json] - compile.output service: node dist/index.js ```

description:
Filter files resource by file extensions.

It should be an array of strings.

If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.

__Example__

```yaml targets: fmt: input: - paths: [src, tests] extensions: [rs] build: exec cargo fmt --all -- --check

description:
Paths to files or directories.

It should be an array of strings.

Each element of the array should be a path to a file or directory.

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

description:
Shell script whose output identifies the state of a resource.

It should be a string.

__Example__

```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format "{{.ID}}"' output: - cmd_stdout: 'docker image ls webapp:latest --format "{{.ID}}"' build: docker build -t webapp . ```

description:
List of artifacts that this target depends on.

`input` should be an array of [`resources`].

[`resources`]: enum.InputResource.html

Specifying a target's `input` enables the incremental build for this target. This means that, at the time of executing the target, Žinoma will skip its build if its input resources (and [`output`] resources, if any) have not changed since its last successful completion.

[`output`]: struct.OutputResources.html

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] build: npm install ```

In this example, running `zinoma npm_install` once will execute `npm install`. Subsequent runs of `zinoma npm_install` will return immediately — until the content of `package.json` or `package-lock.json` is modified.

$ref: #/definitions/InputResource

description:
Filter files resource by file extensions.

It should be an array of strings.

If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.

__Example__

```yaml targets: protoc: input: - paths: [protos] extensions: [proto] output: - paths: [protos] extensions: [go] build: | cd protos docker run -v `pwd`:/defs namely/protoc-all -d . -o . -l go

description:
Paths to files or directories.

It should be an array of strings. Each element of the array should be a path to a file or directory.

If the `--clean` flag is provided to `zinoma`, the files or directories specified in `paths` will be deleted before running the build flow.

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

In this example, as the target specifies an `input`, `zinoma npm_install` is incremental. The script `npm install` will be skipped until `package.json`, `package-lock.json` or `node_modules` are modified.

Additionally:

- the command `zinoma --clean` will delete `node_modules`; - the command `zinoma --clean npm_install` will delete `node_modules`, then run `npm install`.

description:
List of artifacts produced by this target.

It should be an array of [`resources`].

[`resources`]: enum.OutputResource.html

The incremental build takes in account the target `output`. Just like with [`input`], if any of the target output resources were altered since its previous successful execution, the target state will be invalidated and its build will be run again.

[`input`]: struct.InputResources.html

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

In this example, running `zinoma npm_install` will return immediately in case `package.json`, `package-lock.json` and `node_modules` were not modified since the last completion of the target.

Running `zinoma --clean npm_install` will start by deleting `node_modules`, then will run `npm install`.

$ref: #/definitions/OutputResource

description:
A target is a command or a set of commands to run as part of your build flow.

Targets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.

[`dependencies`]: struct.Dependencies.html

description:
A build target represents a shell script to run as part of your build flow.

This build script is expected to eventually complete, as opposed to the run script of a [`service`] target.

[`service`]: #variant.Service.field.service

description:
The shell script to run in order to build this target.

It should be a string. This string can be multi-line, in case of scripts with multiple commands.

__Example__

```yaml targets: create_file_deep: build: | mkdir -p deep/dir touch deep/dir/file output: - paths: [deep/dir/file] ```

In this example, running `zinoma create_file_deep` will execute the commands `mkdir -p deep/dir` and `touch deep/dir/my_file` sequentially.

description: Dependencies of the target.

$ref: #/definitions/Dependencies

description: Input resources of the target.

description: Output resources of the target.

description:
Service targets are useful to run scripts that do not complete.

They enable the execution of long-lasting commands, such as servers.

description: Dependencies of the target.

description: Input resources of the target.

description:
Shell script starting a long-lasting service.

It should be a string.

If `zinoma` has no service target to run, it will automatically exit after all build targets ran to completion. On the contrary, if at least one service target is specified in the command line, `zinoma` will keep running even after all build targets completed, so that the services can remain alive.

In watch mode (when the `--watch` flag is passed to `zinoma`), services are restarted when the relevant paths are modified.

__Example__

```yaml targets: npm_server: input: - paths: [package.json, index.js] service: npm start ```

In this example, `zinoma npm_server --watch` will run `npm start`, and will restart this process every time `package.json` or `index.js` are updated.

description:
Aggregates other targets.

__Example__

```yaml targets: fmt: build: cargo fmt -- --check lint: build: cargo clippy test: build: cargo test check: dependencies: [fmt, lint, test] ```

In this example, the target named `check` aggregates the 3 other targets. `zinoma check` is equivalent to running `zinoma fmt lint test`.

description: Dependencies of the target.


description: A recipe for Sourcehut CI service. For details, see https://man.sr.ht/builds.sr.ht/manifest.md.

description: Which OS image to build in. A list of available build images can be found at https://man.sr.ht/builds.sr.ht/compatibility.md

examples: archlinux alpine/latest

description: Which architecture to build for. See https://man.sr.ht/builds.sr.ht/compatibility.md for a list of available architectures.

description: A list of packages to install on the image. For image-specific details, consult https://man.sr.ht/builds.sr.ht/compatibility.md

description: A list of extra repositories to enable with the image's package manager. The specific format varies by base image, consult https://man.sr.ht/builds.sr.ht/compatibility.md for details.

description:
A list of files to extract from the completed build environment and make available for downloading from the jobs page. Artifacts are only uploaded for successful jobs and are pruned after 90 days.
Note that the file names are interpreted literally: do not use ~ or any shell code. If a relative path is used (e.g. example/my-artifact.tar.gz), it will be interpreted relative to the build user's home directory.

description: Whether to keep the build VM alive after all of the tasks have finished, even if it doesn't fail, so you can SSH in. You can also SSH in before the tasks have finished and tail the output of the build in your terminal. Learn more at https://man.sr.ht/builds.sr.ht/build-ssh.md

description: A list of repositories to clone into the home directory of the build user in the build environment. Optionally, prefix the protocol with the source control management scheme, to specify a protocol other than git. To specify a non-default git revision, append #commit-object to the repository.

description:
A list of scripts to execute in the build environment.
Task names must use only lowercase alphanumeric characters, underscores or dashes and must be <=128 characters in length. Tasks are executed in the order specified.
Each task is run in a separate login session, so if you modify the groups of the build user they will be effective starting from the subsequent task.

package:
cd $site
tar -cvz . > ../site.tar.gz

description:
A list of triggers to execute post-build, which can be used to send emails or do other post-build tasks.
Learn more at https://man.sr.ht/builds.sr.ht/triggers.md

description: Trigger type

enum: email webhook

description: When to execute this trigger

enum: always failure success

required: action condition

description: A list of key/value pairs for options to set in the build environment via ~/.buildenv

description: List of secret UUIDs to be added to the guest during the build. Learn more at https://man.sr.ht/builds.sr.ht/#secrets

description: If present, and secrets are enabled for this build, an OAuth 2.0 bearer token is generated for this build with the given string as the list of grants. The acurl command may be used in the task scripts to perform authenticated GraphAL API requests (https://man.sr.ht/graphql.md).

required: image tasks

title: Sourcehut Build Manifest