Packages > pkl > pkl.Project

Package0.28.0

Properties
Methods

class Package

Known subtypes:
Known usages:
All versions:

Properties

link
name: String

The name of this package.
The package name is only used for display purposes.

Example:
```
name = "myproject"
```
link
baseUri: Uri(startsWith("package:"))

The URI that the package is published to, without the version part.
This, along with the version, determines the import path for modules and resources published by this package.

Example:
```
baseUri = "package://example.com/myproject"
```
link
version: String(semver.isValid(this))

The version of this package.
Must adhere to semantic versioning.

Example:
```
version = "1.5.0"
```
link
packageZipUrl: Uri(startsWith("https:"))

The HTTPS location for the zip archive for this package.
Example:
```
packageZipUrl = "https://example.com/artifacts/myproject/\(version).zip"
```
link

description: String?

The description of this package.
link
authors: Listing<EmailAddress>

The maintainers' emails for this package.
Email addresses must adhere to RFC5322 mailbox specification.

Example:
```
email { "Johnny Appleseed <johnny.appleseed@example.com>" }
```
link
website: String?

The website for this package.
Example:
```
website = "https://example.com/myproject"
```
link

documentation: Uri(!endsWith("/"))?

The web URL of the Pkldoc documentation for this package.
link
sourceCode: String?

The source code repository for this package.
Example:
```
sourceCode = "https://github.com/myorg/myproject"
```
link
sourceCodeUrlScheme: String?

The source code scheme for this package.
This is used to transform stack frames for errors arising for this package.

The following placeholders are available:
- %{path} absolute file path of the file to open
- %{line} start line number to navigate to
- %{endLine} end line number to navigate to
- %{column} column number to navigate to
- %{endColumn} end column number to navigate to
For example, if publishing to GitHub, assuming that the version gets published as a tag:
```
sourceCodeUrlScheme = "\(sourceCode)/blob/\(version)%{path}#L%{line}-L%{endLine}"
```
link
license: (CommonSpdxLicenseIdentifier|String)?

The license associated with this package.
If using a common license, use its SPDX license identifier.

If using multiple common licenses, use a SPDX license expression syntax version 2.0 string. For example: "Apache-2.0 or MIT".

If using an uncommon license, also provide its full text in the licenseText property.

Example:
```
license = "Apache-2.0"
```
link

licenseText: String?

The full text of the license associated with this package.
link

issueTracker: String?

The web URL of the issue tracker for this package.
link
apiTests: Listing<String>(isDistinct)

Paths to the tests that define the API of the package.
These tests are run as part of the pkl project package command.

Relative paths are resolved against PklProject's enclosing directory.

Glob imports can be useful for defining this property.

Example:
```
tests = import*("**.test.pkl").keys.toListing()
```
link

exclude: Listing<String>

Glob patterns describing the set of files to exclude from packaging.

By default, the project manifest files are excluded, and any paths that start with a dot.

Glob patterns follows the same glob rules as glob imports and reads.
link

uri: PackageUri

The effective package URI for the package represented by this project.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.