config/definition
Type Aliases
Commands
type Commands = typeof commands;Defined in: src/cli-sdk/src/config/definition.ts:109
RecordField
type RecordField = typeof recordFields[number];Defined in: src/cli-sdk/src/config/definition.ts:130
Variables
commandAliases
const commandAliases: Map<string, string[]>;Defined in: src/cli-sdk/src/config/definition.ts:96
Canonical command names mapped to an array of its aliases
commands
const commands: object;Defined in: src/cli-sdk/src/config/definition.ts:88
Command aliases mapped to their canonical names
Type declaration
| Name | Type | Default value |
|---|---|---|
? | "help" | 'help' |
access | "access" | 'access' |
add | "install" | 'install' |
b | "build" | 'build' |
bugs | "bugs" | 'bugs' |
build | "build" | 'build' |
cache | "cache" | 'cache' |
ci | "ci" | 'ci' |
config | "config" | 'config' |
create | "create" | 'create' |
deprecate | "deprecate" | 'deprecate' |
dist-tag | "dist-tag" | 'dist-tag' |
docs | "docs" | 'docs' |
exec | "exec" | 'exec' |
exec-cache | "exec-cache" | 'exec-cache' |
exec-local | "exec-local" | 'exec-local' |
h | "help" | 'help' |
help | "help" | 'help' |
i | "install" | 'install' |
info | "view" | 'view' |
init | "init" | 'init' |
install | "install" | 'install' |
list | "list" | 'list' |
login | "login" | 'login' |
logout | "logout" | 'logout' |
ls | "list" | 'list' |
outdated | "outdated" | 'outdated' |
p | "pkg" | 'pkg' |
pack | "pack" | 'pack' |
ping | "ping" | 'ping' |
pkg | "pkg" | 'pkg' |
profile | "profile" | 'profile' |
pub | "publish" | 'publish' |
publish | "publish" | 'publish' |
q | "query" | 'query' |
query | "query" | 'query' |
r | "run" | 'run' |
registry | "registry" | 'registry' |
repo | "repo" | 'repo' |
rm | "uninstall" | 'uninstall' |
run | "run" | 'run' |
run-exec | "run-exec" | 'run-exec' |
run-script | "run" | 'run' |
rx | "run-exec" | 'run-exec' |
setup | "setup" | 'setup' |
show | "view" | 'view' |
token | "token" | 'token' |
u | "update" | 'update' |
uninstall | "uninstall" | 'uninstall' |
unpublish | "unpublish" | 'unpublish' |
update | "update" | 'update' |
version | "version" | 'version' |
view | "view" | 'view' |
whoami | "whoami" | 'whoami' |
x | "exec" | 'exec' |
xc | "exec-cache" | 'exec-cache' |
xl | "exec-local" | 'exec-local' |
defaultValues
const defaultValues: Record<string, unknown>;Defined in: src/cli-sdk/src/config/definition.ts:949
The pristine default of every known config field, captured here at
module load, before anything can call jack.setConfigValues().
Config layers are applied by overwriting jackspeak's defaults, and
setConfigValues() can only set them. So when a layer stops setting a
field (or removes it with null), the definitional default has to be
put back explicitly, otherwise a value left behind by a previous apply
would leak through.
defaultView
const defaultView: "human" | "json";Defined in: src/cli-sdk/src/config/definition.ts:5
definition
const definition: Jack<…>;Defined in: src/cli-sdk/src/config/definition.ts:168
recordFields
const recordFields: readonly ["git-hosts", "registries", "git-host-archives", "scoped-registries", "jsr-registries"];Defined in: src/cli-sdk/src/config/definition.ts:122
Fields that are parsed as a set of key=value pairs
storeLinkers
const storeLinkers: readonly ["auto", "hardlink", "clone", "copy", "unpack"];Defined in: src/cli-sdk/src/config/definition.ts:136
Valid store-linker values.
Functions
defaultEditor()
function defaultEditor(): stringDefined in: src/cli-sdk/src/config/definition.ts:14
Returns
string
getCommand()
function getCommand(s?):
| undefined
| "version"
| "registry"
| "cache"
| "config"
| "query"
| "help"
| "access"
| "bugs"
| "build"
| "ci"
| "create"
| "deprecate"
| "dist-tag"
| "docs"
| "exec"
| "exec-local"
| "init"
| "install"
| "login"
| "logout"
| "list"
| "outdated"
| "pack"
| "ping"
| "pkg"
| "profile"
| "publish"
| "repo"
| "run-exec"
| "run"
| "setup"
| "token"
| "uninstall"
| "unpublish"
| "update"
| "exec-cache"
| "view"
| "whoami"Defined in: src/cli-sdk/src/config/definition.ts:111
Parameters
| Parameter | Type |
|---|---|
s? | string |
Returns
| undefined
| "version"
| "registry"
| "cache"
| "config"
| "query"
| "help"
| "access"
| "bugs"
| "build"
| "ci"
| "create"
| "deprecate"
| "dist-tag"
| "docs"
| "exec"
| "exec-local"
| "init"
| "install"
| "login"
| "logout"
| "list"
| "outdated"
| "pack"
| "ping"
| "pkg"
| "profile"
| "publish"
| "repo"
| "run-exec"
| "run"
| "setup"
| "token"
| "uninstall"
| "unpublish"
| "update"
| "exec-cache"
| "view"
| "whoami"
getSortedCliOptions()
function getSortedCliOptions(): string[]Defined in: src/cli-sdk/src/config/definition.ts:957
Returns
string[]
getSortedKeys()
function getSortedKeys(): string[]Defined in: src/cli-sdk/src/config/definition.ts:968
Returns
string[]
isRecordField()
function isRecordField(s): s is "registries" | "scoped-registries" | "jsr-registries" | "git-hosts" | "git-host-archives"Defined in: src/cli-sdk/src/config/definition.ts:132
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
s is "registries" | "scoped-registries" | "jsr-registries" | "git-hosts" | "git-host-archives"