quarkdown-package-manager/com.quarkdown.pm.model

Package-level declarations

Types

@Serializable

data class AtomManifest(val name: String, val version: String, val entrypoint: String, val description: String? = null, val authors: List<String> = emptyList(), val minQuarkdownVersion: String? = null, val categories: List<String> = emptyList(), val repository: String? = null, val license: String? = null)

Metadata of a package ("atom"), as declared in the atom table of its manifest.

PackageFile

data class PackageFile(val path: String, val content: () -> ByteArray)

A file belonging to a package.

PackageIdentifier

data class PackageIdentifier(val scope: String, val name: String)

Identifies a package independently of its version.

PackageManifest

@Serializable

data class PackageManifest(val atom: AtomManifest, val template: TemplateManifest? = null)

Root of a package manifest.

PackageReference

data class PackageReference(val identifier: PackageIdentifier, val version: String)

A reference to an exact version of a package, as written in Quarkdown source: @<scope>/<name>:<version>.

PackageRepository

interface PackageRepository

A source of packages, such as a remote Git repository.

RepositoryPackage

data class RepositoryPackage(val manifest: PackageManifest, val files: List<PackageFile>)

A package resolved from a PackageRepository.

TemplateManifest

@Serializable

data class TemplateManifest(val doctype: String? = null, val content: String, val additionalFiles: List<String> = emptyList(), val enforceTheme: Boolean = false)

Declaration that makes a package usable as a project template, as declared in the template table of its manifest.

Functions

download

fun RepositoryPackage.download(): VirtualFileSystem

Loads every file of this package into a new in-memory file system, rooted at /.

fun Iterable<PackageFile>.download(): VirtualFileSystem

Loads these files into a new in-memory file system, rooted at /, each at its package-relative path. The result can be read through the regular file system API, included into a document, or exported to disk via FsEntry.toOutputResources().

latestVersion

fun latestVersion(versions: Iterable<String>): String?

Picks the newest of versions by semantic-version precedence.