schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
project-1.0.0-rc2.json
packOptions
Defines options pertaining to the packaging of the project output into a NuGet package.
{"type": "object", "properties": {"summary": {"type": "string"}, "tags": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "owners": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "releaseNotes": {"type": "string"}, "iconUrl": {"type": "string"}, "licenseUrl": {"type": "string"}...
project-1.0.0-rc2.json
summary
A short description of the package.
{"type": "string"}
project-1.0.0-rc2.json
tags
A space-delimited list of tags and keywords that describe the package.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
project-1.0.0-rc2.json
owners
List of owners of the package.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
project-1.0.0-rc2.json
releaseNotes
A description of the changes made in each release of the package.
{"type": "string"}
project-1.0.0-rc2.json
iconUrl
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.
{"type": "string"}
project-1.0.0-rc2.json
licenseUrl
A link to the license for the package.
{"type": "string"}
project-1.0.0-rc2.json
requireLicenseAcceptance
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.
{"type": "boolean", "default": false}
project-1.0.0-rc2.json
repository
Contains information about the repository where the project is stored.
{"type": "object", "properties": {"type": {"type": "string", "enum": ["git"], "default": "git"}, "url": {"type": "string", "format": "uri"}}, "additionalProperties": {"type": "string"}}
project-1.0.0-rc2.json
files
Defines glob patterns and file paths to include in the generated NuGet package.
{}
project-1.0.0-rc2.json
publishOptions
Defines glob patterns and file paths to include in publish output.
{}
project-1.0.0-rc2.json
imports
Allow packages supporting these frameworks to be installed in this target, regardless of the compatibility rules.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
dependencies
Each dependency is defined by a name and a version. Dependencies are resolved from NuGet feeds defined by your package sources and projects located in the directories specified by the 'global.json' file.
{"type": "object", "additionalProperties": {"type": ["string", "object"], "properties": {"version": {"type": "string"}, "type": {"type": "string", "default": "default", "enum": ["default", "build", "platform"]}, "target": {"type": "string", "enum": ["project", "package"]}, "include": {}, "exclude": {}, "suppressParent"...
project-1.0.0-rc2.json
target
Restrict this dependency to matching only a Project or a Package.
{"type": "string", "enum": ["project", "package"]}
project-1.0.0-rc2.json
script
A command line script or scripts. Available variables: %project:Directory% - The project directory %project:Name% - The project name %project:Version% - The project version
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
authors
The author of the application.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
project-1.0.0-rc2.json
packInclude
[Deprecated] Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }. Use 'files' in 'packOptions' instead.
{"type": "object"}
project-1.0.0-rc2.json
publishExclude
[Deprecated] Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["obj/**/*.*", "bin/**/*.*", "**/.*/**"]}
project-1.0.0-rc2.json
compile
[Deprecated] Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'compile' in 'buildOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}, "default": "**/*.cs"}
project-1.0.0-rc2.json
compileExclude
[Deprecated] Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'compile' in 'buildOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
compileFiles
[Deprecated] Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'compile' in 'buildOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
content
[Deprecated] Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.
{"type": ["string", "array"], "items": {"type": "string"}, "default": "**/*"}
project-1.0.0-rc2.json
contentExclude
[Deprecated] 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" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
contentFiles
[Deprecated] Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
preprocess
Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "compiler/preprocess/**/*.cs"}
project-1.0.0-rc2.json
preprocessExclude
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" ]
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
preprocessFiles
Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
resource
[Deprecated] Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'embed' in 'buildOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["compiler/resources/**/*", "**/*.resx"]}
project-1.0.0-rc2.json
resourceExclude
[Deprecated] 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" ]. Use 'embed' in 'buildOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
resourceFiles
[Deprecated] Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'embed' in 'buildOptions' instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
shared
Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "compiler/shared/**/*.cs"}
project-1.0.0-rc2.json
sharedExclude
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" ]
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
sharedFiles
Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
exclude
[Deprecated] 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" ]. Use 'exclude' within 'compile' or 'embed' instead.
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-rc2.json
excludeBuiltIn
[Deprecated] 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" ]. Use 'exclude' within 'compile' or 'embed' instead.
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["bin/**", "obj/**", "**/*.xproj"]}
project-1.0.0-rc2.json
testRunner
The name of the test runner to use with this project
{"type": "string"}
project-1.0.0-rc2.json
configurations
Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"compilationOptions": {}, "buildOptions": {}}}}
project-1.0.0-rc2.json
copyright
Copyright details for the package.
{"type": "string"}
project-1.0.0-rc2.json
iconUrl
[Deprecated] 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. Use this in 'packOptions' instead.
{"type": "string"}
project-1.0.0-rc2.json
licenseUrl
[Deprecated] A link to the license for the package. Use this in 'packOptions' instead.
{"type": "string"}
project-1.0.0-rc2.json
requireLicenseAcceptance
[Deprecated] 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. Use this in 'packOptions' instead.
{"type": "boolean", "default": false}
project-1.0.0-rc2.json
owners
[Deprecated] List of owners of the package. Use this in 'packOptions' instead.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
project-1.0.0-rc2.json
projectUrl
A URL for the home page of the package.
{"type": "string"}
project-1.0.0-rc2.json
summary
[Deprecated] A short description of the package. Use this in 'packOptions' instead.
{"type": "string"}
project-1.0.0-rc2.json
tags
[Deprecated] A space-delimited list of tags and keywords that describe the package. Use this in 'packOptions' instead.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
project-1.0.0-rc2.json
title
The human-friendly title of the package
{"type": "string"}
project-1.0.0-rc2.json
releaseNotes
[Deprecated] A description of the changes made in each release of the package. Use this in 'packOptions' instead.
{"type": "string"}
project-1.0.0-rc2.json
language
The locale ID for the package, such as en-us.
{"type": "string"}
project-1.0.0-rc2.json
description
The description of the project/package.
{"type": "string"}
project-1.0.0-rc2.json
frameworks
Target frameworks that will be built, and dependencies that are specific to the build of this project for that framework.
{"type": "object", "additionalProperties": {}}
project-1.0.0-rc2.json
namedResource
Overrides the generated resource names with custom ones.
{"type": "object", "additionalProperties": {"type": "string"}}
project-1.0.0-rc2.json
repository
[Deprecated] Contains information about the repository where the project is stored. Use this in 'packOptions' instead.
{"type": "object", "properties": {"type": {"type": "string", "enum": ["git"], "default": "git"}, "url": {"type": "string", "format": "uri"}}, "additionalProperties": {"type": "string"}}
project-1.0.0-rc2.json
scripts
Scripts to execute during the various stages.
{"type": "object", "properties": {"precompile": {}, "postcompile": {}, "prepack": {}, "postpack": {}, "prepublish": {}, "postpublish": {}, "prerestore": {}, "postrestore": {}, "prepare": {}}}
project-1.0.0-rc2.json
version
The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*
{"type": "string"}
project-1.0.0-rc2.json
tools
Project-specific command line tools accessible when in the project.json directory.
{"type": "object", "additionalProperties": {"type": ["string", "object"], "properties": {"version": {"type": "string"}}}}
project-1.0.0-rc2.json
runtimes
List of runtime identifiers supported by this project (used when building standalone applications).
{"type": "object"}
project-1.0.0-beta4.json
script
A command line script or scripts. Available variables: %project:Directory% - The project directory %project:Name% - The project name %project:Version% - The project version
{"type": ["string", "array"], "items": {"type": "string"}}
project-1.0.0-beta4.json
publishExclude
List of files to exclude from publish output (dnu publish).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
compile
Glob pattern to specify additional code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "folder1/**/*.cs", "folder2/**/*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
compileExclude
Glob pattern to indicate code files that needs to be excluded from compilation. (data type: string or array with glob pattern(s)). Example: [ "folder1/**/*.cs", "folder2/**/*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
compileFiles
Individual file paths relative to application root that needs to be included for compilation. (data type: string or array). Example: [ "folder1/test1.cs", "folder2/test2.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
compileBuiltIn
Glob pattern to indicate the default code files that are included for compilation. (data type: string or array with glob pattern(s)). Example: [ "**/*.cs", "../folder2/**/*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "**/*.cs"}
project-1.0.0-beta4.json
exclude
Glob pattern to indicate the default files to be excluded from processing. (data type: string or array with glob pattern(s)).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
excludeBuiltIn
Glob pattern to indicate all the additional files to be excluded from processing. (data type: string or array with glob pattern(s)).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["bin/**/*.*", "obj/**/*.*", "**/*.xproj"]}
project-1.0.0-beta4.json
preprocess
Glob pattern to indicate all the code files to be pre-processed. (data type: string or array with glob pattern(s)).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["compiler/preprocess/**/*.cs"]}
project-1.0.0-beta4.json
preprocessExclude
Glob pattern to indicate all the code files to be excluded from pre-processing. (data type: string or array with glob pattern(s)).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
preprocessFiles
Glob pattern to indicate specific code files to be included for pre-processing. (data type: string or array).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
resource
Glob pattern to indicate all the files that need to be compiled as resources. (data type: string or array with glob pattern(s))
{"type": ["string", "array"], "items": {"type": "string"}, "default": ["compiler/resources/**/*", "**/*.resx"]}
project-1.0.0-beta4.json
resourceExclude
Glob pattern to indicate files that need to be excluded from being compiled as resources. (data type: string or array with glob pattern(s))
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
resourceFiles
Glob pattern to indicate individual files that need to be compiled as resources. (data type: string or array).
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
shared
Glob pattern to specify the code files to share with dependent projects. Example: [ "folder1/*.cs", "folder2/*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "compiler/shared/**/*.cs"}
project-1.0.0-beta4.json
sharedExclude
Glob pattern to specify the code files to be excluded from sharing with dependent projects. Example: [ "folder1/*.cs", "folder2/*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
sharedFiles
Glob pattern to specify the individual code files to be shared with dependent projects. Example: [ "folder1/shared1.cs", "folder2/shared2.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
content
Glob pattern to specify the files to be considered as content on dnu publish. Example: [ "folder1/**/*" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": "**/*"}
project-1.0.0-beta4.json
contentExclude
Glob pattern to specify the files to be excluded from being content on dnu publish. Example: [ "folder1/*.cs", "folder2/*.cs" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
contentFiles
Glob pattern to specify the individual files to be content files on dnu publish. Example: [ "folder1/content.cs", "folder2/content2.img" ]
{"type": ["string", "array"], "items": {"type": "string"}, "default": ""}
project-1.0.0-beta4.json
configurations
Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"compilationOptions": {}}}}
project-1.0.0-beta4.json
copyright
Copyright details for the package
{"type": "string"}
project-1.0.0-beta4.json
description
The description of the application
{"type": "string"}
project-1.0.0-beta4.json
iconUrl
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.
{"type": "string"}
project-1.0.0-beta4.json
licenseUrl
A link to the license that the package is under
{"type": "string"}
project-1.0.0-beta4.json
projectUrl
A URL for the home page of the package
{"type": "string"}
project-1.0.0-beta4.json
scripts
Scripts to execute during the various stages.
{"type": "object", "properties": {"prepack": {}, "postpack": {}, "prepublish": {}, "postpublish": {}, "prerestore": {}, "postrestore": {}, "prepare": {}}}
project-1.0.0-beta4.json
summary
A short description of the package
{"type": "string"}
project-1.0.0-beta4.json
title
The human-friendly title of the package
{"type": "string"}
project-1.0.0-beta4.json
version
The version of the application. Example: 1.2.0.0
{"type": "string"}
project-1.0.0-beta4.json
webroot
Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.
{"type": "string"}
project-1.0.0-beta4.json
userSecretsId
Specify a unique id to manage the development time user secrets of the application
{"type": "string"}
cryproj.55.schema.json
cvars
CVar name
{"type": "string", "default": "sys_target_platforms", "enum": ["a_poseAlignerDebugDraw", "a_poseAlignerEnable", "a_poseAlignerForceLock", "a_poseAlignerForceNoIntersections", "a_poseAlignerForceNoRootOffset", "a_poseAlignerForceTargetSmoothing", "a_poseAlignerForceWeightOne", "ac_ColliderModeAI", "ac_ColliderModePlayer...
cryproj.55.schema.json
commands
Console command name
{"type": "string", "default": "", "enum": ["_TestFormatMessage", "ai_CheckGoalpipes", "ai_commTest", "ai_commTestStop", "ai_DebugAgent", "ai_debugMNMAgentType", "ai_MNMCalculateAccessibility", "ai_MNMComputeConnectedIslands", "ai_NavigationReloadConfig", "ai_Recorder_Start", "ai_Recorder_Stop", "ai_reload", "ai_resetCo...
cryproj.55.schema.json
value
The default value of the CVar
{"type": "string", "default": "pc,ps4,xboxone,linux"}
cryproj.55.schema.json
items
This indicates where the assets are stored
{"type": "string", "default": "Assets", "examples": ["Assets"]}
cryproj.55.schema.json
items
This indicates where the code is stored
{"type": "string", "default": "Code", "examples": ["Code"]}
cryproj.55.schema.json
name
This indicates the project name
{"type": "string", "default": "", "examples": ["MyFancyProject"]}
cryproj.55.schema.json
engine
This indicates which engine version will be used
{"type": "string", "default": "", "examples": ["engine-5.4"], "enum": ["engine-5.5"]}
cryproj.55.schema.json
path
Required plugin's name
{"type": "string", "examples": ["CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby"]}
cryproj.55.schema.json
type
EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one
{"type": "string", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"]}
cryproj.55.schema.json
value
Arguments that has to be passed to the command. Leave empty if it has not parameters
{"type": "string", "default": ""}
huskyrc.json
Husky can prevent bad `git commit`, `git push` and more 🐶 woof!
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"hook": {"type": "string", "x-intellij-language-injection": "Shell Script"}}, "properties": {"$schema": {"type": "string"}, "skipCI": {"type": "boolean", "default": false}, "hooks": {"type": "object", "properties": {"a...
huskyrc.json
applypatch-msg
This hook is invoked by git-am. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes git am to abort before applying the patch. The hook is allowed to edit the message file in place, and can be used to normalize the message into some projec...
{"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-am\">git-am</a>. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes <code>git am</code> to abort before applying the patch.</p>\n<p>The hook...