Index

Documents: usermanual.md.

Modules: cueconfig, cueconfig/config, cueconfig/exceptions, cueconfig/jsonextra, cueconfig/pathutil, cueconfig/util, cueconfig/vmutil.

API symbols

`$`:

• config: proc `$`(x: Config): string
• jsonextra: proc `$`(x: JsonSource): string
• jsonextra: proc `$`(s: SerializedJsonSource): string

`/`:

• pathutil: proc `/`(a: Path; b: string): Path
• pathutil: proc `/`(a: string; b: Path): Path

`{}`:

• jsonextra: proc `{}`(n: JsonSource; key: varargs[string]): JsonNode

checksumConfig:

• config: proc checksumConfig(): int

clear:

• cueconfig: template clear()

clearConfigAndRegistrations:

• config: proc clearConfigAndRegistrations(): void

cmpFiles:

• jsonextra: proc cmpFiles(a, b: tuple[key: Hash, val: JsonSource]): int

CodepathDefect:

• exceptions: object CodepathDefect

commit:

• cueconfig: template commit()

commitCompiletimeConfig:

• config: template commitCompiletimeConfig(): untyped

ConfigError:

• exceptions: object ConfigError

configHash:

• cueconfig: template configHash(): string

configHasKey:

• config: proc configHasKey(key: string): bool

contains:

• jsonextra: proc contains(n: JsonNode; key: varargs[string]): bool
• jsonextra: proc contains(n: JsonSource; key: varargs[string]): bool

deregister:

• cueconfig: template deregister(path: string)
• cueconfig: template deregister(searchpath: string; peg: string)

deregisterConfigFileSelector:

• config: proc deregisterConfigFileSelector(selector: FileSelector): void
• config: proc deregisterConfigFileSelector(path: string)
• config: proc deregisterConfigFileSelector(searchpath: string; peg: string)

deregisterEnv:

• cueconfig: template deregisterEnv(prefix: string)

deregisterEnvPrefix:

• config: proc deregisterEnvPrefix(envprefix: string): void

deserialize:

• jsonextra: proc deserialize(x: SerializedJsonSource): JsonSource

dualVar:

• util: template dualVar(name: untyped; Type: typedesc)

extant:

• vmutil: proc extant(p: Path): bool

FileSelector:

• jsonextra: object FileSelector

FileSelectorKind:

• jsonextra: enum FileSelectorKind

fskPath:

• jsonextra: FileSelectorKind.fskPath

fskPeg:

• jsonextra: FileSelectorKind.fskPeg

getConfig:

• config: proc getConfig[T](key: string): T
• config: template getConfig[T](key: varargs[string]): T

getConfigHash:

• config: proc getConfigHash(): string

getConfigNode:

• config: template getConfigNode(key: string): lent JsonNode
• config: template getConfigNode(key: varargs[string]): lent JsonNode

getContextDir:

• vmutil: proc getContextDir(): string

getCurrentDir:

• vmutil: proc getCurrentDir(): string

getField:

• util: macro getField(obj: typed; field: string; T: typedesc): untyped

getLastModificationTime:

• vmutil: proc getLastModificationTime(file: string): Time

hash:

• jsonextra: proc hash(x: FileSelector): Hash
• jsonextra: proc hash(x: JsonSource): Hash

initFileSelector:

• jsonextra: proc initFileSelector(path: Path; useJsonFallback = false; require = true): FileSelector
• jsonextra: proc initFileSelector(searchspace: Path; peg: string; useJsonFallback = false; require = true): FileSelector

initJsonSource:

• jsonextra: proc initJsonSource(s: FileSelector): seq[JsonSource]
• jsonextra: proc initJsonSource(path: Path; useJsonFallback = false): JsonSource
• jsonextra: proc initJsonSource(envprefix: string; caseInsensitive = true): JsonSource

inspect:

• cueconfig: template inspect(): string

interpolatedItems:

• jsonextra: iterator interpolatedItems(s: FileSelector; reverse = false): Path

isAbsolute:

• vmutil: proc isAbsolute(p: Path): bool

items:

• config: iterator items(x: SerializedConfig): SerializedJsonSource
• jsonextra: iterator items(s: FileSelector; reverse = false): Path

jsCue:

• jsonextra: JsonSourceKind.jsCue

jsEnv:

• jsonextra: JsonSourceKind.jsEnv

jsJson:

• jsonextra: JsonSourceKind.jsJson

JsonSource:

• jsonextra: object JsonSource

JsonSourceKind:

• jsonextra: enum JsonSourceKind

jsSops:

• jsonextra: JsonSourceKind.jsSops

match:

• jsonextra: proc match(x: FileSelector; path: string): bool
• jsonextra: proc match(x: FileSelector; path: string; peg: string): bool

pretty:

• jsonextra: proc pretty(x: JsonSource; indent: int = 2): seq[string]

register:

• cueconfig: template register(path: string; fallback: bool = false; require: bool = true)
• cueconfig: template register(searchdir: string; peg: string; fallback: bool = false; require = true)

registerConfigFileSelector:

• config: proc registerConfigFileSelector(selector: FileSelector): void
• config: proc registerConfigFileSelector(search: Path; peg: string; useJsonFallback = false; require = true): void
• config: proc registerConfigFileSelector(search: string; peg: string; useJsonFallback = false; require = true): void
• config: proc registerConfigFileSelector(pselector: varargs[Path]; useJsonFallback = false; require = true): void
• config: proc registerConfigFileSelector(paths: varargs[string]; useJsonFallback = false; require = true): void
• config: proc registerConfigFileSelector(patternSelectors: varargs[tuple[searchpath: string, peg: string, useJsonFallback = false, require = true]]): void
• config: proc registerConfigFileSelector(rxselectors: varargs[tuple[searchpath, peg: string]]; useJsonFallback = false; require = true): void

registerEnv:

• cueconfig: template registerEnv(prefix: string; caseSensitive: bool = false)

registerEnvPrefix:

• config: proc registerEnvPrefix(envprefix: string; caseInsensitive: bool = true): void

reload:

• config: proc reload()
• jsonextra: proc reload(x: var JsonSource): void

serialize:

• jsonextra: proc serialize(x: JsonSource): SerializedJsonSource

SerializedJsonSource:

• jsonextra: tuple SerializedJsonSource

showComittedRegistrations:

• config: proc showComittedRegistrations(): string

showConfig:

• config: proc showConfig(): string

showRegistrations:

• config: proc showRegistrations(): string

showSources:

• config: proc showSources(): string

StaticPath:

• vmutil: tuple StaticPath

staticWalkDirRec:

• vmutil: iterator staticWalkDirRec(path: Path | string; relative: bool; followLinks: bool = true): StaticPath