schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
megalinter-configuration.jsonschema.json
TSX_ESLINT_CONFIG_FILE
TSX_ESLINT: User custom config file name if different from default
{"default": ".eslintrc.json", "type": "string"}
megalinter-configuration.jsonschema.json
TSX_ESLINT_FILE_NAME
TSX_ESLINT: User custom config file name if different from default
{"default": ".eslintrc.json", "type": "string"}
megalinter-configuration.jsonschema.json
TSX_ESLINT_RULES_PATH
TSX_ESLINT: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
TSX_ESLINT_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling TSX_ESLINT and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_DEFAULT_STYLE
Style of typescript formatting to apply
{"enum": ["standard", "prettier"], "examples": ["standard", "prettier"], "type": "string"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_ES_ARGUMENTS
TYPESCRIPT_ES: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS
TYPESCRIPT_ES: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
TYPESCRIPT_ES_CONFIG_FILE
TYPESCRIPT_ES: User custom config file name if different from default
{"default": ".eslintrc.json", "type": "string"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_ES_FILE_NAME
TYPESCRIPT_ES: User custom config file name if different from default
{"default": ".eslintrc.json", "type": "string"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_ES_RULES_PATH
TYPESCRIPT_ES: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling TYPESCRIPT_ES and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_PRETTIER_ARGUMENTS
TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS
TYPESCRIPT_PRETTIER: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
TYPESCRIPT_PRETTIER_CONFIG_FILE
TYPESCRIPT_PRETTIER: User custom config file name if different from default
{"default": ".prettierrc.json", "type": "string"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_PRETTIER_RULES_PATH
TYPESCRIPT_PRETTIER: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling TYPESCRIPT_PRETTIER and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
TYPESCRIPT_STANDARD_ARGUMENTS
TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS
TYPESCRIPT_STANDARD: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling TYPESCRIPT_STANDARD and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
VALIDATE_ALL_CODEBASE
Will parse the entire repository and find all files to validate across all types. When set to false, only new or edited files will be parsed for validation.
{"default": true, "type": "boolean"}
megalinter-configuration.jsonschema.json
VBDOTNET_DOTNET_FORMAT_ARGUMENTS
VBDOTNET_DOTNET_FORMAT: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS
VBDOTNET_DOTNET_FORMAT: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling VBDOTNET_DOTNET_FORMAT and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
XML_XMLLINT_ARGUMENTS
XML_XMLLINT: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS
XML_XMLLINT: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
XML_XMLLINT_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling XML_XMLLINT and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
YAML_PRETTIER_ARGUMENTS
YAML_PRETTIER: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS
YAML_PRETTIER: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
YAML_PRETTIER_CONFIG_FILE
YAML_PRETTIER: User custom config file name if different from default
{"default": ".prettierrc.json", "type": "string"}
megalinter-configuration.jsonschema.json
YAML_PRETTIER_RULES_PATH
YAML_PRETTIER: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
YAML_PRETTIER_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling YAML_PRETTIER and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
YAML_V8R_ARGUMENTS
YAML_V8R: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
YAML_V8R_COMMAND_REMOVE_ARGUMENTS
YAML_V8R: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
YAML_V8R_CONFIG_FILE
YAML_V8R: User custom config file name if different from default
{"default": ".v8rrc.yml", "type": "string"}
megalinter-configuration.jsonschema.json
YAML_V8R_RULES_PATH
YAML_V8R: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
YAML_V8R_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
YAML_YAMLLINT_ARGUMENTS
YAML_YAMLLINT: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS
YAML_YAMLLINT: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
YAML_YAMLLINT_CONFIG_FILE
YAML_YAMLLINT: User custom config file name if different from default
{"default": ".yamllint.yml", "type": "string"}
megalinter-configuration.jsonschema.json
YAML_YAMLLINT_FILE_NAME
YAML_YAMLLINT: User custom config file name if different from default
{"default": ".yaml-lint.yml", "type": "string"}
megalinter-configuration.jsonschema.json
YAML_YAMLLINT_RULES_PATH
YAML_YAMLLINT: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
YAML_YAMLLINT_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
codux.config.schema.json
svgLoader
Configures how SVG assets load. Refer to https://help.codux.com/kb/en/article/kb17934 for more information.
{"type": "string", "default": "asset"}
codux.config.schema.json
boardsPath
Default directory for new boards, relative to the project root. Refer to https://help.codux.com/kb/en/article/kb19337 for more information.
{"type": "string", "default": "src/_codux/boards"}
codux.config.schema.json
scripts
Configures scripts for project users to run from Codux (triggerable and on demand). Refer to https://help.codux.com/kb/en/article/kb30920 for more information.
{"oneOf": [{"type": "object", "additionalProperties": {}, "propertyNames": {"type": "string"}}]}
codux.config.schema.json
conditionalClassnamesConfig
Options for using the classNames utility library, including path to classNames module, and target export. Refer to https://help.codux.com/kb/en/article/kb36122 for more information.
{"oneOf": [{}]}
codux.config.schema.json
boardGlobalSetup
Path to a file that will be evaluated before each board is rendered, Useful for importing global stylesheets and initializing global variables. Can be absolute or relative to the project root (in which case it needs to start with './') Refer to https://help.codux.com/kb/en/article/kb36623 for more information.
{"oneOf": [{"type": "null"}, {"type": "string"}]}
codux.config.schema.json
httpServerPort
Port of HTTP server that is used to serve previews and user project itself.
{"type": "number", "default": 0}
codux.config.schema.json
fileNamingConvention
Configures file-naming convention for new component creation. Refer to https://help.codux.com/kb/en/article/kb29627 for more information. Options: "pascal-case" | "camel-case" | "kebab-case"
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
serverProxyMap
Configures proxy servers for Codux to redirect requests to. The key is the path to proxy requests from, and the value is the url to proxy requests to. Refer to https://help.codux.com/kb/en/article/kb18137 for more information.
{"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"type": "string"}}
codux.config.schema.json
styling
Styling related configuration. Contains field for styling solution which determines the main styling solution in the user's project. Refer to https://help.codux.com/kb/en/article/kb31817 for more information.
{"type": "object", "properties": {"solution": {"oneOf": [{"type": "string"}]}}}
codux.config.schema.json
solution
Default file extension to use for component style sheets in the project. Options: "css" | "sass" | "css modules" | "sass modules" | "scss" | "scss modules" | "stylable"
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
formatting
Formats code styling in Codux code drawer. Refer to https://help.codux.com/kb/en/article/kb21416 for more information.
{"oneOf": [{"type": "null"}, {"type": "string"}, {"type": "number"}, {"type": "array", "items": {}}, {"type": "object"}, {"type": "boolean"}]}
codux.config.schema.json
AddPanelConfig
Add Panel config. Can contain list of libraries installed in the project which provide boards for Codux.
{"type": "object", "properties": {"assets": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}}}
codux.config.schema.json
ConfiguredScript
The type of configured script users will define in the `codux.config.json`.
{"oneOf": [{}, {}]}
codux.config.schema.json
ScriptFromConfig
Scripts have a `commmand` but not an array of scripts to `run`.
{"type": "object", "properties": {"command": {"type": "string"}, "trigger": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}}, "required": ["command"]}
codux.config.schema.json
command
This is the command that the script runs when executed.
{"type": "string"}
codux.config.schema.json
title
Script title in the UI. Will be available to use from Codux.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
description
Script description in the UI.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
trigger
Initiate Git commands in Codux before running the rest of the scripts. The array of triggers may include "setup" for when the user opens the project for the first time, "pull" for when branch commits sync, and "checkout" for when switching branches.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
BatchFromConfig
Batches have a `run` array but not a `commmand`.
{"type": "object", "properties": {"run": {"type": "array", "items": {"type": "string"}}, "trigger": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}}, "required": ["run"]}
codux.config.schema.json
run
The value of this parameter is an array of script objects to include in the batch.
{"type": "array", "items": {"type": "string"}}
codux.config.schema.json
title
Script title in the UI. Will be available to use from Codux.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
description
Script description in the UI.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
trigger
Initiate Git commands in Codux before running the rest of the scripts. The array of triggers may include "setup" for when the user opens the project for the first time, "pull" for when branch commits sync, and "checkout" for when switching branches.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
PreviewConfiguration
Specifies environment variables to use globally across the project. Refer to https://help.codux.com/kb/en/article/kb37722 for more information.
{"type": "object", "properties": {"environmentVariables": {"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"type": "string"}}}, "required": ["environmentVariables"]}
codux.config.schema.json
environmentVariables
variables that are being accessed from process.env
{"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"type": "string"}}
codux.config.schema.json
ICompilationConfig
Enables CSS modules in your project. Refer to https://help.codux.com/kb/en/article/kb25813 for more information.
{"type": "object", "properties": {"activateCssModules": {"type": "boolean"}, "cssModulesExt": {"type": "array", "items": {"type": "string"}}}, "required": ["activateCssModules", "cssModulesExt"]}
codux.config.schema.json
activateCssModules
Enables or disables the use of CSS modules.
{"type": "boolean"}
codux.config.schema.json
cssModulesExt
The extension types for files to load as modules.
{"type": "array", "items": {"type": "string"}}
codux.config.schema.json
PluggableSafeModeConfig
Configures maximum rendered elements. Refer to https://help.codux.com/kb/en/article/kb18414 for more information.
{"type": "object", "properties": {"maxInstancesPerComponent": {"oneOf": [{"type": "number"}]}}}
codux.config.schema.json
INewComponentConfig
Configures default paths for new component and template files. Refer to https://help.codux.com/kb/en/article/kb16522 for more information.
{"type": "object", "properties": {"componentsPath": {"oneOf": [{"type": "string"}]}, "templatesPath": {"oneOf": [{"type": "string"}]}}}
codux.config.schema.json
componentsPath
Path where new components and related files will save to.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
templatesPath
Path where project templates are stored.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
IgnoredSubPaths
Specifies project folders to exclude from component search. Refer to https://help.codux.com/kb/en/article/kb14730 for more information.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
IResolveConfiguration
Includes package assets from additional sources, and creates aliases and fallbacks. Refer to https://help.codux.com/kb/en/article/kb18719 for more information.
{"type": "object", "properties": {"alias": {"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "boolean"}]}, "propertyNames": {"type": "string"}}]}, "fallback": {"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "boolean"}]}, "propertyNames": {"type": "string"}}]}, "packageRoots": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}, "workspaceAlias": {"oneOf": [{"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"type": "string"}}]}}}
codux.config.schema.json
alias
Aliases for package requests. Record key is the request to be mapped, value is the new target. Alias is attempted before original request.
{"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "boolean"}]}, "propertyNames": {"type": "string"}}]}
codux.config.schema.json
fallback
Fallback for package requests. Record key is the request to be mapped, value is the new target. Original request is attempted before fallback.
{"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "boolean"}]}, "propertyNames": {"type": "string"}}]}
codux.config.schema.json
packageRoots
Folders to use when searching for packages.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
workspaceAlias
Aliases for all package requests in a monorepo. Record key is the request to be mapped, value is the new target.
{"oneOf": [{"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"type": "string"}}]}
codux.config.schema.json
SassCompilationProjectConfigEntry
Adds Sass support to compilations. Refer to https://help.codux.com/kb/en/article/kb19315 for more information.
{"type": "object", "properties": {"modules": {"type": "object", "properties": {"include": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "ignore": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}, "required": ["include"]}, "resolveUrls": {"type": "boolean"}, "includePaths": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}}, "required": ["modules", "resolveUrls"]}
codux.config.schema.json
modules
Defines path and module extensions for Sass modules to include and/or ignore. Input as an array of glob patterns.
{"type": "object", "properties": {"include": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "ignore": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}, "required": ["include"]}
codux.config.schema.json
include
Array of glob patterns to include.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
ignore
Array of glob patterns to ignore.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
resolveUrls
Determines whether URLs in Sass files should resolve to absolute file paths before compiling them.
{"type": "boolean"}
codux.config.schema.json
includePaths
Array of paths to resolve Sass files from.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
IStyleFilesConfig
Style files config
{"type": "object", "properties": {"commonStyleFilePattern": {"oneOf": [{"type": "string"}]}}}
codux.config.schema.json
commonStyleFilePattern
ext glob pattern of common style files that are used by other components. Defines common rules category.
{"oneOf": [{"type": "string"}]}
codux.config.schema.json
ComponentsDiscoveryConfig
Scopes component discovery in your project. Refer to https://help.codux.com/kb/en/article/kb37113 for more information.
{"type": "object", "properties": {"include": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}, "exclude": {"oneOf": [{"type": "array", "items": {"type": "string"}}]}}}
codux.config.schema.json
include
Array of glob patterns to include.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
codux.config.schema.json
exclude
Array of glob patterns to exclude.
{"oneOf": [{"type": "array", "items": {"type": "string"}}]}
asmdef.json
Defines an assembly in the Unity compilation pipeline
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{"properties": {"includePlatforms": {"minItems": 1}, "excludePlatforms": {"maxItems": 0}}}, {"properties": {"includePlatforms": {"maxItems": 0}, "excludePlatforms": {"minItems": 1}}}, {"properties": {"includePlatforms": {"maxItems": 0}, "excludePlatforms": {"maxItems": 0}}}], "definitions": {"platformValues": {"type": "array", "uniqueItems": true, "items": {"enum": ["Android", "Editor", "iOS", "LinuxStandalone32", "LinuxStandalone64", "LinuxStandaloneUniversal", "Lumin", "macOSStandalone", "Nintendo3DS", "PS4", "PSVita", "Stadia", "Switch", "tvOS", "WSA", "WebGL", "WindowsStandalone32", "WindowsStandalone64", "XboxOne"]}}}, "properties": {"name": {"type": "string", "minLength": 1}, "rootNamespace": {"type": "string", "minLength": 1}, "references": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true}, "includePlatforms": {}, "excludePlatforms": {}, "allowUnsafeCode": {"type": "boolean", "default": false}, "autoReferenced": {"type": "boolean", "default": true}, "noEngineReferences": {"type": "boolean", "default": false}, "overrideReferences": {"type": "boolean", "default": "false"}, "precompiledReferences": {"type": "array", "uniqueItems": true}, "defineConstraints": {"type": "array", "uniqueItems": true}, "optionalUnityReferences": {"type": "array", "items": {"enum": ["TestAssemblies"]}, "uniqueItems": true}, "versionDefines": {"type": "array", "uniqueItems": true, "items": {"type": "object", "properties": {"name": {"type": "string"}, "expression": {"type": "string"}, "define": {"type": "string"}}, "required": ["name", "expression", "define"]}}}, "required": ["name"], "type": "object"}
asmdef.json
name
The name of the assembly being defined
{"type": "string", "minLength": 1}
asmdef.json
rootNamespace
The root namespace of the assembly. Requires Unity 2020.2
{"type": "string", "minLength": 1}
asmdef.json
references
A list of assembly names or assembly asset GUIDs to reference
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true}
asmdef.json
includePlatforms
Platforms to target
{}
asmdef.json
excludePlatforms
Platforms that are explicitly not targeted
{}
asmdef.json
allowUnsafeCode
Allow unsafe code
{"type": "boolean", "default": false}
asmdef.json
autoReferenced
When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)
{"type": "boolean", "default": true}
asmdef.json
noEngineReferences
When true, no references to UnityEngine or UnityEditor will be added to this assembly project
{"type": "boolean", "default": false}