@wtf/release-docs 9.1.0 → 10.0.0

package/api/@wtf/release-system/system/interfaces/System.md

@@ -1,73 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / System
-
-# Interface: System
-
-Defined in: [packages/release-system/src/system.ts:116](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L116)
-
-What the libraries of a release do outside themselves.
-
-## Properties
-
-### cwd
-
-> `readonly` **cwd**: `string`
-
-Defined in: [packages/release-system/src/system.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L122)
-
-The working folder, which a relative path is of.
-
-***
-
-### env
-
-> `readonly` **env**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-Defined in: [packages/release-system/src/system.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L120)
-
-The environment, as a process is given it.
-
-***
-
-### exec
-
-> `readonly` **exec**: [`Exec`](../type-aliases/Exec.md)
-
-Defined in: [packages/release-system/src/system.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L118)
-
-***
-
-### fs
-
-> `readonly` **fs**: [`SystemFs`](SystemFs.md)
-
-Defined in: [packages/release-system/src/system.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L117)
-
-***
-
-### tmpdir
-
-> `readonly` **tmpdir**: `string`
-
-Defined in: [packages/release-system/src/system.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L124)
-
-A folder of temporary files, outside the repo, as the packages of a release are staged in.
-
-## Methods
-
-### now()
-
-> **now**(): `Date`
-
-Defined in: [packages/release-system/src/system.ts:130](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L130)
-
-The time now, as a changelog dates a release.
-
-#### Returns
-
-`Date`
-
-The date and the time of the system's clock.

package/api/@wtf/release-system/system/interfaces/SystemFs.md

@@ -1,184 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / SystemFs
-
-# Interface: SystemFs
-
-Defined in: [packages/release-system/src/system.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L31)
-
-The files of a system, each by its absolute path, as text.
-
-## Methods
-
-### copy()
-
-> **copy**(`from`, `to`): `Promise`\<`void`\>
-
-Defined in: [packages/release-system/src/system.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L79)
-
-Copies the file or the folder `from` to `to`, and what it holds, byte for byte, and the folder
-of `to` where it is not there.
-
-#### Parameters
-
-##### from
-
-`string`
-
-The absolute path of the file or the folder to copy.
-
-##### to
-
-`string`
-
-The absolute path of the copy, written over where it is there.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### exists()
-
-> **exists**(`path`): `Promise`\<`boolean`\>
-
-Defined in: [packages/release-system/src/system.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L59)
-
-Whether there is a file or a folder at `path`.
-
-#### Parameters
-
-##### path
-
-`string`
-
-The absolute path of the file or the folder.
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-Whether there is one.
-
-***
-
-### mkdir()
-
-> **mkdir**(`path`): `Promise`\<`void`\>
-
-Defined in: [packages/release-system/src/system.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L65)
-
-Makes the folder `path`, and each folder above it that is not there.
-
-#### Parameters
-
-##### path
-
-`string`
-
-The absolute path of the folder: nothing to make where it is there.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### readdir()
-
-> **readdir**(`path`): `Promise`\<[`DirEntry`](DirEntry.md)[]\>
-
-Defined in: [packages/release-system/src/system.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L52)
-
-The entries of the folder `path`.
-
-#### Parameters
-
-##### path
-
-`string`
-
-The absolute path of the folder.
-
-#### Returns
-
-`Promise`\<[`DirEntry`](DirEntry.md)[]\>
-
-The entries of the folder, each of its name and whether it is a folder.
-
-***
-
-### readFile()
-
-> **readFile**(`path`): `Promise`\<`string`\>
-
-Defined in: [packages/release-system/src/system.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L38)
-
-The text of the file `path`, as UTF-8.
-
-#### Parameters
-
-##### path
-
-`string`
-
-The absolute path of the file.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The text of the file, whole.
-
-***
-
-### rm()
-
-> **rm**(`path`): `Promise`\<`void`\>
-
-Defined in: [packages/release-system/src/system.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L71)
-
-Removes the file or the folder `path`, and what it holds; nothing, where it is not there.
-
-#### Parameters
-
-##### path
-
-`string`
-
-The absolute path of the file or the folder.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### writeFile()
-
-> **writeFile**(`path`, `text`): `Promise`\<`void`\>
-
-Defined in: [packages/release-system/src/system.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L45)
-
-Writes `text` into the file `path`, as UTF-8, and its folder where it is not there.
-
-#### Parameters
-
-##### path
-
-`string`
-
-The absolute path of the file, written over where it is there.
-
-##### text
-
-`string`
-
-The text of the file, whole.
-
-#### Returns
-
-`Promise`\<`void`\>

package/api/@wtf/release-system/system/type-aliases/Exec.md

@@ -1,41 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / Exec
-
-# Type Alias: Exec
-
-> **Exec** = (`command`, `args`, `options?`) => `Promise`\<[`ExecResult`](../interfaces/ExecResult.md)\>
-
-Defined in: [packages/release-system/src/system.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L109)
-
-Runs `command` with `args`, and gives what it wrote and its exit code: a code other than 0 is
-no failure of its own, which the caller decides. A command that cannot start rejects.
-
-## Parameters
-
-### command
-
-`string`
-
-The command, by its name on the path of the environment or by its path.
-
-### args
-
-readonly `string`[]
-
-The arguments of the command, each as it is, of no shell.
-
-### options?
-
-[`ExecOptions`](../interfaces/ExecOptions.md)
-
-The folder it runs in, its environment and its input on stdin: the folder and
-the environment of the system, and no input, by default.
-
-## Returns
-
-`Promise`\<[`ExecResult`](../interfaces/ExecResult.md)\>
-
-What the process wrote, on its stdout and its stderr, as UTF-8, and its exit code.

package/api/@wtf/release-system/system/type-aliases/SystemInput.md

@@ -1,20 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / SystemInput
-
-# Type Alias: SystemInput
-
-> **SystemInput** = `Partial`\<`Omit`\<[`System`](../interfaces/System.md), `"fs"`\>\> & `object`
-
-Defined in: [packages/release-system/src/system.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L137)
-
-A system as the option of a plugin gives one: each member it replaces of the system the plugin
-makes, and each of the files it replaces.
-
-## Type Declaration
-
-### fs?
-
-> `readonly` `optional` **fs?**: `Partial`\<[`SystemFs`](../interfaces/SystemFs.md)\>

package/api/@wtf/release-system/validator/interfaces/OptionIssue.md

@@ -1,63 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / OptionIssue
-
-# Interface: OptionIssue
-
-Defined in: [packages/release-system/src/validator.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L43)
-
-An issue of a validator: what is wrong, where, the code of its error, and how to fix it.
-
-## Extends
-
-- `Issue`
-
-## Properties
-
-### code
-
-> `readonly` **code**: `string`
-
-Defined in: [packages/release-system/src/validator.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L47)
-
-The code of the error it makes, as `ETRAINPATHS`, or `EOPTIONS` of an option.
-
-***
-
-### details
-
-> `readonly` **details**: `string`
-
-Defined in: [packages/release-system/src/validator.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L49)
-
-How to fix it.
-
-***
-
-### message
-
-> `readonly` **message**: `string`
-
-Defined in: node\_modules/.pnpm/@standard-schema+spec@1.1.0/node\_modules/@standard-schema/spec/dist/index.d.ts:60
-
-The error message of the issue.
-
-#### Inherited from
-
-`StandardSchemaV1.Issue.message`
-
-***
-
-### path
-
-> `readonly` **path**: [`Path`](../type-aliases/Path.md)
-
-Defined in: [packages/release-system/src/validator.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L45)
-
-Where, in the value.
-
-#### Overrides
-
-`StandardSchemaV1.Issue.path`

package/api/@wtf/release-system/validator/interfaces/Property.md

@@ -1,49 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / Property
-
-# Interface: Property\<T\>
-
-Defined in: [packages/release-system/src/validator.ts:324](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L324)
-
-A property of an object a validator checks: its validator, and whether it may be missing.
-
-## Type Parameters
-
-### T
-
-`T`
-
-The type of its value.
-
-## Properties
-
-### missing?
-
-> `readonly` `optional` **missing?**: [`IssueOptions`](IssueOptions.md)
-
-Defined in: [packages/release-system/src/validator.ts:330](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L330)
-
-The issue of it missing, where it is required.
-
-***
-
-### of
-
-> `readonly` **of**: [`Validator`](Validator.md)\<`T`\>
-
-Defined in: [packages/release-system/src/validator.ts:326](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L326)
-
-The validator of its value.
-
-***
-
-### optional?
-
-> `readonly` `optional` **optional?**: `boolean`
-
-Defined in: [packages/release-system/src/validator.ts:328](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L328)
-
-Whether it may be missing: it is required otherwise.

package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md

@@ -1,17 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / JsonSchema
-
-# Type Alias: JsonSchema
-
-> **JsonSchema** = `object`
-
-Defined in: [packages/release-system/src/validator.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L37)
-
-A JSON Schema, of draft 2020-12, as data.
-
-## Index Signature
-
-\[`key`: `string`\]: `unknown`

package/api/@wtf/release-system/validator/type-aliases/Path.md

@@ -1,13 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / Path
-
-# Type Alias: Path
-
-> **Path** = readonly (`string` \| `number`)[]
-
-Defined in: [packages/release-system/src/validator.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/validator.ts#L40)
-
-The path of a value in the options, as `['trains', 'core', 'paths']`.

package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md

@@ -1,27 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / isEcosystem
-
-# Function: isEcosystem()
-
-> **isEcosystem**(`value`): `value is Ecosystem`
-
-Defined in: [packages/release-trains/src/ecosystem.ts:132](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L132)
-
-Whether `value` is an [Ecosystem](../interfaces/Ecosystem.md): of a name, and the three methods.
-
-## Parameters
-
-### value
-
-`unknown`
-
-What a module gives, as its default export.
-
-## Returns
-
-`value is Ecosystem`
-
-Whether it is an ecosystem.

package/api/@wtf/release-trains/ecosystem/functions/readPackages.md

@@ -1,33 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / readPackages
-
-# Function: readPackages()
-
-> **readPackages**(`ecosystems`, `context`): `Promise`\<[`EcosystemPackages`](../interfaces/EcosystemPackages.md)[]\>
-
-Defined in: [packages/release-trains/src/ecosystem.ts:227](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L227)
-
-The packages of each ecosystem of `ecosystems` in the repo of `context`, at its `ref`.
-
-## Parameters
-
-### ecosystems
-
-readonly [`Ecosystem`](../interfaces/Ecosystem.md)[]
-
-The ecosystems of the repo, as a config names them.
-
-### context
-
-[`EcosystemContext`](../interfaces/EcosystemContext.md)
-
-The folder of the repo, its environment, the system, and the commit.
-
-## Returns
-
-`Promise`\<[`EcosystemPackages`](../interfaces/EcosystemPackages.md)[]\>
-
-The packages of each ecosystem, in the order of `ecosystems`.

package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md

@@ -1,43 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / Dependency
-
-# Interface: Dependency
-
-Defined in: [packages/release-trains/src/ecosystem.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L46)
-
-A dependency of a package on another package of its ecosystem in the repo.
-
-## Properties
-
-### kind
-
-> `readonly` **kind**: [`DependencyKind`](../type-aliases/DependencyKind.md)
-
-Defined in: [packages/release-trains/src/ecosystem.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L50)
-
-How it depends on it.
-
-***
-
-### name
-
-> `readonly` **name**: `string`
-
-Defined in: [packages/release-trains/src/ecosystem.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L48)
-
-The name of the package it depends on, of the same ecosystem, in this repo.
-
-***
-
-### range
-
-> `readonly` **range**: `string` \| `undefined`
-
-Defined in: [packages/release-trains/src/ecosystem.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L56)
-
-The range as the manifest writes it, which a release publishes of the version of the package
-it names, by [Ecosystem.resolve](Ecosystem.md#resolve), as `workspace:^` of npm; `undefined` where nothing of it
-reaches the registry, as of a dependency a package drops as it publishes.

package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md

@@ -1,68 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / EcosystemContext
-
-# Interface: EcosystemContext
-
-Defined in: [packages/release-trains/src/ecosystem.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L80)
-
-Where an ecosystem reads its packages: the repo, its environment, the system, and the commit.
-
-## Extends
-
-- [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
-
-## Properties
-
-### cwd?
-
-> `readonly` `optional` **cwd?**: `string`
-
-Defined in: [packages/release-system/src/git.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L26)
-
-The folder of the repo: the system's working folder by default.
-
-#### Inherited from
-
-[`GitContext`](../../../release-system/git/interfaces/GitContext.md).[`cwd`](../../../release-system/git/interfaces/GitContext.md#cwd)
-
-***
-
-### env?
-
-> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-Defined in: [packages/release-system/src/git.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L28)
-
-The environment of git: the system's by default.
-
-#### Inherited from
-
-[`GitContext`](../../../release-system/git/interfaces/GitContext.md).[`env`](../../../release-system/git/interfaces/GitContext.md#env)
-
-***
-
-### ref?
-
-> `readonly` `optional` **ref?**: `string`
-
-Defined in: [packages/release-trains/src/ecosystem.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L85)
-
-The commit to read the packages at, by git, as `HEAD` or the tag of a release: the files of the
-working tree that git tracks by default.
-
-***
-
-### system
-
-> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
-
-Defined in: [packages/release-system/src/git.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L30)
-
-The system git runs by, which it requires.
-
-#### Inherited from
-
-[`GitContext`](../../../release-system/git/interfaces/GitContext.md).[`system`](../../../release-system/git/interfaces/GitContext.md#system)

package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md

@@ -1,27 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / EcosystemPackages
-
-# Interface: EcosystemPackages
-
-Defined in: [packages/release-trains/src/ecosystem.ts:215](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L215)
-
-The packages of one ecosystem of a repo, as [readPackages](../functions/readPackages.md) reads them.
-
-## Properties
-
-### ecosystem
-
-> `readonly` **ecosystem**: [`Ecosystem`](Ecosystem.md)
-
-Defined in: [packages/release-trains/src/ecosystem.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L216)
-
-***
-
-### packages
-
-> `readonly` **packages**: readonly [`Package`](Package.md)[]
-
-Defined in: [packages/release-trains/src/ecosystem.ts:217](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L217)