Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
electron-builder.json
mac
Options related to how build macOS targets.
{"anyOf": [{}, {"type": "null"}]}
electron-builder.json
mas
MAS (Mac Application Store) options.
{"anyOf": [{}, {"type": "null"}]}
electron-builder.json
muonVersion
The version of muon you are packaging for.
{"type": ["null", "string"]}
electron-builder.json
nodeGypRebuild
Whether to execute `node-gyp rebuild` before starting to package the app. Don't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.
{"default": false, "type": "boolean"}
electron-builder.json
nodeVersion
*libui-based frameworks only* The version of NodeJS you are packaging for. You can set it to `current` to set the Node.js version that you use to run.
{"type": ["null", "string"]}
electron-builder.json
npmArgs
Additional command line arguments to use when installing app native deps.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}
electron-builder.json
npmRebuild
Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.
{"default": true, "type": "boolean"}
electron-builder.json
onNodeModuleFile
The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file.
{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json
pkg
macOS PKG options.
{"anyOf": [{}, {"type": "null"}]}
electron-builder.json
productName
As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).
{"type": ["null", "string"]}
electron-builder.json
protocols
The URL protocol schemes.
{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json
readonly
Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).
{"default": false, "type": "boolean"}
electron-builder.json
releaseInfo
The release info. Intended for command line usage: ``` -c.releaseInfo.releaseNotes="new features" ```
{}
electron-builder.json
remoteBuild
Whether to build using Electron Build Service if target not supported on current OS.
{"default": true, "type": "boolean"}
electron-builder.json
removePackageScripts
Whether to remove `scripts` field from `package.json` files.
{"default": true, "type": "boolean"}
electron-builder.json
snap
Snap options.
{"anyOf": [{}, {"type": "null"}]}
electron-builder.json
win
Options related to how build Windows targets.
{"anyOf": [{}, {"type": "null"}]}
grunt-cssmin-task.json
options
Set the options for cssmin
{"type": "object", "properties": {"banner": {"type": ["null", "string"], "default": null}, "keepSpecialComments": {"type": ["number", "string"], "enum": ["*", 1, 2], "default": "*"}, "report": {"type": "string", "enum": ["min", "gzip"], "default": "min"}}}
grunt-cssmin-task.json
banner
Prefix the compressed source with the given banner, with a linebreak in between.
{"type": ["null", "string"], "default": null}
grunt-cssmin-task.json
keepSpecialComments
To keep or remove special comments, exposing the underlying option from 'clean-css'.
{"type": ["number", "string"], "enum": ["*", 1, 2], "default": "*"}
grunt-cssmin-task.json
report
Either report only minification result or report minification and gzip results. This is useful to see exactly how well clean-css is performing but using 'gzip' will make the task take 5-10x longer to complete.
{"type": "string", "enum": ["min", "gzip"], "default": "min"}
grunt-jshint-task.json
options
Set the options for JSHint
{"anyOf": [{"type": "object", "additionalProperties": false, "properties": {"jshintrc": {"type": ["boolean", "string"], "enum": [true]}}}, {}]}
grunt-jshint-task.json
jshintrc
Either a boolean value or a string containing the file name of the jshintrc file.
{"type": ["boolean", "string"], "enum": [true]}
cargo-make.json
A schema for cargo-make makefiles
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"semver": {"type": "string", "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "extend": {"type": "object", "x-taplo": {"initKeys": ["optional"]}, "required": ["path"], "additionalProperties": false, "properties": {"path": {"type": "string", "default": "path/to/Makefile.toml"}, "optional": {"type": "boolean", "default": true}}}, "script": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}, {"type": "object", "examples": [{"file": "path/to/script"}, {"file": "path/to/script", "absolute_path": true}], "required": ["file"], "additionalProperties": false, "properties": {"file": {"type": "string", "default": "path/to/script"}, "absolute_path": {"default": true, "type": "boolean"}}}, {"type": "object", "x-taplo": {"initKeys": ["pre", "main", "post"]}, "additionalProperties": false, "properties": {"pre": {"type": "string"}, "main": {"type": "string"}, "post": {"type": "string"}}}]}, "env_files": {"type": "array", "default": [], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env-file"}}, "items": {}, "uniqueItems": true}, "envfile": {"examples": ["path/to/env.env", {"path": "path/to/env.env", "profile": "development"}], "oneOf": [{"type": "string", "default": "path/to/env.env"}, {"type": "object", "x-taplo": {"initKeys": ["profile"]}, "required": ["path"], "additionalProperties": false, "properties": {"path": {"type": "string", "default": "path/to/env.env"}, "base_path": {"type": "string", "default": "path/to/dir"}, "profile": {"type": "string", "default": "development", "examples": ["development", "production"]}}}]}, "env": {"type": "object", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env-config"}}, "additionalProperties": {}}, "env_value": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env"}}, "anyOf": [{"type": "boolean"}, {"type": "integer"}, {"type": "string"}, {"type": "array", "items": {"type": "string"}}, {}, {}, {}, {}, {}, {}]}, "env_value_unset": {"type": "object", "required": ["unset"], "additionalProperties": false, "properties": {"unset": {"default": true, "type": "boolean"}}}, "env_value_script": {"type": "object", "required": ["script"], "additionalProperties": false, "properties": {"script": {"type": "array", "items": {"type": "string"}, "default": []}, "multi_line": {"default": true, "type": "boolean"}}}, "env_value_decode": {"type": "object", "x-taplo": {"initKeys": ["default_value"]}, "required": ["source", "mapping"], "additionalProperties": false, "properties": {"source": {"type": "string"}, "default_value": {"type": "string"}, "mapping": {"type": "object", "default": {}, "additionalProperties": {"type": "string"}}}}, "env_value_conditioned": {"type": "object", "x-taplo": {"initKeys": ["condition"]}, "required": ["value"], "additionalProperties": false, "properties": {"value": {"type": "string"}, "condition": {}}}, "env_value_path_glob": {"type": "object", "required": ["glob"], "additionalProperties": false, "properties": {"glob": {"type": "string"}, "include_files": {"default": true, "type": "boolean"}, "include_dirs": {"default": true, "type": "boolean"}, "ignore_type": {"enum": ["git"], "type": "string", "default": "git"}}}, "task_condition": {"type": "object", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-conditions"}}, "additionalProperties": false, "properties": {"fail_message": {"type": "string"}, "profiles": {"type": "array", "default": [], "items": {"type": "string", "default": "development"}}, "platforms": {"type": "array", "items": {"enum": ["linux", "windows", "mac"], "type": "string"}}, "channels": {"type": "array", "items": {"enum": ["stable", "beta", "nightly"], "type": "string", "default": "stable"}}, "env_set": {"type": "array", "items": {"type": "string"}}, "env_not_set": {"type": "array", "items": {"type": "string"}}, "env_true": {"type": "array", "items": {"type": "string"}}, "env_false": {"type": "array", "items": {"type": "string"}}, "env": {"type": "object", "additionalProperties": {"type": "string"}}, "env_contains": {"type": "object", "additionalProperties": {"type": "string"}}, "rust_version": {"type": "object", "x-taplo": {"initKeys": ["min"]}, "additionalProperties": false, "properties": {"min": {}, "max": {}, "equal": {}}}, "files_exist": {"type": "array", "items": {"type": "string"}}, "files_not_exist": {"type": "array", "items": {"type": "string"}}, "files_modified": {"type": "object", "additionalProperties": false, "properties": {"input": {"type": "array", "items": {"type": "string"}}, "output": {"type": "array", "items": {"type": "string"}}}}}}, "task": {"type": "object", "additionalProperties": false, "properties": {"clear": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"}}}, "category": {"type": "string"}, "disabled": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"}}}, "private": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-private-tasks"}}}, "deprecated": {"default": true, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-deprecated-tasks"}}, "oneOf": [{"type": "boolean"}, {"type": "string"}]}, "extend": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-extend-attribute"}}}, "workspace": {"default": false, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-disabling-workspace-support"}}}, "watch": {"default": true, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-watch"}}, "oneOf": [{"type": "boolean"}, {"type": "object", "x-taplo": {"initKeys": ["watch"]}, "additionalProperties": false, "properties": {"version": {}, "postpone": {"default": true, "type": "boolean"}, "ignore_pattern": {"type": "string"}, "no_git_ignore": {"default": true, "type": "boolean"}, "watch": {"type": "array", "items": {"type": "string"}}}}]}, "condition": {}, "condition_script": {"type": "array", "items": {"type": "string"}, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-conditions-script"}}}, "ignore_errors": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-ignoring-errors"}}}, "force": {"default": true, "type": "boolean", "deprecated": true, "x-taplo": {"hidden": true}}, "env_files": {}, "env": {}, "cwd": {"type": "string", "default": "path/to/dir"}, "alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "linux_alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "windows_alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "mac_alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "install_crate": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-installing-crates"}}, "oneOf": [{"default": false, "type": "boolean"}, {"type": "string"}, {"type": "object", "required": ["crate_name", "binary", "test_arg"], "additionalProperties": false, "properties": {"crate_name": {"type": "string"}, "rustup_component_name": {"type": "string"}, "binary": {"type": "string"}, "test_arg": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "min_version": {}, "version": {}, "install_command": {"type": "string"}}}, {"type": "object", "required": ["rustup_component_name"], "additionalProperties": false, "properties": {"rustup_component_name": {"type": "string"}, "binary": {"type": "string"}, "test_arg": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, {"type": "object", "required": ["crate_name", "min_version"], "additionalProperties": false, "properties": {"crate_name": {"type": "string"}, "min_version": {}}}]}, "install_crate_args": {"type": "array", "items": {"type": "string"}}, "install_script": {}, "command": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplecommand"}}}, "args": {"type": "array", "items": {"type": "string"}, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplecommand"}}}, "script": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplescript"}}}, "script_runner": {"type": "string", "examples": ["@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task"}}}, "script_runner_args": {"type": "string", "examples": ["-f"], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplegeneric"}}}, "script_extension": {"type": "string", "examples": ["py", "pl", "js", "php", "ps1"]}, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplegeneric"}}, "run_task": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}, "oneOf": [{"type": "string"}, {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "fork": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "parallel": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "cleanup_task": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}}}, {"type": "array", "items": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "fork": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "parallel": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "cleanup_task": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "condition": {}, "condition_script": {"type": "array", "items": {"type": "string"}}}}}]}, "dependencies": {"type": "array", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}, "items": {"oneOf": [{"type": "string"}, {"type": "object", "x-taplo": {"initKeys": ["path"]}, "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "path": {"type": "string", "default": "path/to/makefile"}}}]}}, "toolchain": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-toolchain"}}}, "linux": {}, "windows": {}, "mac": {}}}}, "properties": {"extend": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-extending-external-makefile"}}, "default": "path/to/Makefile.toml", "examples": ["path/to/Makefile.toml", {"path": "path/to/Makefile.toml", "optional": true}, [{"path": "path/to/Makefile.toml", "optional": true}]], "oneOf": [{"type": "string", "examples": ["path/to/Makefile.toml"]}, {}, {"type": "array", "items": {}, "uniqueItems": true}]}, "config": {"type": "object", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/api/cli/types/struct.ConfigSection.html"}, "initKeys": ["min_version"]}, "additionalProperties": false, "properties": {"skip_core_tasks": {"default": false, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-predefined-flows-disable"}}}, "skip_git_env_info": {"default": false, "type": "boolean", "x-taplo": {"links": {"key": "https://github.com/sagiegurari/cargo-make#performance-tuning"}}}, "skip_rust_env_info": {"default": false, "type": "boolean", "x-taplo": {"links": {"key": "https://github.com/sagiegurari/cargo-make#performance-tuning"}}}, "skip_crate_env_info": {"default": false, "type": "boolean", "x-taplo": {"links": {"key": "https://github.com/sagiegurari/cargo-make#performance-tuning"}}}, "modify_core_tasks": {"type": "object", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-predefined-flows-modify"}}, "examples": [{"private": true}, {"namespace": "default"}, {"private": true, "namespace": "default"}], "additionalProperties": false, "properties": {"private": {"default": true, "type": "boolean"}, "namespace": {"type": "string", "default": "default"}}}, "init_task": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-init-end-tasks"}}, "default": "init"}, "end_task": {"default": "end", "type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-init-end-tasks"}}}, "on_error_task": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-catching-errors"}}, "default": "catch"}, "legacy_migration_task": {"default": "legacy-migration", "type": "string", "x-taplo": {"hidden": true}}, "additional_profiles": {"default": [], "type": "array", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-profiles"}}, "examples": [["additional_profile"]], "items": {"type": "string", "default": "additional_profile"}, "uniqueItems": true}, "min_version": {"default": "0.35.0", "examples": ["0.35.0", "0.34.0", "0.33.0"], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-min-version"}}}, "default_to_workspace": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-disabling-workspace-support"}}}, "reduce_output": {"default": true, "type": "boolean"}, "time_summary": {"default": true, "type": "boolean"}, "load_cargo_aliases": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-cargo-alias-tasks"}}}, "main_project_member": {"type": "string", "default": "main-crate"}, "load_script": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"}}}, "linux_load_script": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"}}}, "windows_load_script": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"}}}, "mac_load_script": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"}}}}}, "env_files": {}, "env_scripts": {"type": "array", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env-file"}}, "default": [], "items": {"type": "string"}}, "env": {}, "tasks": {"type": "object", "additionalProperties": {}}}, "type": "object", "x-taplo-info": {"authors": ["Kathryn Long (https://github.com/starkat99)"], "version": "0.35.0", "patterns": ["^(.*(/|\\\\)Makefile\\.toml|Makefile\\.toml)$"]}}
cargo-make.json
extend
A potentially optional external makefile to extend
{"type": "object", "x-taplo": {"initKeys": ["optional"]}, "required": ["path"], "additionalProperties": false, "properties": {"path": {"type": "string", "default": "path/to/Makefile.toml"}, "optional": {"type": "boolean", "default": true}}}
cargo-make.json
path
The path of the external makefile, relative to this file
{"type": "string", "default": "path/to/Makefile.toml"}
cargo-make.json
optional
If true, the external makefile is optional and does not need to exist
{"type": "boolean", "default": true}
cargo-make.json
file
Scipt file name
{"type": "string", "default": "path/to/script"}
cargo-make.json
absolute_path
If true, the `file` value is an absolute path
{"default": true, "type": "boolean"}
cargo-make.json
script
Script content split to parts to enable a more fine tuned extension capability
{"type": "object", "x-taplo": {"initKeys": ["pre", "main", "post"]}, "additionalProperties": false, "properties": {"pre": {"type": "string"}, "main": {"type": "string"}, "post": {"type": "string"}}}
cargo-make.json
pre
Pre-main script section
{"type": "string"}
cargo-make.json
main
Main script section
{"type": "string"}
cargo-make.json
post
Post-main script section
{"type": "string"}
cargo-make.json
env_files
Load environment files
{"type": "array", "default": [], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env-file"}}, "items": {}, "uniqueItems": true}
cargo-make.json
envfile
File containing environment variables and their values
{"examples": ["path/to/env.env", {"path": "path/to/env.env", "profile": "development"}], "oneOf": [{"type": "string", "default": "path/to/env.env"}, {"type": "object", "x-taplo": {"initKeys": ["profile"]}, "required": ["path"], "additionalProperties": false, "properties": {"path": {"type": "string", "default": "path/to/env.env"}, "base_path": {"type": "string", "default": "path/to/dir"}, "profile": {"type": "string", "default": "development", "examples": ["development", "production"]}}}]}
cargo-make.json
envfile
The path to the env file
{"type": "string", "default": "path/to/env.env"}
cargo-make.json
envfile
The env file path and attributes
{"type": "object", "x-taplo": {"initKeys": ["profile"]}, "required": ["path"], "additionalProperties": false, "properties": {"path": {"type": "string", "default": "path/to/env.env"}, "base_path": {"type": "string", "default": "path/to/dir"}, "profile": {"type": "string", "default": "development", "examples": ["development", "production"]}}}
cargo-make.json
path
The path to the env file
{"type": "string", "default": "path/to/env.env"}
cargo-make.json
base_path
The path base directory (relative paths are from this base path)
{"type": "string", "default": "path/to/dir"}
cargo-make.json
profile
The profile name this file is relevant to
{"type": "string", "default": "development", "examples": ["development", "production"]}
cargo-make.json
env
Setup environment variables
{"type": "object", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env-config"}}, "additionalProperties": {}}
cargo-make.json
env_value
An environment variable value
{"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-env"}}, "anyOf": [{"type": "boolean"}, {"type": "integer"}, {"type": "string"}, {"type": "array", "items": {"type": "string"}}, {}, {}, {}, {}, {}, {}]}
cargo-make.json
env_value
An array which will be joined with the `;` separator
{"type": "array", "items": {"type": "string"}}
cargo-make.json
env_value
Profile dependent environment variables
{}
cargo-make.json
env_value_unset
Unsets environment variable
{"type": "object", "required": ["unset"], "additionalProperties": false, "properties": {"unset": {"default": true, "type": "boolean"}}}
cargo-make.json
unset
If true, the env variable will be unset, else ignored
{"default": true, "type": "boolean"}
cargo-make.json
env_value_script
Provide environment variable via script
{"type": "object", "required": ["script"], "additionalProperties": false, "properties": {"script": {"type": "array", "items": {"type": "string"}, "default": []}, "multi_line": {"default": true, "type": "boolean"}}}
cargo-make.json
multi_line
Enable multi-line values
{"default": true, "type": "boolean"}
cargo-make.json
env_value_decode
Environment variable value provided by decoding other values
{"type": "object", "x-taplo": {"initKeys": ["default_value"]}, "required": ["source", "mapping"], "additionalProperties": false, "properties": {"source": {"type": "string"}, "default_value": {"type": "string"}, "mapping": {"type": "object", "default": {}, "additionalProperties": {"type": "string"}}}}
cargo-make.json
source
The source environment variable (can be an env expression)
{"type": "string"}
cargo-make.json
default_value
The default value in case no decode mapping was found, if not provided it will default to the source value
{"type": "string"}
cargo-make.json
mapping
The decoding mapping from one value to another value
{"type": "object", "default": {}, "additionalProperties": {"type": "string"}}
cargo-make.json
env_value_conditioned
Environment variable value set if condition is met
{"type": "object", "x-taplo": {"initKeys": ["condition"]}, "required": ["value"], "additionalProperties": false, "properties": {"value": {"type": "string"}, "condition": {}}}
cargo-make.json
value
The value to set (can be an env expression)
{"type": "string"}
cargo-make.json
condition
Condition to evaluate to see whether to set the environment value or not
{}
cargo-make.json
env_value_path_glob
Environment value holding a list of paths based on given glob definitions
{"type": "object", "required": ["glob"], "additionalProperties": false, "properties": {"glob": {"type": "string"}, "include_files": {"default": true, "type": "boolean"}, "include_dirs": {"default": true, "type": "boolean"}, "ignore_type": {"enum": ["git"], "type": "string", "default": "git"}}}
cargo-make.json
glob
The glob used to fetch all paths
{"type": "string"}
cargo-make.json
include_files
If true, include files in glob
{"default": true, "type": "boolean"}
cargo-make.json
include_dirs
If true, include directories in glob
{"default": true, "type": "boolean"}
cargo-make.json
ignore_type
An ignore source that enables respecting ignore files from that source
{"enum": ["git"], "type": "string", "default": "git"}
cargo-make.json
task_condition
Conditions allow you to evaluate at runtime if to run a specific task or not
{"type": "object", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-conditions"}}, "additionalProperties": false, "properties": {"fail_message": {"type": "string"}, "profiles": {"type": "array", "default": [], "items": {"type": "string", "default": "development"}}, "platforms": {"type": "array", "items": {"enum": ["linux", "windows", "mac"], "type": "string"}}, "channels": {"type": "array", "items": {"enum": ["stable", "beta", "nightly"], "type": "string", "default": "stable"}}, "env_set": {"type": "array", "items": {"type": "string"}}, "env_not_set": {"type": "array", "items": {"type": "string"}}, "env_true": {"type": "array", "items": {"type": "string"}}, "env_false": {"type": "array", "items": {"type": "string"}}, "env": {"type": "object", "additionalProperties": {"type": "string"}}, "env_contains": {"type": "object", "additionalProperties": {"type": "string"}}, "rust_version": {"type": "object", "x-taplo": {"initKeys": ["min"]}, "additionalProperties": false, "properties": {"min": {}, "max": {}, "equal": {}}}, "files_exist": {"type": "array", "items": {"type": "string"}}, "files_not_exist": {"type": "array", "items": {"type": "string"}}, "files_modified": {"type": "object", "additionalProperties": false, "properties": {"input": {"type": "array", "items": {"type": "string"}}, "output": {"type": "array", "items": {"type": "string"}}}}}}
cargo-make.json
fail_message
Message to display when the condition fails
{"type": "string"}
cargo-make.json
profiles
Profile names to match for the condition
{"type": "array", "default": [], "items": {"type": "string", "default": "development"}}
cargo-make.json
items
Profile name
{"type": "string", "default": "development"}
cargo-make.json
platforms
Platform names to match for the condition
{"type": "array", "items": {"enum": ["linux", "windows", "mac"], "type": "string"}}
cargo-make.json
items
Platform name
{"enum": ["linux", "windows", "mac"], "type": "string"}
cargo-make.json
channels
Rust channels to match for the condition
{"type": "array", "items": {"enum": ["stable", "beta", "nightly"], "type": "string", "default": "stable"}}
cargo-make.json
items
Rust channel
{"enum": ["stable", "beta", "nightly"], "type": "string", "default": "stable"}
cargo-make.json
env_set
List of environment variables which must be defined
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
Environment variable
{"type": "string"}
cargo-make.json
env_not_set
List of environment variables which must not be defined
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
Environment variable
{"type": "string"}
cargo-make.json
env_true
List of environment variables which must be defined and must not be set to any of the following (case insensitive): `false`, `no`, `0`, or empty
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
Environment variable
{"type": "string"}
cargo-make.json
env_false
List of environment variables which must be defined and must be set to any of the following (case insensitive): `false`, `no`, `0`, or empty
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
Environment variable
{"type": "string"}
cargo-make.json
env
Map of environment variables that must be defined and equal to the provided values
{"type": "object", "additionalProperties": {"type": "string"}}
cargo-make.json
additionalProperties
Environment value
{"type": "string"}
cargo-make.json
env_contains
Map of environment variables that must be defined and contain (case insensitive) the provided values
{"type": "object", "additionalProperties": {"type": "string"}}
cargo-make.json
additionalProperties
Environment value
{"type": "string"}
cargo-make.json
rust_version
A definition of min, max and/or specific rust version
{"type": "object", "x-taplo": {"initKeys": ["min"]}, "additionalProperties": false, "properties": {"min": {}, "max": {}, "equal": {}}}
cargo-make.json
min
Minimum Rust version
{}
cargo-make.json
max
Maximum Rust version
{}
cargo-make.json
equal
Exact Rust version
{}
cargo-make.json
files_exist
List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
File path
{"type": "string"}
cargo-make.json
files_not_exist
List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
File path
{"type": "string"}
cargo-make.json
files_modified
If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths
{"type": "object", "additionalProperties": false, "properties": {"input": {"type": "array", "items": {"type": "string"}}, "output": {"type": "array", "items": {"type": "string"}}}}
cargo-make.json
input
List of input globs
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
glob
{"type": "string"}
cargo-make.json
output
List of output globs
{"type": "array", "items": {"type": "string"}}
cargo-make.json
items
glob
{"type": "string"}
cargo-make.json
task
A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.
{"type": "object", "additionalProperties": false, "properties": {"clear": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"}}}, "category": {"type": "string"}, "disabled": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"}}}, "private": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-private-tasks"}}}, "deprecated": {"default": true, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-deprecated-tasks"}}, "oneOf": [{"type": "boolean"}, {"type": "string"}]}, "extend": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-extend-attribute"}}}, "workspace": {"default": false, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-disabling-workspace-support"}}}, "watch": {"default": true, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-watch"}}, "oneOf": [{"type": "boolean"}, {"type": "object", "x-taplo": {"initKeys": ["watch"]}, "additionalProperties": false, "properties": {"version": {}, "postpone": {"default": true, "type": "boolean"}, "ignore_pattern": {"type": "string"}, "no_git_ignore": {"default": true, "type": "boolean"}, "watch": {"type": "array", "items": {"type": "string"}}}}]}, "condition": {}, "condition_script": {"type": "array", "items": {"type": "string"}, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-conditions-script"}}}, "ignore_errors": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-ignoring-errors"}}}, "force": {"default": true, "type": "boolean", "deprecated": true, "x-taplo": {"hidden": true}}, "env_files": {}, "env": {}, "cwd": {"type": "string", "default": "path/to/dir"}, "alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "linux_alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "windows_alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "mac_alias": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}}, "install_crate": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-installing-crates"}}, "oneOf": [{"default": false, "type": "boolean"}, {"type": "string"}, {"type": "object", "required": ["crate_name", "binary", "test_arg"], "additionalProperties": false, "properties": {"crate_name": {"type": "string"}, "rustup_component_name": {"type": "string"}, "binary": {"type": "string"}, "test_arg": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "min_version": {}, "version": {}, "install_command": {"type": "string"}}}, {"type": "object", "required": ["rustup_component_name"], "additionalProperties": false, "properties": {"rustup_component_name": {"type": "string"}, "binary": {"type": "string"}, "test_arg": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, {"type": "object", "required": ["crate_name", "min_version"], "additionalProperties": false, "properties": {"crate_name": {"type": "string"}, "min_version": {}}}]}, "install_crate_args": {"type": "array", "items": {"type": "string"}}, "install_script": {}, "command": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplecommand"}}}, "args": {"type": "array", "items": {"type": "string"}, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplecommand"}}}, "script": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplescript"}}}, "script_runner": {"type": "string", "examples": ["@rust", "@duckscript", "@shell", "python", "perl", "node", "php", "powershell"], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task"}}}, "script_runner_args": {"type": "string", "examples": ["-f"], "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplegeneric"}}}, "script_extension": {"type": "string", "examples": ["py", "pl", "js", "php", "ps1"]}, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplegeneric"}}, "run_task": {"x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}, "oneOf": [{"type": "string"}, {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "fork": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "parallel": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "cleanup_task": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}}}, {"type": "array", "items": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "fork": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "parallel": {"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "cleanup_task": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"}}}, "condition": {}, "condition_script": {"type": "array", "items": {"type": "string"}}}}}]}, "dependencies": {"type": "array", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"}}, "items": {"oneOf": [{"type": "string"}, {"type": "object", "x-taplo": {"initKeys": ["path"]}, "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "path": {"type": "string", "default": "path/to/makefile"}}}]}}, "toolchain": {"type": "string", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-toolchain"}}}, "linux": {}, "windows": {}, "mac": {}}}
cargo-make.json
clear
If true, it should ignore all data in the base task
{"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"}}}
cargo-make.json
description
A description used to document the task
{"type": "string"}
cargo-make.json
category
Category name used to document the task
{"type": "string"}
cargo-make.json
disabled
If true, the command/script of this task will not be invoked, but dependencies will be
{"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"}}}
cargo-make.json
private
If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI
{"default": true, "type": "boolean", "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-private-tasks"}}}
cargo-make.json
deprecated
If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.
{"default": true, "x-taplo": {"links": {"key": "https://sagiegurari.github.io/cargo-make/#usage-deprecated-tasks"}}, "oneOf": [{"type": "boolean"}, {"type": "string"}]}