@wtf/release-docs 8.2.1 → 8.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -44
- package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
- package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
- package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/selectCrates.md +1 -1
- package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
- package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
- package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
- package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
- package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
- package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +1 -1
- package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
- package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
- package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
- package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
- package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
- package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
- package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
- package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
- package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
- package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
- package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
- package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +7 -7
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +1 -1
- package/api/@wtf/release-go/errors/classes/GoError.md +5 -5
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +1 -1
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
- package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
- package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
- package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesAt.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
- package/api/@wtf/release-go/modules/functions/readModules.md +1 -1
- package/api/@wtf/release-go/modules/functions/selectModules.md +1 -1
- package/api/@wtf/release-go/modules/interfaces/Selection.md +4 -4
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-go/tags/functions/askProxy.md +1 -1
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +1 -1
- package/api/@wtf/release-go/tags/functions/remoteTags.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagModules.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +8 -8
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +4 -4
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +1 -1
- package/api/@wtf/release-maven/errors/classes/MavenError.md +5 -5
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +1 -1
- package/api/@wtf/release-maven/interfaces/MavenModule.md +14 -14
- package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
- package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
- package/api/@wtf/release-maven/publish/functions/deployModules.md +1 -1
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +11 -11
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
- package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
- package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
- package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
- package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
- package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
- package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
- package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
- package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
- package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
- package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
- package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
- package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
- package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
- package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +13 -13
- package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
- package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
- package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
- package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
- package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
- package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
- package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
- package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
- package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
- package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
- package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
- package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
- package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +16 -16
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
- package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
- package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +7 -7
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
- package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
- package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
- package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
- package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
- package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
- package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
- package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
- package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
- package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
- package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
- package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
- package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
- package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
- package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
- package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
- package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
- package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
- package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
- package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
- package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
- package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
- package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
- package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
- package/api/@wtf/release-system/errors/classes/ReleaseError.md +5 -5
- package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
- package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
- package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
- package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
- package/api/@wtf/release-system/git/functions/git.md +1 -1
- package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
- package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
- package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
- package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
- package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
- package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
- package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
- package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
- package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
- package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
- package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
- package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
- package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
- package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
- package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
- package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
- package/api/@wtf/release-system/system/interfaces/System.md +7 -7
- package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
- package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
- package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
- package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
- package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
- package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
- package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/refined.md +1 -1
- package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
- package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
- package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
- package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
- package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
- package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
- package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
- package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
- package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
- package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
- package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
- package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +6 -6
- package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
- package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
- package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
- package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
- package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -1
- package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
- package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
- package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
- package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
- package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
- package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
- package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
- package/api/@wtf/release-trains/interfaces/Train.md +7 -7
- package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
- package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
- package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
- package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
- package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
- package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
- package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
- package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
- package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
- package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
- package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
- package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
- package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
- package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
- package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
- package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
- package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
- package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
- package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
- package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
- package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
- package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
- package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
- package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
- package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
- package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
- package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
- package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
- package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
- package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
- package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
- package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
- package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
- package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
- package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
- package/api/@wtf/semantic-release-go/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-go/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +8 -8
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-go/variables/default.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +3 -3
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/variables/default.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +18 -18
- package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
- package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
- package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
- package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
- package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
- package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
- package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
- package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
- package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +5 -5
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
- package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
- package/guides/changelogs.md +39 -28
- package/guides/ci-recipes.md +393 -271
- package/guides/configuring-trains.md +291 -203
- package/guides/dependency-rules.md +171 -113
- package/guides/ecosystems.md +222 -156
- package/guides/getting-started.md +135 -69
- package/guides/publishing-crates.md +208 -143
- package/guides/publishing-go-modules.md +170 -110
- package/guides/publishing-maven.md +197 -123
- package/guides/publishing.md +278 -191
- package/guides/system.md +50 -34
- package/guides/troubleshooting.md +358 -92
- package/guides/validating-a-config.md +81 -56
- package/package.json +1 -1
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **anyOf**\<`T`\>(`validators`, `expected`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:307](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:307](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L307)
|
|
12
12
|
|
|
13
13
|
A validator of a value of any of `validators`, tried in order.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **arrayOf**\<`T`\>(`item`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:237](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:237](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L237)
|
|
12
12
|
|
|
13
13
|
A validator of an array, of each item of `item`, and of a least count of items.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **booleanOf**(`options?`): [`Validator`](../interfaces/Validator.md)\<`boolean`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:183](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:183](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L183)
|
|
12
12
|
|
|
13
13
|
A validator of a boolean.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **errorOf**\<`E`\>(`found`, `as`): `E`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:625](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:625](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L625)
|
|
12
12
|
|
|
13
13
|
The error of an issue, of its code, its message and its details, of the class `as`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **errorsOf**\<`E`\>(`of`, `value`, `as`, `path?`): `E`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:639](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:639](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L639)
|
|
12
12
|
|
|
13
13
|
The errors of the issues of `value` by the validator `of`, each of the class `as`, of the package
|
|
14
14
|
that asks: none of a valid one.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **exclusive**\<`T`\>(`base`, `keys`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:506](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:506](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L506)
|
|
12
12
|
|
|
13
13
|
A validator of `base`, of an object that has at most one of `keys`, as the options of an entry of
|
|
14
14
|
one role of several: the issue of each key past the first it has, at that key. Its JSON Schema is
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **issuesOf**(`of`, `value`, `path?`): [`OptionIssue`](../interfaces/OptionIssue.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:613](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:613](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L613)
|
|
12
12
|
|
|
13
13
|
The issues of `value` by the validator `of`, at `path`: none of a valid one.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **objectOf**\<`T`\>(`properties`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:352](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:352](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L352)
|
|
12
12
|
|
|
13
13
|
A validator of an object of `properties`, each of its validator, each required unless it is
|
|
14
14
|
optional; of no property but these, where it is `closed`. A property that is `undefined` is
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **oneOf**\<`T`\>(`values`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L197)
|
|
12
12
|
|
|
13
13
|
A validator of one of `values`, each a string, a number or a boolean.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **orFunction**\<`T`\>(`base`): [`Validator`](../interfaces/Validator.md)\<`T` \| ((...`args`) => `unknown`)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:552](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:552](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L552)
|
|
12
12
|
|
|
13
13
|
A validator of a value of `base`, or of a function, which a config of JavaScript gives and JSON
|
|
14
14
|
cannot write: its JSON Schema is `base`'s, as a JSON config takes no function.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pathText**(`path`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L98)
|
|
12
12
|
|
|
13
13
|
`path`, as a reader writes it: `trains.core.paths[0]`, or `the options` of none.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pluginEntriesOf**(`names`, `options`): [`Validator`](../interfaces/Validator.md)\<`object`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:569](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:569](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L569)
|
|
12
12
|
|
|
13
13
|
A validator of the entries of `plugins` of a whole config of semantic-release, an array, that
|
|
14
14
|
name a plugin of `names` and give it options, `[name, options]`: its options of `options`. It
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **recordOf**\<`T`\>(`value`, `options?`): [`Validator`](../interfaces/Validator.md)\<`Record`\<`string`, `T`\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:418](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:418](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L418)
|
|
12
12
|
|
|
13
13
|
A validator of an object of any keys, each of `keyPattern`, and each value of `value`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **refined**\<`T`\>(`base`, `refine`, `comment`, `always?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:465](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:465](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L465)
|
|
12
12
|
|
|
13
13
|
A validator of `base`, and then of `refine`, which checks more than JSON Schema can say: of a
|
|
14
14
|
value `base` finds valid, or, where `always`, of any value, which `refine` then takes as unknown
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **stringOf**(`options?`): [`Validator`](../interfaces/Validator.md)\<`string`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L159)
|
|
12
12
|
|
|
13
13
|
A validator of a string, of a least length and a pattern.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **tupleOf**\<`T`\>(`items`, `minItems`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:281](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:281](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L281)
|
|
12
12
|
|
|
13
13
|
A validator of an array of the items of `items`, each in its place, and of `minItems` or more.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ArrayOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:223](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:223](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L223)
|
|
10
10
|
|
|
11
11
|
What [arrayOf](../functions/arrayOf.md) checks besides each item.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ What [arrayOf](../functions/arrayOf.md) checks besides each item.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **code?**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L76)
|
|
24
24
|
|
|
25
25
|
The code of the error: `EOPTIONS`.
|
|
26
26
|
|
|
@@ -34,7 +34,7 @@ The code of the error: `EOPTIONS`.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` `optional` **details?**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L86)
|
|
38
38
|
|
|
39
39
|
How to fix it.
|
|
40
40
|
|
|
@@ -48,7 +48,7 @@ How to fix it.
|
|
|
48
48
|
|
|
49
49
|
> `readonly` `optional` **message?**: (`path`, `value`) => `string`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
51
|
+
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L84)
|
|
52
52
|
|
|
53
53
|
What is wrong, of where it is and of the value.
|
|
54
54
|
|
|
@@ -82,6 +82,6 @@ The message of the issue, in place of the one its check writes.
|
|
|
82
82
|
|
|
83
83
|
> `readonly` `optional` **minItems?**: `number`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/release-system/src/validator.ts:225](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
85
|
+
Defined in: [packages/release-system/src/validator.ts:225](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L225)
|
|
86
86
|
|
|
87
87
|
Its least count of items.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: IssueOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L74)
|
|
10
10
|
|
|
11
11
|
What an issue of a check says, where it does not say its own.
|
|
12
12
|
|
|
@@ -23,7 +23,7 @@ What an issue of a check says, where it does not say its own.
|
|
|
23
23
|
|
|
24
24
|
> `readonly` `optional` **code?**: `string`
|
|
25
25
|
|
|
26
|
-
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
26
|
+
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L76)
|
|
27
27
|
|
|
28
28
|
The code of the error: `EOPTIONS`.
|
|
29
29
|
|
|
@@ -33,7 +33,7 @@ The code of the error: `EOPTIONS`.
|
|
|
33
33
|
|
|
34
34
|
> `readonly` `optional` **details?**: `string`
|
|
35
35
|
|
|
36
|
-
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
36
|
+
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L86)
|
|
37
37
|
|
|
38
38
|
How to fix it.
|
|
39
39
|
|
|
@@ -43,7 +43,7 @@ How to fix it.
|
|
|
43
43
|
|
|
44
44
|
> `readonly` `optional` **message?**: (`path`, `value`) => `string`
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
46
|
+
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L84)
|
|
47
47
|
|
|
48
48
|
What is wrong, of where it is and of the value.
|
|
49
49
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ObjectOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:334](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:334](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L334)
|
|
10
10
|
|
|
11
11
|
What [objectOf](../functions/objectOf.md) checks besides its properties.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ What [objectOf](../functions/objectOf.md) checks besides its properties.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **closed?**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-system/src/validator.ts:336](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-system/src/validator.ts:336](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L336)
|
|
24
24
|
|
|
25
25
|
Whether it has no property but its own: it may have others otherwise, as options do.
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ Whether it has no property but its own: it may have others otherwise, as options
|
|
|
30
30
|
|
|
31
31
|
> `readonly` `optional` **code?**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
33
|
+
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L76)
|
|
34
34
|
|
|
35
35
|
The code of the error: `EOPTIONS`.
|
|
36
36
|
|
|
@@ -44,7 +44,7 @@ The code of the error: `EOPTIONS`.
|
|
|
44
44
|
|
|
45
45
|
> `readonly` `optional` **details?**: `string`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
47
|
+
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L86)
|
|
48
48
|
|
|
49
49
|
How to fix it.
|
|
50
50
|
|
|
@@ -58,7 +58,7 @@ How to fix it.
|
|
|
58
58
|
|
|
59
59
|
> `readonly` `optional` **message?**: (`path`, `value`) => `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
61
|
+
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L84)
|
|
62
62
|
|
|
63
63
|
What is wrong, of where it is and of the value.
|
|
64
64
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: OptionIssue
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L43)
|
|
10
10
|
|
|
11
11
|
An issue of a validator: what is wrong, where, the code of its error, and how to fix it.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ An issue of a validator: what is wrong, where, the code of its error, and how to
|
|
|
20
20
|
|
|
21
21
|
> `readonly` **code**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-system/src/validator.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-system/src/validator.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L47)
|
|
24
24
|
|
|
25
25
|
The code of the error it makes, as `ETRAINPATHS`, or `EOPTIONS` of an option.
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ The code of the error it makes, as `ETRAINPATHS`, or `EOPTIONS` of an option.
|
|
|
30
30
|
|
|
31
31
|
> `readonly` **details**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/release-system/src/validator.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
33
|
+
Defined in: [packages/release-system/src/validator.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L49)
|
|
34
34
|
|
|
35
35
|
How to fix it.
|
|
36
36
|
|
|
@@ -54,7 +54,7 @@ The error message of the issue.
|
|
|
54
54
|
|
|
55
55
|
> `readonly` **path**: [`Path`](../type-aliases/Path.md)
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/release-system/src/validator.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
57
|
+
Defined in: [packages/release-system/src/validator.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L45)
|
|
58
58
|
|
|
59
59
|
Where, in the value.
|
|
60
60
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Property\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:324](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:324](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L324)
|
|
10
10
|
|
|
11
11
|
A property of an object a validator checks: its validator, and whether it may be missing.
|
|
12
12
|
|
|
@@ -24,7 +24,7 @@ The type of its value.
|
|
|
24
24
|
|
|
25
25
|
> `readonly` `optional` **missing?**: [`IssueOptions`](IssueOptions.md)
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/release-system/src/validator.ts:330](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
27
|
+
Defined in: [packages/release-system/src/validator.ts:330](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L330)
|
|
28
28
|
|
|
29
29
|
The issue of it missing, where it is required.
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ The issue of it missing, where it is required.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` **of**: [`Validator`](Validator.md)\<`T`\>
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-system/src/validator.ts:326](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-system/src/validator.ts:326](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L326)
|
|
38
38
|
|
|
39
39
|
The validator of its value.
|
|
40
40
|
|
|
@@ -44,6 +44,6 @@ The validator of its value.
|
|
|
44
44
|
|
|
45
45
|
> `readonly` `optional` **optional?**: `boolean`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/release-system/src/validator.ts:328](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
47
|
+
Defined in: [packages/release-system/src/validator.ts:328](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L328)
|
|
48
48
|
|
|
49
49
|
Whether it may be missing: it is required otherwise.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RecordOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:401](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:401](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L401)
|
|
10
10
|
|
|
11
11
|
What [recordOf](../functions/recordOf.md) checks besides each value.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ What [recordOf](../functions/recordOf.md) checks besides each value.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **code?**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L76)
|
|
24
24
|
|
|
25
25
|
The code of the error: `EOPTIONS`.
|
|
26
26
|
|
|
@@ -34,7 +34,7 @@ The code of the error: `EOPTIONS`.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` `optional` **details?**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L86)
|
|
38
38
|
|
|
39
39
|
How to fix it.
|
|
40
40
|
|
|
@@ -48,7 +48,7 @@ How to fix it.
|
|
|
48
48
|
|
|
49
49
|
> `readonly` `optional` **key?**: [`IssueOptions`](IssueOptions.md)
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/release-system/src/validator.ts:405](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
51
|
+
Defined in: [packages/release-system/src/validator.ts:405](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L405)
|
|
52
52
|
|
|
53
53
|
The issue of a key that does not match it.
|
|
54
54
|
|
|
@@ -58,7 +58,7 @@ The issue of a key that does not match it.
|
|
|
58
58
|
|
|
59
59
|
> `readonly` `optional` **keyPattern?**: `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/release-system/src/validator.ts:403](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
61
|
+
Defined in: [packages/release-system/src/validator.ts:403](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L403)
|
|
62
62
|
|
|
63
63
|
A pattern each key matches, as JSON Schema writes one.
|
|
64
64
|
|
|
@@ -68,7 +68,7 @@ A pattern each key matches, as JSON Schema writes one.
|
|
|
68
68
|
|
|
69
69
|
> `readonly` `optional` **message?**: (`path`, `value`) => `string`
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
71
|
+
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L84)
|
|
72
72
|
|
|
73
73
|
What is wrong, of where it is and of the value.
|
|
74
74
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: StringOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L145)
|
|
10
10
|
|
|
11
11
|
What [stringOf](../functions/stringOf.md) checks besides a string.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ What [stringOf](../functions/stringOf.md) checks besides a string.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **code?**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-system/src/validator.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L76)
|
|
24
24
|
|
|
25
25
|
The code of the error: `EOPTIONS`.
|
|
26
26
|
|
|
@@ -34,7 +34,7 @@ The code of the error: `EOPTIONS`.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` `optional` **details?**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-system/src/validator.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L86)
|
|
38
38
|
|
|
39
39
|
How to fix it.
|
|
40
40
|
|
|
@@ -48,7 +48,7 @@ How to fix it.
|
|
|
48
48
|
|
|
49
49
|
> `readonly` `optional` **message?**: (`path`, `value`) => `string`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
51
|
+
Defined in: [packages/release-system/src/validator.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L84)
|
|
52
52
|
|
|
53
53
|
What is wrong, of where it is and of the value.
|
|
54
54
|
|
|
@@ -82,7 +82,7 @@ The message of the issue, in place of the one its check writes.
|
|
|
82
82
|
|
|
83
83
|
> `readonly` `optional` **minLength?**: `number`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/release-system/src/validator.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
85
|
+
Defined in: [packages/release-system/src/validator.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L147)
|
|
86
86
|
|
|
87
87
|
Its least length.
|
|
88
88
|
|
|
@@ -92,6 +92,6 @@ Its least length.
|
|
|
92
92
|
|
|
93
93
|
> `readonly` `optional` **pattern?**: `string`
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/release-system/src/validator.ts:149](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
95
|
+
Defined in: [packages/release-system/src/validator.ts:149](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L149)
|
|
96
96
|
|
|
97
97
|
A pattern it matches, as JSON Schema writes one, which Unicode mode reads.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Validator\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-system/src/validator.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-system/src/validator.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L58)
|
|
10
10
|
|
|
11
11
|
A validator of values of type `T`: a Standard Schema, whose issues are [OptionIssue](OptionIssue.md)s, and a
|
|
12
12
|
Standard JSON Schema, of the JSON Schema of what it checks.
|
|
@@ -25,7 +25,7 @@ The type of a value it finds valid.
|
|
|
25
25
|
|
|
26
26
|
> `readonly` **~standard**: `Props`\<`unknown`, `T`\> & `Props`\<`unknown`, `T`\>
|
|
27
27
|
|
|
28
|
-
Defined in: [packages/release-system/src/validator.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
28
|
+
Defined in: [packages/release-system/src/validator.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L60)
|
|
29
29
|
|
|
30
30
|
The properties of both standards.
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ The properties of both standards.
|
|
|
35
35
|
|
|
36
36
|
> `readonly` **check**: (`value`, `path`) => [`OptionIssue`](OptionIssue.md)[]
|
|
37
37
|
|
|
38
|
-
Defined in: [packages/release-system/src/validator.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
38
|
+
Defined in: [packages/release-system/src/validator.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L70)
|
|
39
39
|
|
|
40
40
|
The issues of `value`, at `path` in the options: none of a valid value.
|
|
41
41
|
|
|
@@ -65,6 +65,6 @@ The issues of the value, each at its own path under `path`.
|
|
|
65
65
|
|
|
66
66
|
> `readonly` **jsonSchema**: [`JsonSchema`](../type-aliases/JsonSchema.md)
|
|
67
67
|
|
|
68
|
-
Defined in: [packages/release-system/src/validator.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
68
|
+
Defined in: [packages/release-system/src/validator.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L62)
|
|
69
69
|
|
|
70
70
|
The JSON Schema of what it checks.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **JsonSchema** = `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L37)
|
|
12
12
|
|
|
13
13
|
A JSON Schema, of draft 2020-12, as data.
|
|
14
14
|
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **Path** = readonly (`string` \| `number`)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-system/src/validator.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-system/src/validator.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-system/src/validator.ts#L40)
|
|
12
12
|
|
|
13
13
|
The path of a value in the options, as `['trains', 'core', 'paths']`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **cascadeNotes**(`cascades`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:283](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:283](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/cascade.ts#L283)
|
|
12
12
|
|
|
13
13
|
The section of release notes of `cascades`, in Markdown, of a heading and a line of each; `''` of
|
|
14
14
|
none.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **cascadeText**(`cascade`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:273](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:273](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/cascade.ts#L273)
|
|
12
12
|
|
|
13
13
|
A cascade as a line of the notes says it:
|
|
14
14
|
`@wtf/release-replace: dependency @wtf/release-trains ^2.1.0 → ^3.0.0 (trains 3.0.0)`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **cascadeType**(`cascades`): `"major"` \| `"patch"` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:254](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:254](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/cascade.ts#L254)
|
|
12
12
|
|
|
13
13
|
The type of release `cascades` make of their train: the highest of them, of none `undefined`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **cascadesOf**(`check`): `Promise`\<[`Cascade`](../interfaces/Cascade.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:153](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:153](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/cascade.ts#L153)
|
|
12
12
|
|
|
13
13
|
The releases the train of `check` owes the trains it depends on: of each package of the train
|
|
14
14
|
that publishes, as its last release had it, each dependency on a package of another train that
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **higherType**(`a`, `b`): `string` \| `null` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:241](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:241](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/cascade.ts#L241)
|
|
12
12
|
|
|
13
13
|
The higher of two types of release, of none as `null` or `undefined`.
|
|
14
14
|
|