quarkdown-package-manager/com.quarkdown.pm.repo.github

Package-level declarations

Types

data class GitHubRepositoryCoordinates(val owner: String, val repository: String, val ref: String = DEFAULT_REF)

Location of a GitHub repository at a given ref, and the URLs needed to read parts of it anonymously. Path components are percent-encoded, so file names with spaces or reserved characters resolve correctly.

GitHubTree

@Serializable

data class GitHubTree(val sha: String, val tree: List<GitHubTreeEntry>, val truncated: Boolean = false)

Response of the GitHub Git Trees API.

GitHubTreeEntry

@Serializable

data class GitHubTreeEntry(val path: String, val type: String, val size: Long? = null)

A single entry of a GitHubTree.

GitHubTreeIndex

class GitHubTreeIndex(tree: GitHubTree)

Read-only directory queries over the files of a GitHubTree, whose paths are relative to the listed root.