API Referencecli-sdk configconfig/definition

@vltpkg/cli-sdk/config/definition

Type Aliases

Commands

type Commands = typeof commands

Defined in: src/cli-sdk/src/config/definition.ts:108

RecordField

type RecordField = (typeof recordFields)[number]

Defined in: src/cli-sdk/src/config/definition.ts:129

Variables

commandAliases

const commandAliases: Map<string, string[]>

Defined in: src/cli-sdk/src/config/definition.ts:95

Canonical command names mapped to an array of its aliases

commands

const commands: object

Defined in: src/cli-sdk/src/config/definition.ts:87

Command aliases mapped to their canonical names

Type declaration

?

readonly ?: "help" = 'help';

access

readonly access: "access" = 'access';

add

readonly add: "install" = 'install';

b

readonly b: "build" = 'build';

bugs

readonly bugs: "bugs" = 'bugs';

build

readonly build: "build" = 'build';

cache

readonly cache: "cache" = 'cache';

ci

readonly ci: "ci" = 'ci';

config

readonly config: "config" = 'config';

create

readonly create: "create" = 'create';

deprecate

readonly deprecate: "deprecate" = 'deprecate';

dist-tag

readonly dist-tag: "dist-tag" = 'dist-tag';

docs

readonly docs: "docs" = 'docs';

exec

readonly exec: "exec" = 'exec';

exec-cache

readonly exec-cache: "exec-cache" = 'exec-cache';

exec-local

readonly exec-local: "exec-local" = 'exec-local';

h

readonly h: "help" = 'help';

help

readonly help: "help" = 'help';

i

readonly i: "install" = 'install';

info

readonly info: "view" = 'view';

init

readonly init: "init" = 'init';

install

readonly install: "install" = 'install';

list

readonly list: "list" = 'list';

readonly login: "login" = 'login';

logout

readonly logout: "logout" = 'logout';

ls

readonly ls: "list" = 'list';

p

readonly p: "pkg" = 'pkg';

pack

readonly pack: "pack" = 'pack';

ping

readonly ping: "ping" = 'ping';

pkg

readonly pkg: "pkg" = 'pkg';

profile

readonly profile: "profile" = 'profile';

pub

readonly pub: "publish" = 'publish';

publish

readonly publish: "publish" = 'publish';

q

readonly q: "query" = 'query';

query

readonly query: "query" = 'query';

r

readonly r: "run" = 'run';

registry

readonly registry: "registry" = 'registry';

repo

readonly repo: "repo" = 'repo';

rm

readonly rm: "uninstall" = 'uninstall';

run

readonly run: "run" = 'run';

run-exec

readonly run-exec: "run-exec" = 'run-exec';

run-script

readonly run-script: "run" = 'run';

rx

readonly rx: "run-exec" = 'run-exec';

setup

readonly setup: "setup" = 'setup';

show

readonly show: "view" = 'view';

token

readonly token: "token" = 'token';

u

readonly u: "update" = 'update';

uninstall

readonly uninstall: "uninstall" = 'uninstall';

unpublish

readonly unpublish: "unpublish" = 'unpublish';

update

readonly update: "update" = 'update';

version

readonly version: "version" = 'version';

view

readonly view: "view" = 'view';

whoami

readonly whoami: "whoami" = 'whoami';

x

readonly x: "exec" = 'exec';

xc

readonly xc: "exec-cache" = 'exec-cache';

xl

readonly xl: "exec-local" = 'exec-local';

defaultValues

const defaultValues: Record<string, unknown>

Defined in: src/cli-sdk/src/config/definition.ts:862

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<
  object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object &
    object
>

Defined in: src/cli-sdk/src/config/definition.ts:158

recordFields

const recordFields: readonly [
  'git-hosts',
  'registries',
  'git-host-archives',
  'scoped-registries',
  'jsr-registries',
]

Defined in: src/cli-sdk/src/config/definition.ts:121

Fields that are parsed as a set of key=value pairs

Functions

defaultEditor()

function defaultEditor(): string

Defined in: src/cli-sdk/src/config/definition.ts:14

Returns

string

getCommand()

function getCommand(
  s?,
):
  | undefined
  | 'registry'
  | 'cache'
  | 'config'
  | 'access'
  | 'bugs'
  | 'build'
  | 'ci'
  | 'create'
  | 'deprecate'
  | 'dist-tag'
  | 'docs'
  | 'exec'
  | 'exec-local'
  | 'help'
  | 'init'
  | 'install'
  | 'login'
  | 'logout'
  | 'list'
  | 'pack'
  | 'ping'
  | 'pkg'
  | 'profile'
  | 'publish'
  | 'query'
  | 'repo'
  | 'run-exec'
  | 'run'
  | 'setup'
  | 'token'
  | 'uninstall'
  | 'unpublish'
  | 'update'
  | 'exec-cache'
  | 'version'
  | 'view'
  | 'whoami'

Defined in: src/cli-sdk/src/config/definition.ts:110

Parameters

s?

string

Returns

getSortedCliOptions()

function getSortedCliOptions(): string[]

Defined in: src/cli-sdk/src/config/definition.ts:870

Returns

string[]

getSortedKeys()

function getSortedKeys(): string[]

Defined in: src/cli-sdk/src/config/definition.ts:881

Returns

string[]

isRecordField()

function isRecordField(
  s,
): s is
  | 'git-hosts'
  | 'registries'
  | 'git-host-archives'
  | 'scoped-registries'
  | 'jsr-registries'

Defined in: src/cli-sdk/src/config/definition.ts:131

On this page

@vltpkg/cli-sdk/config/definition

?