project-1.0.0-beta4.json

ASP.NET vNext project configuration file

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/project-1-0-0-beta4-json/latest.json
Source https://www.schemastore.org/project-1.0.0-beta4.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

authors string[]
uniqueItems=true
publishExclude string | array

List of files to exclude from publish output (dnu publish).

Default: ""
compile string | array

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

Default: ""
compileExclude string | array

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

Default: ""
compileFiles string | array

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

Default: ""
compileBuiltIn string | array

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

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

Glob pattern to indicate the default files to be excluded from processing. (data type: string or array with glob pattern(s)).

Default: ""
excludeBuiltIn string | array

Glob pattern to indicate all the additional files to be excluded from processing. (data type: string or array with glob pattern(s)).

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

Glob pattern to indicate all the code files to be pre-processed. (data type: string or array with glob pattern(s)).

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

Glob pattern to indicate all the code files to be excluded from pre-processing. (data type: string or array with glob pattern(s)).

Default: ""
preprocessFiles string | array

Glob pattern to indicate specific code files to be included for pre-processing. (data type: string or array).

Default: ""
resource string | array

Glob pattern to indicate all the files that need to be compiled as resources. (data type: string or array with glob pattern(s))

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

Glob pattern to indicate files that need to be excluded from being compiled as resources. (data type: string or array with glob pattern(s))

Default: ""
resourceFiles string | array

Glob pattern to indicate individual files that need to be compiled as resources. (data type: string or array).

Default: ""
shared string | array

Glob pattern to specify the code files to share with dependent projects. Example: [ "folder1/.cs", "folder2/.cs" ]

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

Glob pattern to specify the code files to be excluded from sharing with dependent projects. Example: [ "folder1/.cs", "folder2/.cs" ]

Default: ""
sharedFiles string | array

Glob pattern to specify the individual code files to be shared with dependent projects. Example: [ "folder1/shared1.cs", "folder2/shared2.cs" ]

Default: ""
content string | array

Glob pattern to specify the files to be considered as content on dnu publish. Example: [ "folder1/**/*" ]

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

Glob pattern to specify the files to be excluded from being content on dnu publish. Example: [ "folder1/.cs", "folder2/.cs" ]

Default: ""
contentFiles string | array

Glob pattern to specify the individual files to be content files on dnu publish. Example: [ "folder1/content.cs", "folder2/content2.img" ]

Default: ""
commands Record<string, string>
compilationOptions object
5 nested properties
define string[]
uniqueItems=true
warningsAsErrors boolean
Default: false
allowUnsafe boolean
Default: false
optimize boolean
Default: false
languageVersion string
Values: "csharp1" "csharp2" "csharp3" "csharp4" "csharp5" "csharp6" "experimental"
configurations Record<string, object>

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

dependencies Record<string, string | object>
description string

The description of the application

frameworks Record<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 that the package is under

owners string[]
uniqueItems=true
projectUrl string

A URL for the home page of the package

scripts object

Scripts to execute during the various stages.

7 nested properties
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

summary string

A short description of the package

tags string[]
uniqueItems=true
title string

The human-friendly title of the package

version string

The version of the application. Example: 1.2.0.0

webroot string

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.

userSecretsId string

Specify a unique id to manage the development time user secrets of the application

Definitions

compilationOptions object
define string[]
uniqueItems=true
warningsAsErrors boolean
Default: false
allowUnsafe boolean
Default: false
optimize boolean
Default: false
languageVersion string
Values: "csharp1" "csharp2" "csharp3" "csharp4" "csharp5" "csharp6" "experimental"
configType object
dependencies Record<string, string | object>
compilationOptions object
5 nested properties
define string[]
uniqueItems=true
warningsAsErrors boolean
Default: false
allowUnsafe boolean
Default: false
optimize boolean
Default: false
languageVersion string
Values: "csharp1" "csharp2" "csharp3" "csharp4" "csharp5" "csharp6" "experimental"
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