project.json

1.0.0-rc1

Schema URL

https://catalog.lintel.tools/schemas/schemastore/project-json/versions/1.0.0-rc1.json
← Back to project.json
Type: object

Properties

authors string[]
uniqueItems=true
packInclude object

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

publishExclude string | array

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

Default:
[
  "obj/**/*.*",
  "bin/**/*.*",
  "**/.*/**"
]
compile string | array

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

Default: "**/*.cs"
compileExclude string | array

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

compileFiles string | array

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

content string | array

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

Default: "**/*"
contentExclude string | array

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" ]

contentFiles string | array

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

preprocess string | array

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

Default: "compiler/preprocess/**/*.cs"
preprocessExclude string | array

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" ]

preprocessFiles string | array

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

resource string | array

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

Default:
[
  "compiler/resources/**/*",
  "**/*.resx"
]
resourceExclude string | array

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" ]

resourceFiles string | array

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

shared string | array

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

Default: "compiler/shared/**/*.cs"
sharedExclude string | array

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" ]

sharedFiles string | array

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

exclude string | array

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" ]

excludeBuiltIn string | array

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"
]
commands Record<string, string>
compilationOptions object
9 nested properties
define string[]
uniqueItems=true
warningsAsErrors boolean
Default: false
allowUnsafe boolean
Default: false
emitEntryPoint boolean
Default: false
optimize boolean
Default: false
languageVersion string
Values: "csharp1" "csharp2" "csharp3" "csharp4" "csharp5" "csharp6" "experimental"
keyFile string
delaySign boolean
Default: false
useOssSigning boolean
Default: false
configurations Record<string, object>

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

dependencies Record<string, string | object>
iconUrl string

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.

licenseUrl string

A link to the license for the package.

requireLicenseAcceptance boolean

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.

Default: false
owners string[]
uniqueItems=true
projectUrl string

A URL for the home page of the package.

summary string

A short description of the package.

tags string[]

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

uniqueItems=true
title string

The human-friendly title of the package

releaseNotes string

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

language string

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

description string

The description of the project/package.

frameworks Record<string, object>
namedResource Record<string, string>

Overrides the generated resource names with custom ones.

repository Record<string, string>

Contains information about the repository where the project is stored.

2 nested properties
type string
Default: "git"
Values: "git"
url string
format=uri
scripts object

Scripts to execute during the various stages.

9 nested properties
prebuild string | array

A command line script or scripts.

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

postbuild string | array

A command line script or scripts.

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

prepack string | array

A command line script or scripts.

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

postpack string | array

A command line script or scripts.

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

prepublish string | array

A command line script or scripts.

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

postpublish string | array

A command line script or scripts.

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

prerestore string | array

A command line script or scripts.

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

postrestore string | array

A command line script or scripts.

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

prepare string | array

A command line script or scripts.

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

version string

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

Definitions

compilationOptions object
define string[]
uniqueItems=true
warningsAsErrors boolean
Default: false
allowUnsafe boolean
Default: false
emitEntryPoint boolean
Default: false
optimize boolean
Default: false
languageVersion string
Values: "csharp1" "csharp2" "csharp3" "csharp4" "csharp5" "csharp6" "experimental"
keyFile string
delaySign boolean
Default: false
useOssSigning boolean
Default: false
configType object
dependencies Record<string, string | object>
compilationOptions object
9 nested properties
define string[]
uniqueItems=true
warningsAsErrors boolean
Default: false
allowUnsafe boolean
Default: false
emitEntryPoint boolean
Default: false
optimize boolean
Default: false
languageVersion string
Values: "csharp1" "csharp2" "csharp3" "csharp4" "csharp5" "csharp6" "experimental"
keyFile string
delaySign boolean
Default: false
useOssSigning boolean
Default: false
frameworkAssemblies Record<string, string | object>
dependencies Record<string, string | object>
script string | array

A command line script or scripts.

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