project.json

1.0.0-beta6

Schema URL

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

Properties

authors string[]
uniqueItems=true
bundleExclude string | array

List of files to exclude from publish output (kpm bundle).

Default: ""
code string | array

Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "Folder1*.cs", "Folder2*.cs" ]

Default: "**\*.cs"
commands Record<string, string>
compilationOptions object
8 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"
keyFile string
delaySign boolean
Default: false
strongName boolean
Default: false
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>
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

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[]
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 application

exclude string | array

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

Default:
[
  "bin/**/*.*",
  "obj/**/*.*"
]
frameworks Record<string, object>
namedResource Record<string, string>

Overrides the generated resource names with custom ones.

preprocess string

Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).

Default: "Compiler\Preprocess\**\*.cs"
repository Record<string, string>

Contains information about the repository where the project is stored.

1 nested properties
type string
Default: "git"
Values: "git"
resources string | array

Glob pattern to indicate all the files that need to be compiled as resources.

Default: "Compiler\Resources\**\*.cs"
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

prebundle 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

postbundle 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

shared string | array

Glob pattern to specify the code files to share with dependent projects. Example: [ "Folder1*.cs", "Folder2*.cs" ]

Default: "Compiler\Shared\**\*.cs"
version string

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

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.

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"
keyFile string
delaySign boolean
Default: false
strongName boolean
Default: false
configType object
dependencies Record<string, string | object>
compilationOptions object
8 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"
keyFile string
delaySign boolean
Default: false
strongName 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