@wtf/release-docs 9.1.0 → 10.0.0

package/api/@wtf/release-npm/release/functions/resolvePlan.md

@@ -0,0 +1,49 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / resolvePlan
+
+# Function: resolvePlan()
+
+> **resolvePlan**(`release`, `plan`, `options?`): `Promise`\<[`ResolvedRelease`](../interfaces/ResolvedRelease.md)\>
+
+Defined in: [packages/release-npm/src/release.ts:322](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L322)
+
+The manifest of each package of the plan that publishes, as it publishes, in the order of the
+plan, and checked: of the version of the release; each `workspace:` range of a package of the
+plan resolved to that version, as pnpm resolves `workspace:*`, `workspace:^` and `workspace:~`,
+and of another package of the repo to its version of the plan's `versions`; each export of the
+source stripped; and of each private package of `pack`, the same, of no check. A devDependency of
+a package of the workspace of no version is dropped, as no consumer installs it; any other range
+of no version is left, for the check to find. It writes nothing. Throws `EPUBLISHCHECK` of what
+is wrong with a manifest, and of a name of `aside` of no package of the workspace.
+
+## Parameters
+
+### release
+
+`Pick`\<[`Release`](../../../release/contract/interfaces/Release.md), `"root"` \| `"version"`\>
+
+The version of the release, and the folder of the repo, whose workspace it
+reads.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order, the versions of the repo, and the packages of
+`pack`.
+
+### options?
+
+`Pick`\<[`NpmOptions`](../../interfaces/NpmOptions.md), `"access"` \| `"conditions"` \| `"check"` \| `"aside"` \| `"pack"`\> = `{}`
+
+The access, the conditions of the source, whether to check, the packages of
+`aside`, and of `pack`.
+
+## Returns
+
+`Promise`\<[`ResolvedRelease`](../interfaces/ResolvedRelease.md)\>
+
+The packages of the release, each manifest as it publishes, in the order to publish.

package/api/@wtf/release-npm/release/functions/smokeRelease.md

@@ -0,0 +1,40 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / smokeRelease
+
+# Function: smokeRelease()
+
+> **smokeRelease**(`release`, `plan`, `options`): `Promise`\<`void`\>
+
+Defined in: [packages/release-npm/src/release.ts:1117](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L1117)
+
+Tries each package of a release as a consumer installs it, and each private package of `pack`, by
+`smokePacked` of `./smoke`, of the globs of `forbid` and the conditions of the source: of what
+`prepare` packed in this process, or of a pack of its own, which it removes after. Throws
+`EPUBLISHSMOKE` of every fault together; what `prepare` packed is removed then too.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The version of the release, the folder of the repo, the platform and the log.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order, and the versions of the repo.
+
+### options
+
+[`NpmOptions`](../../interfaces/NpmOptions.md)
+
+The options of the release.
+
+## Returns
+
+`Promise`\<`void`\>

package/api/@wtf/release-npm/release/functions/verifyRelease.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / verifyRelease
+
+# Function: verifyRelease()
+
+> **verifyRelease**(`release`, `plan`, `options`): `Promise`\<`void`\>
+
+Defined in: [packages/release-npm/src/release.ts:266](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L266)
+
+Checks a release before anything of it is written: its version, one of semver
+(`EPUBLISHVERSION`), as npm publishes no other; its options, by [npmOptionsSchema](../variables/npmOptionsSchema.md)
+(`EOPTIONS`, and `EPUBLISHER` of a publisher that is none); and the packages of its plan as they
+are in the repo, by [checkPlan](checkPlan.md) (`EPUBLISHCHECK`). The faults of the version and of the
+options are thrown together, before the packages are read.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The version of the release, the folder of the repo and the platform.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order.
+
+### options
+
+[`NpmOptions`](../../interfaces/NpmOptions.md)
+
+The options of the release.
+
+## Returns
+
+`Promise`\<`void`\>

package/api/@wtf/release-npm/release/interfaces/MovedPackage.md

@@ -0,0 +1,79 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / MovedPackage
+
+# Interface: MovedPackage
+
+Defined in: [packages/release-npm/src/release.ts:891](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L891)
+
+What [moveRelease](../functions/moveRelease.md) did to a package, of one dist-tag.
+
+## Properties
+
+### dir
+
+> `readonly` **dir**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:895](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L895)
+
+Its folder, from the root of the repo.
+
+***
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:892](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L892)
+
+***
+
+### page?
+
+> `readonly` `optional` **page?**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:904](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L904)
+
+Its page on the registry, where the publisher knows it: none of a version it has not.
+
+***
+
+### registry?
+
+> `readonly` `optional` **registry?**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:909](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L909)
+
+The registry it was published to, where the release names one, of the option or its
+`publishConfig.registry`: none of the publisher's own.
+
+***
+
+### status
+
+> `readonly` **status**: `"tagged"` \| `"skipped"`
+
+Defined in: [packages/release-npm/src/release.ts:902](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L902)
+
+Tagged, its dist-tag moved, or pointed at the version already; or skipped, as of a package the
+registry has not at the version, or whose dist-tag points above it.
+
+***
+
+### tag
+
+> `readonly` **tag**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:897](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L897)
+
+The dist-tag moved.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:893](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L893)

package/api/@wtf/release-npm/release/interfaces/MovedRelease.md

@@ -0,0 +1,39 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / MovedRelease
+
+# Interface: MovedRelease
+
+Defined in: [packages/release-npm/src/release.ts:913](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L913)
+
+What [moveRelease](../functions/moveRelease.md) did.
+
+## Properties
+
+### packages
+
+> `readonly` **packages**: readonly [`MovedPackage`](MovedPackage.md)[]
+
+Defined in: [packages/release-npm/src/release.ts:918](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L918)
+
+Each package of the release that publishes, of each dist-tag in turn, in order.
+
+***
+
+### publisher
+
+> `readonly` **publisher**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:916](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L916)
+
+The publisher's name.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:914](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L914)

package/api/@wtf/release-npm/release/interfaces/NpmPlan.md

@@ -0,0 +1,68 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / NpmPlan
+
+# Interface: NpmPlan
+
+Defined in: [packages/release-npm/src/release.ts:111](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L111)
+
+The plan of a release of npm packages: a `Plan` of `@wtf/release/contract`, of the packages of
+`./manifests`, and what a plan of a part of the repo may say besides, as `TrainPlan` of
+`@wtf/release-trains/plan` does.
+
+## Extends
+
+- [`Plan`](../../../release/contract/interfaces/Plan.md)\<[`NpmPackage`](../../manifests/interfaces/NpmPackage.md)\>
+
+## Properties
+
+### faults?
+
+> `readonly` `optional` **faults?**: readonly [`OrderFault`](../../../release/order/interfaces/OrderFault.md)[]
+
+Defined in: [packages/release-npm/src/release.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L121)
+
+What is wrong with the order of `own`, as `publishOrder` of `@wtf/release/order` finds it of
+its pins: of none, what it finds of `own` of no pin.
+
+***
+
+### own
+
+> `readonly` **own**: readonly [`NpmPackage`](../../manifests/interfaces/NpmPackage.md)[]
+
+Defined in: [packages/release/src/contract.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/contract.ts#L82)
+
+The packages the release publishes, in the order to publish them in.
+
+#### Inherited from
+
+[`Plan`](../../../release/contract/interfaces/Plan.md).[`own`](../../../release/contract/interfaces/Plan.md#own)
+
+***
+
+### packages?
+
+> `readonly` `optional` **packages?**: readonly [`NpmPackage`](../../manifests/interfaces/NpmPackage.md)[]
+
+Defined in: [packages/release-npm/src/release.ts:116](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L116)
+
+Every package of the part of the repo the release is of, private ones too, of which `pack`
+picks the private ones: of none, the workspace's.
+
+***
+
+### versions
+
+> `readonly` **versions**: `ReadonlyMap`\<`string`, `string`\>
+
+Defined in: [packages/release/src/contract.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/contract.ts#L87)
+
+The version of each package of the repo of the ecosystem, by its name: the release's of each
+of `own`, the last release of its own of each other, which a range of it is written of.
+
+#### Inherited from
+
+[`Plan`](../../../release/contract/interfaces/Plan.md).[`versions`](../../../release/contract/interfaces/Plan.md#versions)

package/api/@wtf/release-npm/release/interfaces/PackOptions.md

@@ -6,47 +6,33 @@
 
 # Interface: PackOptions
 
-Defined in: [packages/release-npm/src/release.ts:287](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L287)
+Defined in: [packages/release-npm/src/release.ts:392](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L392)
 
-How [packTrain](../functions/packTrain.md) packs, and [publishTrain](../functions/publishTrain.md) publishes, the packages of a release.
+How [packRelease](../functions/packRelease.md) packs, and [publishPacked](../functions/publishPacked.md) publishes, the packages of a release: of
+the folder of the repo, `root`, and the platform, of its processes, its environment, which the
+publisher runs in, and its temporary folders.
 
-## Properties
-
-### cwd?
-
-> `readonly` `optional` **cwd?**: `string`
+## Extends
 
-Defined in: [packages/release-npm/src/release.ts:291](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L291)
+- [`RepoContext`](../../../release/interfaces/RepoContext.md)\<[`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)\>
 
-The folder of the repo: the system's working folder by default.
-
-***
+## Properties
 
 ### dryRun?
 
 > `readonly` `optional` **dryRun?**: `boolean`
 
-Defined in: [packages/release-npm/src/release.ts:303](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L303)
+Defined in: [packages/release-npm/src/release.ts:402](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L402)
 
 Whether the run publishes nothing for real, and asks the registry and says what it would.
 
 ***
 
-### env?
-
-> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-Defined in: [packages/release-npm/src/release.ts:293](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L293)
-
-The environment the publisher runs in: the system's by default.
-
-***
-
 ### log?
 
 > `readonly` `optional` **log?**: (`line`) => `void`
 
-Defined in: [packages/release-npm/src/release.ts:309](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L309)
+Defined in: [packages/release-npm/src/release.ts:408](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L408)
 
 Where each line of what it does goes: nowhere by default.
 
@@ -64,23 +50,41 @@ The line of what it does, of no newline.
 
 ***
 
+### platform
+
+> `readonly` **platform**: [`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)
+
+Defined in: [packages/release/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L80)
+
+The platform, of the folder of the repo as its working folder.
+
+#### Inherited from
+
+[`RepoContext`](../../../release/interfaces/RepoContext.md).[`platform`](../../../release/interfaces/RepoContext.md#platform)
+
+***
+
 ### publisher?
 
 > `readonly` `optional` **publisher?**: [`Publisher`](../../interfaces/Publisher.md)
 
-Defined in: [packages/release-npm/src/release.ts:289](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L289)
+Defined in: [packages/release-npm/src/release.ts:394](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L394)
 
 The publisher: `npmPublisher` of `./publishers` by default.
 
 ***
 
-### system
+### root
+
+> `readonly` **root**: `FileSystemDirectoryHandle`
+
+Defined in: [packages/release/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L78)
 
-> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
+The folder of the repo, a handle of the File System standard.
 
-Defined in: [packages/release-npm/src/release.ts:295](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L295)
+#### Inherited from
 
-The system it runs by, which it requires.
+[`RepoContext`](../../../release/interfaces/RepoContext.md).[`root`](../../../release/interfaces/RepoContext.md#root)
 
 ***
 
@@ -88,8 +92,8 @@ The system it runs by, which it requires.
 
 > `readonly` `optional` **tarballDir?**: `string`
 
-Defined in: [packages/release-npm/src/release.ts:301](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L301)
+Defined in: [packages/release-npm/src/release.ts:400](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L400)
 
 The folder the tarballs are packed into, from the root of the repo or absolute, where they stay
-after `cleanup`: one of the system's temporary files by default, which goes. One in the repo is
-for git to ignore.
+after `cleanup`: a folder in the temporary folder of the copies by default, which goes. One in
+the repo is for git to ignore.

package/api/@wtf/release-npm/release/interfaces/PackedRelease.md

@@ -0,0 +1,107 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / PackedRelease
+
+# Interface: PackedRelease
+
+Defined in: [packages/release-npm/src/release.ts:412](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L412)
+
+The packages of a release, staged and packed by [packRelease](../functions/packRelease.md).
+
+## Properties
+
+### cleanup
+
+> `readonly` **cleanup**: () => `Promise`\<`void`\>
+
+Defined in: [packages/release-npm/src/release.ts:429](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L429)
+
+Removes the copies, and the tarballs of the temporary folder of the copies; the tarballs of a
+folder the caller names stay, as for links of the release of the host.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### discard
+
+> `readonly` **discard**: () => `Promise`\<`void`\>
+
+Defined in: [packages/release-npm/src/release.ts:434](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L434)
+
+Removes the copies and every tarball, of a folder the caller names too, of a release that
+failed, which has none of them: each, whichever removal fails.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### packages
+
+> `readonly` **packages**: readonly [`PublishPackage`](../../interfaces/PublishPackage.md)[]
+
+Defined in: [packages/release-npm/src/release.ts:416](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L416)
+
+Each package, in the order of publishing, its folder the copy it was packed of.
+
+***
+
+### packOnly
+
+> `readonly` **packOnly**: readonly [`PublishPackage`](../../interfaces/PublishPackage.md)[]
+
+Defined in: [packages/release-npm/src/release.ts:418](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L418)
+
+Each private package of `pack`, its folder the copy it was packed of, never published.
+
+***
+
+### publisher
+
+> `readonly` **publisher**: [`Publisher`](../../interfaces/Publisher.md)
+
+Defined in: [packages/release-npm/src/release.ts:414](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L414)
+
+***
+
+### staging
+
+> `readonly` **staging**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:422](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L422)
+
+The folder of the copies, a temporary folder of the platform, by its absolute path.
+
+***
+
+### tarballDir
+
+> `readonly` **tarballDir**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:424](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L424)
+
+The folder the tarballs are in, absolute.
+
+***
+
+### tarballs
+
+> `readonly` **tarballs**: `ReadonlyMap`\<`string`, `string`\>
+
+Defined in: [packages/release-npm/src/release.ts:420](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L420)
+
+The tarball of each package, by its name, where the publisher packs.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-npm/src/release.ts:413](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L413)