relizy / ConfigOptionNode
Interface: ConfigOptionNode
Defined in: packages/relizy/src/core/config-options.ts:8
One option of relizy.config.ts, with the options nested in it
Properties
children
children:
ConfigOptionNode[]
Defined in: packages/relizy/src/core/config-options.ts:29
default?
optionaldefault?:unknown
Defined in: packages/relizy/src/core/config-options.ts:18
The default of the option, none when it depends on the project or has no default
deprecated?
optionaldeprecated?:string
Defined in: packages/relizy/src/core/config-options.ts:23
description
description:
string
Defined in: packages/relizy/src/core/config-options.ts:20
What the option does, in markdown
docId
docId:
string
Defined in: packages/relizy/src/core/config-options.ts:26
Doc page of the option, for get_doc of the MCP server: config/bump
docUrl
docUrl:
string
Defined in: packages/relizy/src/core/config-options.ts:28
URL of the doc page
key
key:
string
Defined in: packages/relizy/src/core/config-options.ts:12
Last segment of the path: type
path
path:
string
Defined in: packages/relizy/src/core/config-options.ts:10
Dotted path, [] for the items of an array and * for the entries of a record: bump.type, monorepo.groups[].name, profiles.*.bump.type
see?
optionalsee?:string
Defined in: packages/relizy/src/core/config-options.ts:24
summary
summary:
string
Defined in: packages/relizy/src/core/config-options.ts:22
The first paragraph of the description, on one line
type
type:
string
Defined in: packages/relizy/src/core/config-options.ts:14
The type as written in the types of relizy: boolean, string[], VersionMode, BumpConfig
values?
optionalvalues?:string[]
Defined in: packages/relizy/src/core/config-options.ts:16
The values the type accepts when it hides them behind an alias: ['unified', 'selective', 'independent']