@wtf/release-docs 9.1.0 → 10.0.0

package/api/@wtf/release-oci/tags/functions/releaseTagsOf.md

@@ -1,39 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-oci/tags](../README.md) / releaseTagsOf
-
-# Function: releaseTagsOf()
-
-> **releaseTagsOf**(`version`, `moving?`): [`ReleaseTags`](../interfaces/ReleaseTags.md)
-
-Defined in: [packages/release-oci/src/tags.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/tags.ts#L36)
-
-The tags of a release of `version`: the version, and of a release, its minor and its major, which
-move; of a release of the major `0`, its minor alone, as a minor of `0` breaks what the one before
-gave; of a prerelease, none that moves.
-
-## Parameters
-
-### version
-
-`string`
-
-The version of the release, as `1.4.2`.
-
-### moving?
-
-`boolean` = `true`
-
-Whether a release moves its minor and its major: `true` by default.
-
-## Returns
-
-[`ReleaseTags`](../interfaces/ReleaseTags.md)
-
-The tags.
-
-## Throws
-
-`TypeError` of a version that is no semver.

package/api/@wtf/release-oci/tags/functions/tagsOfRelease.md

@@ -1,33 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-oci/tags](../README.md) / tagsOfRelease
-
-# Function: tagsOfRelease()
-
-> **tagsOfRelease**(`version`, `moving?`): `string`[]
-
-Defined in: [packages/release-oci/src/tags.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/tags.ts#L54)
-
-Every tag of a release of `version`, the version first (see [releaseTagsOf](releaseTagsOf.md)).
-
-## Parameters
-
-### version
-
-`string`
-
-The version of the release, as `1.4.2`.
-
-### moving?
-
-`boolean` = `true`
-
-Whether a release moves its minor and its major: `true` by default.
-
-## Returns
-
-`string`[]
-
-The tags, as `['1.4.2', '1.4', '1']`.

package/api/@wtf/release-system/README.md

@@ -1,71 +0,0 @@
-[**Release trains**](../../README.md)
-
-***
-
-[Release trains](../../README.md) / @wtf/release-system
-
-# @wtf/release-system
-
-What the libraries of a release do outside themselves, of no release tool and of no train: a
-library takes the [System](system/interfaces/System.md) its caller gives it, and names no Node of its own. This module
-holds the types of the system; the code is at the subpaths:
-
-- `./system`: the [System](system/interfaces/System.md) every function of the libraries requires, which its caller
-  gives it;
-- `./node`: Node's system, the one module that names Node, for a caller that runs on Node;
-- `./posix`: paths as POSIX writes them, of no system;
-- `./paths`: whether a file is of a set of paths and globs, and a path as they are compared;
-- `./git`: git of a repo, its tracked files, the files of each commit, and the commits since a
-  ref;
-- `./validator`: validators of options, each a Standard Schema and a Standard JSON Schema, and the
-  errors of their issues;
-- `./errors`: `ReleaseError`, of a stable code and details of how to fix it, which the errors of
-  every package over this one extend.
-
-```ts
-import type { System } from '@wtf/release-system'
-
-export const cwdOf = (system: System): string => system.cwd
-```
-
-## References
-
-### DirEntry
-
-Re-exports [DirEntry](system/interfaces/DirEntry.md)
-
-***
-
-### Exec
-
-Re-exports [Exec](system/type-aliases/Exec.md)
-
-***
-
-### ExecOptions
-
-Re-exports [ExecOptions](system/interfaces/ExecOptions.md)
-
-***
-
-### ExecResult
-
-Re-exports [ExecResult](system/interfaces/ExecResult.md)
-
-***
-
-### System
-
-Re-exports [System](system/interfaces/System.md)
-
-***
-
-### SystemFs
-
-Re-exports [SystemFs](system/interfaces/SystemFs.md)
-
-***
-
-### SystemInput
-
-Re-exports [SystemInput](system/type-aliases/SystemInput.md)

package/api/@wtf/release-system/errors/README.md

@@ -1,42 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / @wtf/release-system/errors
-
-# @wtf/release-system/errors
-
-What the packages of a release throw: [ReleaseError](classes/ReleaseError.md), of a stable `code`, a `message` of
-what is wrong, and `details` of how to fix it. It is a `SemanticReleaseError` in all but its
-class: semantic-release prints an error by its `semanticRelease` mark, its code, its message and
-its details, and so prints this one. Each package over this one throws errors of a class of its
-own that extends it, as `TrainsError` of `@wtf/release-trains/errors`; this package throws
-`ReleaseError` itself, of the codes of [SYSTEM\_ERRORS](variables/SYSTEM_ERRORS.md). A step that finds several faults
-throws them together, in an `AggregateError` ([throwAll](functions/throwAll.md)), which semantic-release prints one
-by one.
-
-```ts
-import { ReleaseError, throwAll } from '@wtf/release-system/errors'
-
-// The errors of a package of its own, of its own codes.
-export class DeployError extends ReleaseError {}
-
-throwAll([]) // nothing
-```
-
-## Classes
-
-- [ReleaseError](classes/ReleaseError.md)
-
-## Type Aliases
-
-- [ErrorClass](type-aliases/ErrorClass.md)
-- [SystemErrorCode](type-aliases/SystemErrorCode.md)
-
-## Variables
-
-- [SYSTEM\_ERRORS](variables/SYSTEM_ERRORS.md)
-
-## Functions
-
-- [throwAll](functions/throwAll.md)

package/api/@wtf/release-system/errors/functions/throwAll.md

@@ -1,26 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/errors](../README.md) / throwAll
-
-# Function: throwAll()
-
-> **throwAll**(`errors`): `void`
-
-Defined in: [packages/release-system/src/errors.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L84)
-
-Throws `errors`: nothing when there are none, the one when there is one, or all of them in an
-`AggregateError`, which semantic-release prints one by one.
-
-## Parameters
-
-### errors
-
-readonly [`ReleaseError`](../classes/ReleaseError.md)[]
-
-The faults a step found, of any count, in the order they are printed.
-
-## Returns
-
-`void`

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

@@ -1,13 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/errors](../README.md) / SystemErrorCode
-
-# Type Alias: SystemErrorCode
-
-> **SystemErrorCode** = keyof *typeof* [`SYSTEM_ERRORS`](../variables/SYSTEM_ERRORS.md)
-
-Defined in: [packages/release-system/src/errors.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L31)
-
-A code of [SYSTEM\_ERRORS](../variables/SYSTEM_ERRORS.md).

package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md

@@ -1,23 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/errors](../README.md) / SYSTEM\_ERRORS
-
-# Variable: SYSTEM\_ERRORS
-
-> `const` **SYSTEM\_ERRORS**: `object`
-
-Defined in: [packages/release-system/src/errors.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L25)
-
-The codes of the errors of this package, each with what it means.
-
-## Type Declaration
-
-### EGIT
-
-> `readonly` **EGIT**: `"git failed."` = `'git failed.'`
-
-### EOPTIONS
-
-> `readonly` **EOPTIONS**: `"An option is missing, or is not one it takes, as a validator of options finds it."` = `'An option is missing, or is not one it takes, as a validator of options finds it.'`

package/api/@wtf/release-system/git/functions/gitOf.md

@@ -1,39 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/git](../README.md) / gitOf
-
-# Function: gitOf()
-
-> **gitOf**(`context`): `object`
-
-Defined in: [packages/release-system/src/git.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L39)
-
-The folder, the environment and the system of a context, each of its default.
-
-## Parameters
-
-### context
-
-[`GitContext`](../interfaces/GitContext.md)
-
-Where git runs, of a folder and an environment it may leave out.
-
-## Returns
-
-`object`
-
-The folder, the environment and the system, each the context's or the system's own.
-
-### cwd
-
-> **cwd**: `string`
-
-### env
-
-> **env**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-### system
-
-> **system**: [`System`](../../system/interfaces/System.md)

package/api/@wtf/release-system/git/interfaces/GitContext.md

@@ -1,46 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/git](../README.md) / GitContext
-
-# Interface: GitContext
-
-Defined in: [packages/release-system/src/git.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L24)
-
-Where git runs: the folder of the repo, its environment, and the system it runs by.
-
-## Extended by
-
-- [`EcosystemContext`](../../../release-trains/ecosystem/interfaces/EcosystemContext.md)
-- [`CraneContext`](../../../release-oci/publish/interfaces/CraneContext.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.
-
-***
-
-### 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.
-
-***
-
-### system
-
-> `readonly` **system**: [`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.

package/api/@wtf/release-system/git/interfaces/LogCommit.md

@@ -1,43 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/git](../README.md) / LogCommit
-
-# Interface: LogCommit
-
-Defined in: [packages/release-system/src/git.ts:136](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L136)
-
-A commit as the commit analyzer reads one: its hash, its message, and its subject and its body.
-
-## Properties
-
-### body
-
-> `readonly` **body**: `string`
-
-Defined in: [packages/release-system/src/git.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L140)
-
-***
-
-### hash
-
-> `readonly` **hash**: `string`
-
-Defined in: [packages/release-system/src/git.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L137)
-
-***
-
-### message
-
-> `readonly` **message**: `string`
-
-Defined in: [packages/release-system/src/git.ts:138](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L138)
-
-***
-
-### subject
-
-> `readonly` **subject**: `string`
-
-Defined in: [packages/release-system/src/git.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/git.ts#L139)

package/api/@wtf/release-system/node/README.md

@@ -1,25 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / @wtf/release-system/node
-
-# @wtf/release-system/node
-
-Node's [System](../system/interfaces/System.md), the one module of these packages that names Node: [nodeSystem](functions/nodeSystem.md),
-[systemOf](functions/systemOf.md), a system of the members a caller gives over Node's, and [realPathOf](functions/realPathOf.md), the
-folder Node resolves the packages of a folder from. The plugins of semantic-release make their
-system by it; a library takes the system it is given, and never imports this module.
-
-```ts
-import { systemOf } from '@wtf/release-system/node'
-
-// Node's system, but its environment the one a run is given.
-const system = systemOf({ env: { ...process.env, CI: 'true' } })
-```
-
-## Functions
-
-- [nodeSystem](functions/nodeSystem.md)
-- [realPathOf](functions/realPathOf.md)
-- [systemOf](functions/systemOf.md)

package/api/@wtf/release-system/node/functions/nodeSystem.md

@@ -1,20 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/node](../README.md) / nodeSystem
-
-# Function: nodeSystem()
-
-> **nodeSystem**(): [`System`](../../system/interfaces/System.md)
-
-Defined in: [packages/release-system/src/node.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/node.ts#L113)
-
-Node's system: node:fs/promises, node:child_process, `process.env`, `process.cwd()`, `os.tmpdir()`
-and the clock.
-
-## Returns
-
-[`System`](../../system/interfaces/System.md)
-
-The system, of the environment and the working folder of this process when it is made.

package/api/@wtf/release-system/node/functions/systemOf.md

@@ -1,29 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/node](../README.md) / systemOf
-
-# Function: systemOf()
-
-> **systemOf**(`input?`): [`System`](../../system/interfaces/System.md)
-
-Defined in: [packages/release-system/src/node.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/node.ts#L127)
-
-The system of `input` over Node's: each member it gives in place of Node's, and each of the files
-it gives in place of Node's files.
-
-## Parameters
-
-### input?
-
-[`SystemInput`](../../system/type-aliases/SystemInput.md) = `{}`
-
-The members in place of Node's, and the files in place of Node's: none by default.
-
-## Returns
-
-[`System`](../../system/interfaces/System.md)
-
-The system, Node's of each member and each of the files `input` does not give: Node's
-processes of its folder and its environment, of `input` where it gives them.

package/api/@wtf/release-system/system/README.md

@@ -1,39 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / @wtf/release-system/system
-
-# @wtf/release-system/system
-
-What the libraries of a release do outside themselves, by a [System](interfaces/System.md): its files, its
-processes, its environment, its working folder and its clock. Every function of the
-libraries takes a `system`, which it requires and never makes of its own: a plugin of
-semantic-release passes Node's (`nodeSystem` of `./node`), a test one in memory, and a CLI its
-own, adapted to this interface. This module holds the types alone.
-
-```ts
-import type { System } from '@wtf/release-system/system'
-
-// A system whose processes are logged before they run, over one a caller has.
-export const logged = (system: System): System => ({
-  ...system,
-  exec: (command, args, options) => {
-    console.error(`$ ${command} ${args.join(' ')}`)
-    return system.exec(command, args, options)
-  }
-})
-```
-
-## Interfaces
-
-- [DirEntry](interfaces/DirEntry.md)
-- [ExecOptions](interfaces/ExecOptions.md)
-- [ExecResult](interfaces/ExecResult.md)
-- [System](interfaces/System.md)
-- [SystemFs](interfaces/SystemFs.md)
-
-## Type Aliases
-
-- [Exec](type-aliases/Exec.md)
-- [SystemInput](type-aliases/SystemInput.md)

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

@@ -1,27 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / DirEntry
-
-# Interface: DirEntry
-
-Defined in: [packages/release-system/src/system.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L25)
-
-An entry of a folder: its name, and whether it is a folder itself.
-
-## Properties
-
-### directory
-
-> `readonly` **directory**: `boolean`
-
-Defined in: [packages/release-system/src/system.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L27)
-
-***
-
-### name
-
-> `readonly` **name**: `string`
-
-Defined in: [packages/release-system/src/system.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L26)

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

@@ -1,41 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / ExecOptions
-
-# Interface: ExecOptions
-
-Defined in: [packages/release-system/src/system.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L83)
-
-How a process runs: in a folder, with an environment, and given an input on its stdin.
-
-## Properties
-
-### cwd?
-
-> `readonly` `optional` **cwd?**: `string`
-
-Defined in: [packages/release-system/src/system.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L85)
-
-The folder it runs in: the system's by default.
-
-***
-
-### env?
-
-> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-Defined in: [packages/release-system/src/system.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L87)
-
-The environment it runs with, whole: the system's by default.
-
-***
-
-### input?
-
-> `readonly` `optional` **input?**: `string`
-
-Defined in: [packages/release-system/src/system.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L89)
-
-What it reads on its stdin: nothing by default.

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

@@ -1,35 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-system/system](../README.md) / ExecResult
-
-# Interface: ExecResult
-
-Defined in: [packages/release-system/src/system.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L93)
-
-What a process gave: its output, its errors, and its exit code.
-
-## Properties
-
-### code
-
-> `readonly` **code**: `number`
-
-Defined in: [packages/release-system/src/system.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L96)
-
-***
-
-### stderr
-
-> `readonly` **stderr**: `string`
-
-Defined in: [packages/release-system/src/system.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L95)
-
-***
-
-### stdout
-
-> `readonly` **stdout**: `string`
-
-Defined in: [packages/release-system/src/system.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/system.ts#L94)