@savvy-web/silk-effects 9.5.5 → 10.0.0
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/_virtual/_rolldown/runtime.js +1 -2
- package/changesets/api/categories.js +1 -2
- package/changesets/api/changelog.js +1 -2
- package/changesets/api/dependency-table.js +13 -14
- package/changesets/api/linter.js +24 -21
- package/changesets/api/transformer.js +39 -35
- package/changesets/categories/index.js +2 -3
- package/changesets/categories/types.js +3 -4
- package/changesets/changelog/formatting.js +1 -2
- package/changesets/changelog/getDependencyReleaseLine.js +2 -3
- package/changesets/changelog/getReleaseLine.js +1 -2
- package/changesets/changelog/index.js +3 -4
- package/changesets/changelog/vanilla.js +1 -2
- package/changesets/constants.js +2 -3
- package/changesets/errors.js +2 -3
- package/changesets/index.js +12 -42
- package/changesets/markdownlint/index.js +1 -2
- package/changesets/markdownlint/rules/content-structure.js +3 -4
- package/changesets/markdownlint/rules/dependency-table-format.js +1 -2
- package/changesets/markdownlint/rules/heading-hierarchy.js +3 -4
- package/changesets/markdownlint/rules/required-sections.js +3 -4
- package/changesets/markdownlint/rules/uncategorized-content.js +3 -4
- package/changesets/markdownlint/rules/utils.js +7 -8
- package/changesets/rules/content-structure.js +44 -0
- package/changesets/rules/dependency-table-format.js +54 -0
- package/changesets/rules/heading-hierarchy.js +37 -0
- package/changesets/rules/required-sections.js +34 -0
- package/changesets/rules/types.js +20 -0
- package/changesets/rules/uncategorized-content.js +30 -0
- package/changesets/schemas/changeset.js +2 -3
- package/changesets/schemas/dependency-table.js +1 -2
- package/changesets/schemas/deps-regen.js +1 -2
- package/changesets/schemas/git.js +1 -2
- package/changesets/schemas/github.js +1 -2
- package/changesets/schemas/options.js +1 -2
- package/changesets/schemas/package-scope.js +1 -2
- package/changesets/schemas/primitives.js +1 -2
- package/changesets/schemas/release-plan.js +1 -2
- package/changesets/schemas/version-files.js +1 -2
- package/changesets/services/branch-analyzer.js +1 -2
- package/changesets/services/changelog.js +1 -2
- package/changesets/services/config-inspector.js +1 -2
- package/changesets/services/deps-regen.js +1 -2
- package/changesets/services/github.js +1 -2
- package/changesets/services/maintenance-reason.js +1 -2
- package/changesets/services/release-planner.js +1 -2
- package/changesets/transforms/aggregate-dependency-tables.js +96 -0
- package/changesets/transforms/contributor-footnotes.js +290 -0
- package/changesets/transforms/deduplicate-items.js +47 -0
- package/changesets/transforms/issue-link-refs.js +47 -0
- package/changesets/transforms/maintenance-note.js +65 -0
- package/changesets/transforms/merge-sections.js +56 -0
- package/changesets/transforms/normalize-format.js +53 -0
- package/changesets/transforms/reorder-sections.js +53 -0
- package/changesets/utils/blocks.js +67 -0
- package/changesets/utils/commit-parser.js +1 -2
- package/changesets/utils/dep-diff.js +1 -2
- package/changesets/utils/dependency-section.js +1 -2
- package/changesets/utils/dependency-table.js +30 -38
- package/changesets/utils/git.js +1 -2
- package/changesets/utils/issue-refs.js +1 -2
- package/changesets/utils/jsonpath.js +1 -2
- package/changesets/utils/logger.js +1 -2
- package/changesets/utils/markdown-emit.js +12 -38
- package/changesets/utils/markdown-link.js +1 -2
- package/changesets/utils/publishability.js +1 -2
- package/changesets/utils/section-parser.js +1 -2
- package/changesets/utils/strip-frontmatter.js +1 -2
- package/changesets/utils/version-files.js +1 -2
- package/changesets/vendor/github-info.js +1 -2
- package/commitlint/config/factory.js +1 -2
- package/commitlint/config/plugins.js +1 -2
- package/commitlint/config/rules.js +1 -2
- package/commitlint/config/schema.js +1 -2
- package/commitlint/detection/dco.js +1 -2
- package/commitlint/detection/scopes.js +1 -2
- package/commitlint/formatter/format.js +1 -2
- package/commitlint/formatter/messages.js +1 -2
- package/commitlint/hook/diagnostics/branch.js +1 -2
- package/commitlint/hook/diagnostics/cache.js +1 -2
- package/commitlint/hook/diagnostics/commitlint-config.js +1 -2
- package/commitlint/hook/diagnostics/open-issues.js +1 -2
- package/commitlint/hook/diagnostics/package-manager.js +1 -2
- package/commitlint/hook/diagnostics/signing.js +1 -2
- package/commitlint/hook/envelope.js +1 -2
- package/commitlint/hook/output.js +1 -2
- package/commitlint/hook/parse-bash-command.js +1 -2
- package/commitlint/hook/rules/closes-trailer.js +1 -2
- package/commitlint/hook/rules/forbidden-content.js +1 -2
- package/commitlint/hook/rules/plan-leakage.js +1 -2
- package/commitlint/hook/rules/signing-flag-conflict.js +1 -2
- package/commitlint/hook/rules/soft-wrap.js +1 -2
- package/commitlint/hook/rules/types.js +1 -2
- package/commitlint/hook/rules/verbosity.js +1 -2
- package/commitlint/hook/silence-logger.js +1 -2
- package/commitlint/index.js +1 -2
- package/commitlint/prompt/config.js +1 -2
- package/commitlint/prompt/emojis.js +1 -2
- package/commitlint/prompt/prompter.js +1 -2
- package/commitlint/static.js +1 -2
- package/index.d.ts +141 -1450
- package/index.js +2 -2
- package/lint/Handler.js +1 -2
- package/lint/cli/sections.js +1 -2
- package/lint/cli/templates/markdownlint.gen.js +1 -2
- package/lint/config/Preset.js +1 -2
- package/lint/config/createConfig.js +1 -2
- package/lint/handlers/Biome.js +1 -2
- package/lint/handlers/Markdown.js +1 -2
- package/lint/handlers/PackageJson.js +1 -2
- package/lint/handlers/PnpmWorkspace.js +1 -2
- package/lint/handlers/ShellScripts.js +1 -2
- package/lint/handlers/TextFiles.js +1 -2
- package/lint/handlers/TypeScript.js +1 -2
- package/lint/handlers/Yaml.js +1 -2
- package/lint/index.js +1 -2
- package/lint/utils/Command.js +1 -2
- package/lint/utils/Filter.js +1 -2
- package/lint/utils/Workspace.js +1 -2
- package/package.json +15 -22
- package/repos/constants.js +1 -2
- package/repos/errors.js +1 -2
- package/repos/index.js +1 -2
- package/repos/schemas/drift.js +1 -2
- package/repos/schemas/manifest.js +1 -2
- package/repos/schemas/reports.js +1 -2
- package/repos/services/config-store.js +1 -2
- package/repos/services/drift.js +1 -2
- package/repos/services/lockdown.js +1 -2
- package/repos/services/manager.js +1 -2
- package/services/BiomeSchemaSync.js +1 -2
- package/services/ChangesetConfig.js +1 -2
- package/services/ChangesetConfigReader.js +1 -2
- package/services/ConfigDiscovery.js +1 -2
- package/services/SilkPublishability.js +147 -6
- package/services/SilkWorkspaceAnalyzer.js +1 -2
- package/turbo/digest.js +1 -2
- package/turbo/errors.js +1 -2
- package/turbo/index.js +1 -2
- package/turbo/schemas/DryRun.js +1 -2
- package/turbo/schemas/results.js +1 -2
- package/turbo/services/TurboInspector.js +1 -2
- package/changesets/remark/plugins/aggregate-dependency-tables.js +0 -99
- package/changesets/remark/plugins/contributor-footnotes.js +0 -335
- package/changesets/remark/plugins/deduplicate-items.js +0 -32
- package/changesets/remark/plugins/issue-link-refs.js +0 -58
- package/changesets/remark/plugins/maintenance-note.js +0 -75
- package/changesets/remark/plugins/merge-sections.js +0 -43
- package/changesets/remark/plugins/normalize-format.js +0 -47
- package/changesets/remark/plugins/reorder-sections.js +0 -49
- package/changesets/remark/presets.js +0 -119
- package/changesets/remark/rules/content-structure.js +0 -22
- package/changesets/remark/rules/dependency-table-format.js +0 -38
- package/changesets/remark/rules/heading-hierarchy.js +0 -19
- package/changesets/remark/rules/required-sections.js +0 -17
- package/changesets/remark/rules/uncategorized-content.js +0 -31
- package/changesets/utils/remark-pipeline.js +0 -36
- package/changesets/utils/version-blocks.js +0 -108
package/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { AnalyzedWorkspace, BiomeSyncError, BiomeSyncError as BiomeSyncError$1, BiomeSyncOptions, BiomeSyncResult, BiomeSyncResult as BiomeSyncResult$1, ChangesetConfigError, ChangesetConfigError as ChangesetConfigError$1, ChangesetConfigFile, ChangesetConfigFile as ChangesetConfigFile$1, ConfigDiscoveryOptions, ConfigLocation, ConfigLocation as ConfigLocation$1, ConfigNotFoundError, ConfigSource, LIFECYCLE_SCRIPTS_CONFIG_KEY, PrBody, PublishTargetBindingError, PublishTargetBindingError as PublishTargetBindingError$1, SavvyBaseSection, SavvyHooksSection, SavvyInstallHook, SavvyInstallSection, SavvyOkfSection, SavvyToolchainSection, SilkChangesetConfigFile, SilkChangesetConfigFile as SilkChangesetConfigFile$1, SilkPublishConfig, WorkspaceAnalysis, WorkspaceAnalysis as WorkspaceAnalysis$1, WorkspaceAnalysisError, WorkspaceAnalysisError as WorkspaceAnalysisError$1, publishesBuiltLinkDirectory, savvyBasePreamble, savvyHooksHygiene, savvyInstallBlock, savvyInstallDeps, savvyOkfBlock, savvyOkfSync, savvyToolSection, savvyToolchainCheck } from "@savvy-web/silk-core";
|
|
1
|
+
import { AnalyzedWorkspace, BiomeSyncError, BiomeSyncError as BiomeSyncError$1, BiomeSyncOptions, BiomeSyncResult, BiomeSyncResult as BiomeSyncResult$1, ChangesetConfigError, ChangesetConfigError as ChangesetConfigError$1, ChangesetConfigFile, ChangesetConfigFile as ChangesetConfigFile$1, ConfigDiscoveryOptions, ConfigLocation, ConfigLocation as ConfigLocation$1, ConfigNotFoundError, ConfigSource, LIFECYCLE_SCRIPTS_CONFIG_KEY, PrBody, PublishTargetBindingError, PublishTargetBindingError as PublishTargetBindingError$1, ReleaseChannelError, ReleaseChannelError as ReleaseChannelError$1, SavvyBaseSection, SavvyHooksSection, SavvyInstallHook, SavvyInstallSection, SavvyOkfSection, SavvyToolchainSection, SilkChangesetConfigFile, SilkChangesetConfigFile as SilkChangesetConfigFile$1, SilkPublishConfig, WorkspaceAnalysis, WorkspaceAnalysis as WorkspaceAnalysis$1, WorkspaceAnalysisError, WorkspaceAnalysisError as WorkspaceAnalysisError$1, publishesBuiltLinkDirectory, savvyBasePreamble, savvyHooksHygiene, savvyInstallBlock, savvyInstallDeps, savvyOkfBlock, savvyOkfSync, savvyToolSection, savvyToolchainCheck } from "@savvy-web/silk-core";
|
|
2
2
|
import { Context, Data, Effect, FileSystem, Layer, Path, PlatformError, Schema } from "effect";
|
|
3
|
-
import {
|
|
3
|
+
import { Table } from "@effected/markdown";
|
|
4
4
|
import { ChildProcessSpawner } from "effect/process";
|
|
5
5
|
import { LockfileReader, PackageManagerDetector, PublishTarget, PublishabilityDetector, WorkspaceCatalogs, WorkspaceDiscovery, WorkspaceDiscoveryFailure, WorkspacePackage, WorkspaceSnapshotAtFailure, WorkspaceSnapshotWorktreeFailure, WorkspaceSnapshots, WorkspaceStateSnapshot, WorkspacesOptions } from "@effected/workspaces";
|
|
6
6
|
import { Git, GitCommandError, NotARepositoryError, UnknownRefError } from "@effected/git";
|
|
@@ -9,8 +9,6 @@ import * as PlatformError$1 from "effect/PlatformError";
|
|
|
9
9
|
import { YamlFormattingOptions } from "@effected/yaml";
|
|
10
10
|
import { Section, SectionId } from "@effected/templates";
|
|
11
11
|
import { ToolDiscovery } from "@effected/commands";
|
|
12
|
-
//#endregion
|
|
13
|
-
//#region src/changesets/categories/types.d.ts
|
|
14
12
|
/**
|
|
15
13
|
* Schema for a section category that defines how changes are grouped in release notes.
|
|
16
14
|
*
|
|
@@ -64,8 +62,6 @@ declare const SectionCategorySchema: Schema.Struct<{
|
|
|
64
62
|
* @public
|
|
65
63
|
*/
|
|
66
64
|
interface SectionCategory extends Schema.Schema.Type<typeof SectionCategorySchema> {}
|
|
67
|
-
//#endregion
|
|
68
|
-
//#region src/changesets/api/categories.d.ts
|
|
69
65
|
/**
|
|
70
66
|
* Static class wrapper for section category operations.
|
|
71
67
|
*
|
|
@@ -291,8 +287,6 @@ declare class Categories {
|
|
|
291
287
|
*/
|
|
292
288
|
static isValidHeading(heading: string): boolean;
|
|
293
289
|
}
|
|
294
|
-
//#endregion
|
|
295
|
-
//#region src/changesets/utils/logger.d.ts
|
|
296
290
|
/**
|
|
297
291
|
* How changelog warnings are emitted.
|
|
298
292
|
*
|
|
@@ -325,8 +319,6 @@ type ChangesetLogModeValue = "silent" | "github" | "stderr";
|
|
|
325
319
|
* @public
|
|
326
320
|
*/
|
|
327
321
|
declare const ChangesetLogMode: Context.Reference<ChangesetLogModeValue>;
|
|
328
|
-
//#endregion
|
|
329
|
-
//#region ../../node_modules/.pnpm/@changesets+types@7.0.0/node_modules/@changesets/types/dist/index.d.mts
|
|
330
322
|
//#region src/index.d.ts
|
|
331
323
|
type MaybePromise<T> = T | Promise<T>;
|
|
332
324
|
type VersionType$1 = "major" | "minor" | "patch" | "none";
|
|
@@ -455,8 +447,6 @@ type PreState = {
|
|
|
455
447
|
mode: "pre" | "exit";
|
|
456
448
|
tag: string;
|
|
457
449
|
};
|
|
458
|
-
//#endregion
|
|
459
|
-
//#region src/changesets/api/changelog.d.ts
|
|
460
450
|
/**
|
|
461
451
|
* Static class wrapper for changelog formatting operations.
|
|
462
452
|
*
|
|
@@ -576,1040 +566,6 @@ declare class Changelog {
|
|
|
576
566
|
*/
|
|
577
567
|
static formatDependencyReleaseLine(changesets: NewChangesetWithCommit[], dependenciesUpdated: ModCompWithPackage[], options: Record<string, unknown> | null, logMode?: ChangesetLogModeValue): Promise<string>;
|
|
578
568
|
}
|
|
579
|
-
//#endregion
|
|
580
|
-
//#region ../../node_modules/.pnpm/@types+unist@3.0.3/node_modules/@types/unist/index.d.ts
|
|
581
|
-
// ## Interfaces
|
|
582
|
-
/**
|
|
583
|
-
* Info associated with nodes by the ecosystem.
|
|
584
|
-
*
|
|
585
|
-
* This space is guaranteed to never be specified by unist or specifications
|
|
586
|
-
* implementing unist.
|
|
587
|
-
* But you can use it in utilities and plugins to store data.
|
|
588
|
-
*
|
|
589
|
-
* This type can be augmented to register custom data.
|
|
590
|
-
* For example:
|
|
591
|
-
*
|
|
592
|
-
* ```ts
|
|
593
|
-
* declare module 'unist' {
|
|
594
|
-
* interface Data {
|
|
595
|
-
* // `someNode.data.myId` is typed as `number | undefined`
|
|
596
|
-
* myId?: number | undefined
|
|
597
|
-
* }
|
|
598
|
-
* }
|
|
599
|
-
* ```
|
|
600
|
-
*/
|
|
601
|
-
interface Data$2 {}
|
|
602
|
-
/**
|
|
603
|
-
* One place in a source file.
|
|
604
|
-
*/
|
|
605
|
-
interface Point {
|
|
606
|
-
/**
|
|
607
|
-
* Line in a source file (1-indexed integer).
|
|
608
|
-
*/
|
|
609
|
-
line: number;
|
|
610
|
-
/**
|
|
611
|
-
* Column in a source file (1-indexed integer).
|
|
612
|
-
*/
|
|
613
|
-
column: number;
|
|
614
|
-
/**
|
|
615
|
-
* Character in a source file (0-indexed integer).
|
|
616
|
-
*/
|
|
617
|
-
offset?: number | undefined;
|
|
618
|
-
}
|
|
619
|
-
/**
|
|
620
|
-
* Position of a node in a source document.
|
|
621
|
-
*
|
|
622
|
-
* A position is a range between two points.
|
|
623
|
-
*/
|
|
624
|
-
interface Position {
|
|
625
|
-
/**
|
|
626
|
-
* Place of the first character of the parsed source region.
|
|
627
|
-
*/
|
|
628
|
-
start: Point;
|
|
629
|
-
/**
|
|
630
|
-
* Place of the first character after the parsed source region.
|
|
631
|
-
*/
|
|
632
|
-
end: Point;
|
|
633
|
-
}
|
|
634
|
-
/**
|
|
635
|
-
* Abstract unist node.
|
|
636
|
-
*
|
|
637
|
-
* The syntactic unit in unist syntax trees are called nodes.
|
|
638
|
-
*
|
|
639
|
-
* This interface is supposed to be extended.
|
|
640
|
-
* If you can use {@link Literal} or {@link Parent}, you should.
|
|
641
|
-
* But for example in markdown, a `thematicBreak` (`***`), is neither literal
|
|
642
|
-
* nor parent, but still a node.
|
|
643
|
-
*/
|
|
644
|
-
interface Node$1 {
|
|
645
|
-
/**
|
|
646
|
-
* Node type.
|
|
647
|
-
*/
|
|
648
|
-
type: string;
|
|
649
|
-
/**
|
|
650
|
-
* Info from the ecosystem.
|
|
651
|
-
*/
|
|
652
|
-
data?: Data$2 | undefined;
|
|
653
|
-
/**
|
|
654
|
-
* Position of a node in a source document.
|
|
655
|
-
*
|
|
656
|
-
* Nodes that are generated (not in the original source document) must not
|
|
657
|
-
* have a position.
|
|
658
|
-
*/
|
|
659
|
-
position?: Position | undefined;
|
|
660
|
-
}
|
|
661
|
-
//#endregion
|
|
662
|
-
//#region ../../node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts
|
|
663
|
-
// ## Enumeration
|
|
664
|
-
/**
|
|
665
|
-
* How phrasing content is aligned
|
|
666
|
-
* ({@link https://drafts.csswg.org/css-text/ | [CSSTEXT]}).
|
|
667
|
-
*
|
|
668
|
-
* * `'left'`: See the
|
|
669
|
-
* {@link https://drafts.csswg.org/css-text/#valdef-text-align-left | left}
|
|
670
|
-
* value of the `text-align` CSS property
|
|
671
|
-
* * `'right'`: See the
|
|
672
|
-
* {@link https://drafts.csswg.org/css-text/#valdef-text-align-right | right}
|
|
673
|
-
* value of the `text-align` CSS property
|
|
674
|
-
* * `'center'`: See the
|
|
675
|
-
* {@link https://drafts.csswg.org/css-text/#valdef-text-align-center | center}
|
|
676
|
-
* value of the `text-align` CSS property
|
|
677
|
-
* * `null`: phrasing content is aligned as defined by the host environment
|
|
678
|
-
*
|
|
679
|
-
* Used in GFM tables.
|
|
680
|
-
*/
|
|
681
|
-
type AlignType = "center" | "left" | "right" | null;
|
|
682
|
-
/**
|
|
683
|
-
* Explicitness of a reference.
|
|
684
|
-
*
|
|
685
|
-
* `'shortcut'`: the reference is implicit, its identifier inferred from its
|
|
686
|
-
* content
|
|
687
|
-
* `'collapsed'`: the reference is explicit, its identifier inferred from its
|
|
688
|
-
* content
|
|
689
|
-
* `'full'`: the reference is explicit, its identifier explicitly set
|
|
690
|
-
*/
|
|
691
|
-
type ReferenceType = "shortcut" | "collapsed" | "full";
|
|
692
|
-
// ## Mixin
|
|
693
|
-
/**
|
|
694
|
-
* Node with a fallback.
|
|
695
|
-
*/
|
|
696
|
-
interface Alternative {
|
|
697
|
-
/**
|
|
698
|
-
* Equivalent content for environments that cannot represent the node as
|
|
699
|
-
* intended.
|
|
700
|
-
*/
|
|
701
|
-
alt?: string | null | undefined;
|
|
702
|
-
}
|
|
703
|
-
/**
|
|
704
|
-
* Internal relation from one node to another.
|
|
705
|
-
*
|
|
706
|
-
* Whether the value of `identifier` is expected to be a unique identifier or
|
|
707
|
-
* not depends on the type of node including the Association.
|
|
708
|
-
* An example of this is that they should be unique on {@link Definition},
|
|
709
|
-
* whereas multiple {@link LinkReference}s can be non-unique to be associated
|
|
710
|
-
* with one definition.
|
|
711
|
-
*/
|
|
712
|
-
interface Association {
|
|
713
|
-
/**
|
|
714
|
-
* Relation of association.
|
|
715
|
-
*
|
|
716
|
-
* `identifier` is a source value: character escapes and character
|
|
717
|
-
* references are not parsed.
|
|
718
|
-
*
|
|
719
|
-
* It can match another node.
|
|
720
|
-
*
|
|
721
|
-
* Its value must be normalized.
|
|
722
|
-
* To normalize a value, collapse markdown whitespace (`[\t\n\r ]+`) to a space,
|
|
723
|
-
* trim the optional initial and/or final space, and perform Unicode-aware
|
|
724
|
-
* case-folding.
|
|
725
|
-
*/
|
|
726
|
-
identifier: string;
|
|
727
|
-
/**
|
|
728
|
-
* Relation of association, in parsed form.
|
|
729
|
-
*
|
|
730
|
-
* `label` is a `string` value: it works just like `title` on {@link Link}
|
|
731
|
-
* or a `lang` on {@link Code}: character escapes and character references
|
|
732
|
-
* are parsed.
|
|
733
|
-
*
|
|
734
|
-
* It can match another node.
|
|
735
|
-
*/
|
|
736
|
-
label?: string | null | undefined;
|
|
737
|
-
}
|
|
738
|
-
/**
|
|
739
|
-
* Marker that is associated to another node.
|
|
740
|
-
*/
|
|
741
|
-
interface Reference extends Association {
|
|
742
|
-
/**
|
|
743
|
-
* Explicitness of the reference.
|
|
744
|
-
*/
|
|
745
|
-
referenceType: ReferenceType;
|
|
746
|
-
}
|
|
747
|
-
/**
|
|
748
|
-
* Reference to resource.
|
|
749
|
-
*/
|
|
750
|
-
interface Resource {
|
|
751
|
-
/**
|
|
752
|
-
* URL to the referenced resource.
|
|
753
|
-
*/
|
|
754
|
-
url: string;
|
|
755
|
-
/**
|
|
756
|
-
* Advisory information for the resource, such as would be appropriate for
|
|
757
|
-
* a tooltip.
|
|
758
|
-
*/
|
|
759
|
-
title?: string | null | undefined;
|
|
760
|
-
}
|
|
761
|
-
// ## Interfaces
|
|
762
|
-
/**
|
|
763
|
-
* Info associated with mdast nodes by the ecosystem.
|
|
764
|
-
*
|
|
765
|
-
* This space is guaranteed to never be specified by unist or mdast.
|
|
766
|
-
* But you can use it in utilities and plugins to store data.
|
|
767
|
-
*
|
|
768
|
-
* This type can be augmented to register custom data.
|
|
769
|
-
* For example:
|
|
770
|
-
*
|
|
771
|
-
* ```ts
|
|
772
|
-
* declare module 'mdast' {
|
|
773
|
-
* interface Data {
|
|
774
|
-
* // `someNode.data.myId` is typed as `number | undefined`
|
|
775
|
-
* myId?: number | undefined
|
|
776
|
-
* }
|
|
777
|
-
* }
|
|
778
|
-
* ```
|
|
779
|
-
*/
|
|
780
|
-
interface Data$1 extends Data$2 {}
|
|
781
|
-
// ## Content maps
|
|
782
|
-
/**
|
|
783
|
-
* Union of registered mdast nodes that can occur where block content is
|
|
784
|
-
* expected.
|
|
785
|
-
*
|
|
786
|
-
* To register custom mdast nodes, add them to {@link BlockContentMap}.
|
|
787
|
-
* They will be automatically added here.
|
|
788
|
-
*/
|
|
789
|
-
type BlockContent = BlockContentMap[keyof BlockContentMap];
|
|
790
|
-
/**
|
|
791
|
-
* Registry of all mdast nodes that can occur where {@link BlockContent} is
|
|
792
|
-
* expected.
|
|
793
|
-
*
|
|
794
|
-
* This interface can be augmented to register custom node types:
|
|
795
|
-
*
|
|
796
|
-
* ```ts
|
|
797
|
-
* declare module 'mdast' {
|
|
798
|
-
* interface BlockContentMap {
|
|
799
|
-
* // Allow using MDX ESM nodes defined by `remark-mdx`.
|
|
800
|
-
* mdxjsEsm: MdxjsEsm;
|
|
801
|
-
* }
|
|
802
|
-
* }
|
|
803
|
-
* ```
|
|
804
|
-
*
|
|
805
|
-
* For a union of all block content, see {@link RootContent}.
|
|
806
|
-
*/
|
|
807
|
-
interface BlockContentMap {
|
|
808
|
-
blockquote: Blockquote;
|
|
809
|
-
code: Code;
|
|
810
|
-
heading: Heading;
|
|
811
|
-
html: Html;
|
|
812
|
-
list: List;
|
|
813
|
-
paragraph: Paragraph;
|
|
814
|
-
table: Table;
|
|
815
|
-
thematicBreak: ThematicBreak;
|
|
816
|
-
}
|
|
817
|
-
/**
|
|
818
|
-
* Union of registered mdast nodes that can occur where definition content is
|
|
819
|
-
* expected.
|
|
820
|
-
*
|
|
821
|
-
* To register custom mdast nodes, add them to {@link DefinitionContentMap}.
|
|
822
|
-
* They will be automatically added here.
|
|
823
|
-
*/
|
|
824
|
-
type DefinitionContent = DefinitionContentMap[keyof DefinitionContentMap];
|
|
825
|
-
/**
|
|
826
|
-
* Registry of all mdast nodes that can occur where {@link DefinitionContent}
|
|
827
|
-
* is expected.
|
|
828
|
-
*
|
|
829
|
-
* This interface can be augmented to register custom node types:
|
|
830
|
-
*
|
|
831
|
-
* ```ts
|
|
832
|
-
* declare module 'mdast' {
|
|
833
|
-
* interface DefinitionContentMap {
|
|
834
|
-
* custom: Custom;
|
|
835
|
-
* }
|
|
836
|
-
* }
|
|
837
|
-
* ```
|
|
838
|
-
*
|
|
839
|
-
* For a union of all definition content, see {@link RootContent}.
|
|
840
|
-
*/
|
|
841
|
-
interface DefinitionContentMap {
|
|
842
|
-
definition: Definition;
|
|
843
|
-
footnoteDefinition: FootnoteDefinition;
|
|
844
|
-
}
|
|
845
|
-
/**
|
|
846
|
-
* Union of registered mdast nodes that can occur where list content is
|
|
847
|
-
* expected.
|
|
848
|
-
*
|
|
849
|
-
* To register custom mdast nodes, add them to {@link ListContentMap}.
|
|
850
|
-
* They will be automatically added here.
|
|
851
|
-
*/
|
|
852
|
-
type ListContent = ListContentMap[keyof ListContentMap];
|
|
853
|
-
/**
|
|
854
|
-
* Registry of all mdast nodes that can occur where {@link ListContent}
|
|
855
|
-
* is expected.
|
|
856
|
-
*
|
|
857
|
-
* This interface can be augmented to register custom node types:
|
|
858
|
-
*
|
|
859
|
-
* ```ts
|
|
860
|
-
* declare module 'mdast' {
|
|
861
|
-
* interface ListContentMap {
|
|
862
|
-
* custom: Custom;
|
|
863
|
-
* }
|
|
864
|
-
* }
|
|
865
|
-
* ```
|
|
866
|
-
*
|
|
867
|
-
* For a union of all list content, see {@link RootContent}.
|
|
868
|
-
*/
|
|
869
|
-
interface ListContentMap {
|
|
870
|
-
listItem: ListItem;
|
|
871
|
-
}
|
|
872
|
-
/**
|
|
873
|
-
* Union of registered mdast nodes that can occur where phrasing content is
|
|
874
|
-
* expected.
|
|
875
|
-
*
|
|
876
|
-
* To register custom mdast nodes, add them to {@link PhrasingContentMap}.
|
|
877
|
-
* They will be automatically added here.
|
|
878
|
-
*/
|
|
879
|
-
type PhrasingContent = PhrasingContentMap[keyof PhrasingContentMap];
|
|
880
|
-
/**
|
|
881
|
-
* Registry of all mdast nodes that can occur where {@link PhrasingContent}
|
|
882
|
-
* is expected.
|
|
883
|
-
*
|
|
884
|
-
* This interface can be augmented to register custom node types:
|
|
885
|
-
*
|
|
886
|
-
* ```ts
|
|
887
|
-
* declare module 'mdast' {
|
|
888
|
-
* interface PhrasingContentMap {
|
|
889
|
-
* // Allow using MDX JSX (text) nodes defined by `remark-mdx`.
|
|
890
|
-
* mdxJsxTextElement: MDXJSXTextElement;
|
|
891
|
-
* }
|
|
892
|
-
* }
|
|
893
|
-
* ```
|
|
894
|
-
*
|
|
895
|
-
* For a union of all phrasing content, see {@link RootContent}.
|
|
896
|
-
*/
|
|
897
|
-
interface PhrasingContentMap {
|
|
898
|
-
break: Break;
|
|
899
|
-
delete: Delete;
|
|
900
|
-
emphasis: Emphasis;
|
|
901
|
-
footnoteReference: FootnoteReference;
|
|
902
|
-
html: Html;
|
|
903
|
-
image: Image;
|
|
904
|
-
imageReference: ImageReference;
|
|
905
|
-
inlineCode: InlineCode;
|
|
906
|
-
link: Link;
|
|
907
|
-
linkReference: LinkReference;
|
|
908
|
-
strong: Strong;
|
|
909
|
-
text: Text;
|
|
910
|
-
}
|
|
911
|
-
/**
|
|
912
|
-
* Union of registered mdast nodes that can occur in {@link Root}.
|
|
913
|
-
*
|
|
914
|
-
* To register custom mdast nodes, add them to {@link RootContentMap}.
|
|
915
|
-
* They will be automatically added here.
|
|
916
|
-
*/
|
|
917
|
-
type RootContent = RootContentMap[keyof RootContentMap];
|
|
918
|
-
/**
|
|
919
|
-
* Registry of all mdast nodes that can occur as children of {@link Root}.
|
|
920
|
-
*
|
|
921
|
-
* > **Note**: {@link Root} does not need to be an entire document.
|
|
922
|
-
* > it can also be a fragment.
|
|
923
|
-
*
|
|
924
|
-
* This interface can be augmented to register custom node types:
|
|
925
|
-
*
|
|
926
|
-
* ```ts
|
|
927
|
-
* declare module 'mdast' {
|
|
928
|
-
* interface RootContentMap {
|
|
929
|
-
* // Allow using toml nodes defined by `remark-frontmatter`.
|
|
930
|
-
* toml: TOML;
|
|
931
|
-
* }
|
|
932
|
-
* }
|
|
933
|
-
* ```
|
|
934
|
-
*
|
|
935
|
-
* For a union of all {@link Root} children, see {@link RootContent}.
|
|
936
|
-
*/
|
|
937
|
-
interface RootContentMap {
|
|
938
|
-
blockquote: Blockquote;
|
|
939
|
-
break: Break;
|
|
940
|
-
code: Code;
|
|
941
|
-
definition: Definition;
|
|
942
|
-
delete: Delete;
|
|
943
|
-
emphasis: Emphasis;
|
|
944
|
-
footnoteDefinition: FootnoteDefinition;
|
|
945
|
-
footnoteReference: FootnoteReference;
|
|
946
|
-
heading: Heading;
|
|
947
|
-
html: Html;
|
|
948
|
-
image: Image;
|
|
949
|
-
imageReference: ImageReference;
|
|
950
|
-
inlineCode: InlineCode;
|
|
951
|
-
link: Link;
|
|
952
|
-
linkReference: LinkReference;
|
|
953
|
-
list: List;
|
|
954
|
-
listItem: ListItem;
|
|
955
|
-
paragraph: Paragraph;
|
|
956
|
-
strong: Strong;
|
|
957
|
-
table: Table;
|
|
958
|
-
tableCell: TableCell;
|
|
959
|
-
tableRow: TableRow;
|
|
960
|
-
text: Text;
|
|
961
|
-
thematicBreak: ThematicBreak;
|
|
962
|
-
yaml: Yaml$1;
|
|
963
|
-
}
|
|
964
|
-
/**
|
|
965
|
-
* Union of registered mdast nodes that can occur where row content is
|
|
966
|
-
* expected.
|
|
967
|
-
*
|
|
968
|
-
* To register custom mdast nodes, add them to {@link RowContentMap}.
|
|
969
|
-
* They will be automatically added here.
|
|
970
|
-
*/
|
|
971
|
-
type RowContent = RowContentMap[keyof RowContentMap];
|
|
972
|
-
/**
|
|
973
|
-
* Registry of all mdast nodes that can occur where {@link RowContent}
|
|
974
|
-
* is expected.
|
|
975
|
-
*
|
|
976
|
-
* This interface can be augmented to register custom node types:
|
|
977
|
-
*
|
|
978
|
-
* ```ts
|
|
979
|
-
* declare module 'mdast' {
|
|
980
|
-
* interface RowContentMap {
|
|
981
|
-
* custom: Custom;
|
|
982
|
-
* }
|
|
983
|
-
* }
|
|
984
|
-
* ```
|
|
985
|
-
*
|
|
986
|
-
* For a union of all row content, see {@link RootContent}.
|
|
987
|
-
*/
|
|
988
|
-
interface RowContentMap {
|
|
989
|
-
tableCell: TableCell;
|
|
990
|
-
}
|
|
991
|
-
/**
|
|
992
|
-
* Union of registered mdast nodes that can occur where table content is
|
|
993
|
-
* expected.
|
|
994
|
-
*
|
|
995
|
-
* To register custom mdast nodes, add them to {@link TableContentMap}.
|
|
996
|
-
* They will be automatically added here.
|
|
997
|
-
*/
|
|
998
|
-
type TableContent = TableContentMap[keyof TableContentMap];
|
|
999
|
-
/**
|
|
1000
|
-
* Registry of all mdast nodes that can occur where {@link TableContent}
|
|
1001
|
-
* is expected.
|
|
1002
|
-
*
|
|
1003
|
-
* This interface can be augmented to register custom node types:
|
|
1004
|
-
*
|
|
1005
|
-
* ```ts
|
|
1006
|
-
* declare module 'mdast' {
|
|
1007
|
-
* interface TableContentMap {
|
|
1008
|
-
* custom: Custom;
|
|
1009
|
-
* }
|
|
1010
|
-
* }
|
|
1011
|
-
* ```
|
|
1012
|
-
*
|
|
1013
|
-
* For a union of all table content, see {@link RootContent}.
|
|
1014
|
-
*/
|
|
1015
|
-
interface TableContentMap {
|
|
1016
|
-
tableRow: TableRow;
|
|
1017
|
-
}
|
|
1018
|
-
// ## Abstract nodes
|
|
1019
|
-
/**
|
|
1020
|
-
* Abstract mdast node that contains the smallest possible value.
|
|
1021
|
-
*
|
|
1022
|
-
* This interface is supposed to be extended if you make custom mdast nodes.
|
|
1023
|
-
*
|
|
1024
|
-
* For a union of all registered mdast literals, see {@link Literals}.
|
|
1025
|
-
*/
|
|
1026
|
-
interface Literal extends Node {
|
|
1027
|
-
/**
|
|
1028
|
-
* Plain-text value.
|
|
1029
|
-
*/
|
|
1030
|
-
value: string;
|
|
1031
|
-
}
|
|
1032
|
-
/**
|
|
1033
|
-
* Abstract mdast node.
|
|
1034
|
-
*
|
|
1035
|
-
* This interface is supposed to be extended.
|
|
1036
|
-
* If you can use {@link Literal} or {@link Parent}, you should.
|
|
1037
|
-
* But for example in markdown, a thematic break (`***`) is neither literal nor
|
|
1038
|
-
* parent, but still a node.
|
|
1039
|
-
*
|
|
1040
|
-
* To register custom mdast nodes, add them to {@link RootContentMap} and other
|
|
1041
|
-
* places where relevant (such as {@link ElementContentMap}).
|
|
1042
|
-
*
|
|
1043
|
-
* For a union of all registered mdast nodes, see {@link Nodes}.
|
|
1044
|
-
*/
|
|
1045
|
-
interface Node extends Node$1 {
|
|
1046
|
-
/**
|
|
1047
|
-
* Info from the ecosystem.
|
|
1048
|
-
*/
|
|
1049
|
-
data?: Data$1 | undefined;
|
|
1050
|
-
}
|
|
1051
|
-
/**
|
|
1052
|
-
* Abstract mdast node that contains other mdast nodes (*children*).
|
|
1053
|
-
*
|
|
1054
|
-
* This interface is supposed to be extended if you make custom mdast nodes.
|
|
1055
|
-
*
|
|
1056
|
-
* For a union of all registered mdast parents, see {@link Parents}.
|
|
1057
|
-
*/
|
|
1058
|
-
interface Parent extends Node {
|
|
1059
|
-
/**
|
|
1060
|
-
* List of children.
|
|
1061
|
-
*/
|
|
1062
|
-
children: RootContent[];
|
|
1063
|
-
}
|
|
1064
|
-
// ## Concrete nodes
|
|
1065
|
-
/**
|
|
1066
|
-
* Markdown block quote.
|
|
1067
|
-
*/
|
|
1068
|
-
interface Blockquote extends Parent {
|
|
1069
|
-
/**
|
|
1070
|
-
* Node type of mdast block quote.
|
|
1071
|
-
*/
|
|
1072
|
-
type: "blockquote";
|
|
1073
|
-
/**
|
|
1074
|
-
* Children of block quote.
|
|
1075
|
-
*/
|
|
1076
|
-
children: Array<BlockContent | DefinitionContent>;
|
|
1077
|
-
/**
|
|
1078
|
-
* Data associated with the mdast block quote.
|
|
1079
|
-
*/
|
|
1080
|
-
data?: BlockquoteData | undefined;
|
|
1081
|
-
}
|
|
1082
|
-
/**
|
|
1083
|
-
* Info associated with mdast block quote nodes by the ecosystem.
|
|
1084
|
-
*/
|
|
1085
|
-
interface BlockquoteData extends Data$1 {}
|
|
1086
|
-
/**
|
|
1087
|
-
* Markdown break.
|
|
1088
|
-
*/
|
|
1089
|
-
interface Break extends Node {
|
|
1090
|
-
/**
|
|
1091
|
-
* Node type of mdast break.
|
|
1092
|
-
*/
|
|
1093
|
-
type: "break";
|
|
1094
|
-
/**
|
|
1095
|
-
* Data associated with the mdast break.
|
|
1096
|
-
*/
|
|
1097
|
-
data?: BreakData | undefined;
|
|
1098
|
-
}
|
|
1099
|
-
/**
|
|
1100
|
-
* Info associated with mdast break nodes by the ecosystem.
|
|
1101
|
-
*/
|
|
1102
|
-
interface BreakData extends Data$1 {}
|
|
1103
|
-
/**
|
|
1104
|
-
* Markdown code (flow) (block).
|
|
1105
|
-
*/
|
|
1106
|
-
interface Code extends Literal {
|
|
1107
|
-
/**
|
|
1108
|
-
* Node type of mdast code (flow).
|
|
1109
|
-
*/
|
|
1110
|
-
type: "code";
|
|
1111
|
-
/**
|
|
1112
|
-
* Language of computer code being marked up.
|
|
1113
|
-
*/
|
|
1114
|
-
lang?: string | null | undefined;
|
|
1115
|
-
/**
|
|
1116
|
-
* Custom information relating to the node.
|
|
1117
|
-
*
|
|
1118
|
-
* If the lang field is present, a meta field can be present.
|
|
1119
|
-
*/
|
|
1120
|
-
meta?: string | null | undefined;
|
|
1121
|
-
/**
|
|
1122
|
-
* Data associated with the mdast code (flow).
|
|
1123
|
-
*/
|
|
1124
|
-
data?: CodeData | undefined;
|
|
1125
|
-
}
|
|
1126
|
-
/**
|
|
1127
|
-
* Info associated with mdast code (flow) (block) nodes by the ecosystem.
|
|
1128
|
-
*/
|
|
1129
|
-
interface CodeData extends Data$1 {}
|
|
1130
|
-
/**
|
|
1131
|
-
* Markdown definition.
|
|
1132
|
-
*/
|
|
1133
|
-
interface Definition extends Node, Association, Resource {
|
|
1134
|
-
/**
|
|
1135
|
-
* Node type of mdast definition.
|
|
1136
|
-
*/
|
|
1137
|
-
type: "definition";
|
|
1138
|
-
/**
|
|
1139
|
-
* Data associated with the mdast definition.
|
|
1140
|
-
*/
|
|
1141
|
-
data?: DefinitionData | undefined;
|
|
1142
|
-
}
|
|
1143
|
-
/**
|
|
1144
|
-
* Info associated with mdast definition nodes by the ecosystem.
|
|
1145
|
-
*/
|
|
1146
|
-
interface DefinitionData extends Data$1 {}
|
|
1147
|
-
/**
|
|
1148
|
-
* Markdown GFM delete (strikethrough).
|
|
1149
|
-
*/
|
|
1150
|
-
interface Delete extends Parent {
|
|
1151
|
-
/**
|
|
1152
|
-
* Node type of mdast GFM delete.
|
|
1153
|
-
*/
|
|
1154
|
-
type: "delete";
|
|
1155
|
-
/**
|
|
1156
|
-
* Children of GFM delete.
|
|
1157
|
-
*/
|
|
1158
|
-
children: PhrasingContent[];
|
|
1159
|
-
/**
|
|
1160
|
-
* Data associated with the mdast GFM delete.
|
|
1161
|
-
*/
|
|
1162
|
-
data?: DeleteData | undefined;
|
|
1163
|
-
}
|
|
1164
|
-
/**
|
|
1165
|
-
* Info associated with mdast GFM delete nodes by the ecosystem.
|
|
1166
|
-
*/
|
|
1167
|
-
interface DeleteData extends Data$1 {}
|
|
1168
|
-
/**
|
|
1169
|
-
* Markdown emphasis.
|
|
1170
|
-
*/
|
|
1171
|
-
interface Emphasis extends Parent {
|
|
1172
|
-
/**
|
|
1173
|
-
* Node type of mdast emphasis.
|
|
1174
|
-
*/
|
|
1175
|
-
type: "emphasis";
|
|
1176
|
-
/**
|
|
1177
|
-
* Children of emphasis.
|
|
1178
|
-
*/
|
|
1179
|
-
children: PhrasingContent[];
|
|
1180
|
-
/**
|
|
1181
|
-
* Data associated with the mdast emphasis.
|
|
1182
|
-
*/
|
|
1183
|
-
data?: EmphasisData | undefined;
|
|
1184
|
-
}
|
|
1185
|
-
/**
|
|
1186
|
-
* Info associated with mdast emphasis nodes by the ecosystem.
|
|
1187
|
-
*/
|
|
1188
|
-
interface EmphasisData extends Data$1 {}
|
|
1189
|
-
/**
|
|
1190
|
-
* Markdown GFM footnote definition.
|
|
1191
|
-
*/
|
|
1192
|
-
interface FootnoteDefinition extends Parent, Association {
|
|
1193
|
-
/**
|
|
1194
|
-
* Node type of mdast GFM footnote definition.
|
|
1195
|
-
*/
|
|
1196
|
-
type: "footnoteDefinition";
|
|
1197
|
-
/**
|
|
1198
|
-
* Children of GFM footnote definition.
|
|
1199
|
-
*/
|
|
1200
|
-
children: Array<BlockContent | DefinitionContent>;
|
|
1201
|
-
/**
|
|
1202
|
-
* Data associated with the mdast GFM footnote definition.
|
|
1203
|
-
*/
|
|
1204
|
-
data?: FootnoteDefinitionData | undefined;
|
|
1205
|
-
}
|
|
1206
|
-
/**
|
|
1207
|
-
* Info associated with mdast GFM footnote definition nodes by the ecosystem.
|
|
1208
|
-
*/
|
|
1209
|
-
interface FootnoteDefinitionData extends Data$1 {}
|
|
1210
|
-
/**
|
|
1211
|
-
* Markdown GFM footnote reference.
|
|
1212
|
-
*/
|
|
1213
|
-
interface FootnoteReference extends Association, Node {
|
|
1214
|
-
/**
|
|
1215
|
-
* Node type of mdast GFM footnote reference.
|
|
1216
|
-
*/
|
|
1217
|
-
type: "footnoteReference";
|
|
1218
|
-
/**
|
|
1219
|
-
* Data associated with the mdast GFM footnote reference.
|
|
1220
|
-
*/
|
|
1221
|
-
data?: FootnoteReferenceData | undefined;
|
|
1222
|
-
}
|
|
1223
|
-
/**
|
|
1224
|
-
* Info associated with mdast GFM footnote reference nodes by the ecosystem.
|
|
1225
|
-
*/
|
|
1226
|
-
interface FootnoteReferenceData extends Data$1 {}
|
|
1227
|
-
/**
|
|
1228
|
-
* Markdown heading.
|
|
1229
|
-
*/
|
|
1230
|
-
interface Heading extends Parent {
|
|
1231
|
-
/**
|
|
1232
|
-
* Node type of mdast heading.
|
|
1233
|
-
*/
|
|
1234
|
-
type: "heading";
|
|
1235
|
-
/**
|
|
1236
|
-
* Heading rank.
|
|
1237
|
-
*
|
|
1238
|
-
* A value of `1` is said to be the highest rank and `6` the lowest.
|
|
1239
|
-
*/
|
|
1240
|
-
depth: 1 | 2 | 3 | 4 | 5 | 6;
|
|
1241
|
-
/**
|
|
1242
|
-
* Children of heading.
|
|
1243
|
-
*/
|
|
1244
|
-
children: PhrasingContent[];
|
|
1245
|
-
/**
|
|
1246
|
-
* Data associated with the mdast heading.
|
|
1247
|
-
*/
|
|
1248
|
-
data?: HeadingData | undefined;
|
|
1249
|
-
}
|
|
1250
|
-
/**
|
|
1251
|
-
* Info associated with mdast heading nodes by the ecosystem.
|
|
1252
|
-
*/
|
|
1253
|
-
interface HeadingData extends Data$1 {}
|
|
1254
|
-
/**
|
|
1255
|
-
* Markdown HTML.
|
|
1256
|
-
*/
|
|
1257
|
-
interface Html extends Literal {
|
|
1258
|
-
/**
|
|
1259
|
-
* Node type of mdast HTML.
|
|
1260
|
-
*/
|
|
1261
|
-
type: "html";
|
|
1262
|
-
/**
|
|
1263
|
-
* Data associated with the mdast HTML.
|
|
1264
|
-
*/
|
|
1265
|
-
data?: HtmlData | undefined;
|
|
1266
|
-
}
|
|
1267
|
-
/**
|
|
1268
|
-
* Info associated with mdast HTML nodes by the ecosystem.
|
|
1269
|
-
*/
|
|
1270
|
-
interface HtmlData extends Data$1 {}
|
|
1271
|
-
/**
|
|
1272
|
-
* Markdown image.
|
|
1273
|
-
*/
|
|
1274
|
-
interface Image extends Alternative, Node, Resource {
|
|
1275
|
-
/**
|
|
1276
|
-
* Node type of mdast image.
|
|
1277
|
-
*/
|
|
1278
|
-
type: "image";
|
|
1279
|
-
/**
|
|
1280
|
-
* Data associated with the mdast image.
|
|
1281
|
-
*/
|
|
1282
|
-
data?: ImageData | undefined;
|
|
1283
|
-
}
|
|
1284
|
-
/**
|
|
1285
|
-
* Info associated with mdast image nodes by the ecosystem.
|
|
1286
|
-
*/
|
|
1287
|
-
interface ImageData extends Data$1 {}
|
|
1288
|
-
/**
|
|
1289
|
-
* Markdown image reference.
|
|
1290
|
-
*/
|
|
1291
|
-
interface ImageReference extends Alternative, Node, Reference {
|
|
1292
|
-
/**
|
|
1293
|
-
* Node type of mdast image reference.
|
|
1294
|
-
*/
|
|
1295
|
-
type: "imageReference";
|
|
1296
|
-
/**
|
|
1297
|
-
* Data associated with the mdast image reference.
|
|
1298
|
-
*/
|
|
1299
|
-
data?: ImageReferenceData | undefined;
|
|
1300
|
-
}
|
|
1301
|
-
/**
|
|
1302
|
-
* Info associated with mdast image reference nodes by the ecosystem.
|
|
1303
|
-
*/
|
|
1304
|
-
interface ImageReferenceData extends Data$1 {}
|
|
1305
|
-
/**
|
|
1306
|
-
* Markdown code (text) (inline).
|
|
1307
|
-
*/
|
|
1308
|
-
interface InlineCode extends Literal {
|
|
1309
|
-
/**
|
|
1310
|
-
* Node type of mdast code (text).
|
|
1311
|
-
*/
|
|
1312
|
-
type: "inlineCode";
|
|
1313
|
-
/**
|
|
1314
|
-
* Data associated with the mdast code (text).
|
|
1315
|
-
*/
|
|
1316
|
-
data?: InlineCodeData | undefined;
|
|
1317
|
-
}
|
|
1318
|
-
/**
|
|
1319
|
-
* Info associated with mdast code (text) (inline) nodes by the ecosystem.
|
|
1320
|
-
*/
|
|
1321
|
-
interface InlineCodeData extends Data$1 {}
|
|
1322
|
-
/**
|
|
1323
|
-
* Markdown link.
|
|
1324
|
-
*/
|
|
1325
|
-
interface Link extends Parent, Resource {
|
|
1326
|
-
/**
|
|
1327
|
-
* Node type of mdast link.
|
|
1328
|
-
*/
|
|
1329
|
-
type: "link";
|
|
1330
|
-
/**
|
|
1331
|
-
* Children of link.
|
|
1332
|
-
*/
|
|
1333
|
-
children: PhrasingContent[];
|
|
1334
|
-
/**
|
|
1335
|
-
* Data associated with the mdast link.
|
|
1336
|
-
*/
|
|
1337
|
-
data?: LinkData | undefined;
|
|
1338
|
-
}
|
|
1339
|
-
/**
|
|
1340
|
-
* Info associated with mdast link nodes by the ecosystem.
|
|
1341
|
-
*/
|
|
1342
|
-
interface LinkData extends Data$1 {}
|
|
1343
|
-
/**
|
|
1344
|
-
* Markdown link reference.
|
|
1345
|
-
*/
|
|
1346
|
-
interface LinkReference extends Parent, Reference {
|
|
1347
|
-
/**
|
|
1348
|
-
* Node type of mdast link reference.
|
|
1349
|
-
*/
|
|
1350
|
-
type: "linkReference";
|
|
1351
|
-
/**
|
|
1352
|
-
* Children of link reference.
|
|
1353
|
-
*/
|
|
1354
|
-
children: PhrasingContent[];
|
|
1355
|
-
/**
|
|
1356
|
-
* Data associated with the mdast link reference.
|
|
1357
|
-
*/
|
|
1358
|
-
data?: LinkReferenceData | undefined;
|
|
1359
|
-
}
|
|
1360
|
-
/**
|
|
1361
|
-
* Info associated with mdast link reference nodes by the ecosystem.
|
|
1362
|
-
*/
|
|
1363
|
-
interface LinkReferenceData extends Data$1 {}
|
|
1364
|
-
/**
|
|
1365
|
-
* Markdown list.
|
|
1366
|
-
*/
|
|
1367
|
-
interface List extends Parent {
|
|
1368
|
-
/**
|
|
1369
|
-
* Node type of mdast list.
|
|
1370
|
-
*/
|
|
1371
|
-
type: "list";
|
|
1372
|
-
/**
|
|
1373
|
-
* Whether the items have been intentionally ordered (when `true`), or that
|
|
1374
|
-
* the order of items is not important (when `false` or not present).
|
|
1375
|
-
*/
|
|
1376
|
-
ordered?: boolean | null | undefined;
|
|
1377
|
-
/**
|
|
1378
|
-
* The starting number of the list, when the `ordered` field is `true`.
|
|
1379
|
-
*/
|
|
1380
|
-
start?: number | null | undefined;
|
|
1381
|
-
/**
|
|
1382
|
-
* Whether one or more of the children are separated with a blank line from
|
|
1383
|
-
* its siblings (when `true`), or not (when `false` or not present).
|
|
1384
|
-
*/
|
|
1385
|
-
spread?: boolean | null | undefined;
|
|
1386
|
-
/**
|
|
1387
|
-
* Children of list.
|
|
1388
|
-
*/
|
|
1389
|
-
children: ListContent[];
|
|
1390
|
-
/**
|
|
1391
|
-
* Data associated with the mdast list.
|
|
1392
|
-
*/
|
|
1393
|
-
data?: ListData | undefined;
|
|
1394
|
-
}
|
|
1395
|
-
/**
|
|
1396
|
-
* Info associated with mdast list nodes by the ecosystem.
|
|
1397
|
-
*/
|
|
1398
|
-
interface ListData extends Data$1 {}
|
|
1399
|
-
/**
|
|
1400
|
-
* Markdown list item.
|
|
1401
|
-
*/
|
|
1402
|
-
interface ListItem extends Parent {
|
|
1403
|
-
/**
|
|
1404
|
-
* Node type of mdast list item.
|
|
1405
|
-
*/
|
|
1406
|
-
type: "listItem";
|
|
1407
|
-
/**
|
|
1408
|
-
* Whether the item is a tasklist item (when `boolean`).
|
|
1409
|
-
*
|
|
1410
|
-
* When `true`, the item is complete.
|
|
1411
|
-
* When `false`, the item is incomplete.
|
|
1412
|
-
*/
|
|
1413
|
-
checked?: boolean | null | undefined;
|
|
1414
|
-
/**
|
|
1415
|
-
* Whether one or more of the children are separated with a blank line from
|
|
1416
|
-
* its siblings (when `true`), or not (when `false` or not present).
|
|
1417
|
-
*/
|
|
1418
|
-
spread?: boolean | null | undefined;
|
|
1419
|
-
/**
|
|
1420
|
-
* Children of list item.
|
|
1421
|
-
*/
|
|
1422
|
-
children: Array<BlockContent | DefinitionContent>;
|
|
1423
|
-
/**
|
|
1424
|
-
* Data associated with the mdast list item.
|
|
1425
|
-
*/
|
|
1426
|
-
data?: ListItemData | undefined;
|
|
1427
|
-
}
|
|
1428
|
-
/**
|
|
1429
|
-
* Info associated with mdast list item nodes by the ecosystem.
|
|
1430
|
-
*/
|
|
1431
|
-
interface ListItemData extends Data$1 {}
|
|
1432
|
-
/**
|
|
1433
|
-
* Markdown paragraph.
|
|
1434
|
-
*/
|
|
1435
|
-
interface Paragraph extends Parent {
|
|
1436
|
-
/**
|
|
1437
|
-
* Node type of mdast paragraph.
|
|
1438
|
-
*/
|
|
1439
|
-
type: "paragraph";
|
|
1440
|
-
/**
|
|
1441
|
-
* Children of paragraph.
|
|
1442
|
-
*/
|
|
1443
|
-
children: PhrasingContent[];
|
|
1444
|
-
/**
|
|
1445
|
-
* Data associated with the mdast paragraph.
|
|
1446
|
-
*/
|
|
1447
|
-
data?: ParagraphData | undefined;
|
|
1448
|
-
}
|
|
1449
|
-
/**
|
|
1450
|
-
* Info associated with mdast paragraph nodes by the ecosystem.
|
|
1451
|
-
*/
|
|
1452
|
-
interface ParagraphData extends Data$1 {}
|
|
1453
|
-
/**
|
|
1454
|
-
* Document fragment or a whole document.
|
|
1455
|
-
*
|
|
1456
|
-
* Should be used as the root of a tree and must not be used as a child.
|
|
1457
|
-
*/
|
|
1458
|
-
interface Root extends Parent {
|
|
1459
|
-
/**
|
|
1460
|
-
* Node type of mdast root.
|
|
1461
|
-
*/
|
|
1462
|
-
type: "root";
|
|
1463
|
-
/**
|
|
1464
|
-
* Data associated with the mdast root.
|
|
1465
|
-
*/
|
|
1466
|
-
data?: RootData | undefined;
|
|
1467
|
-
}
|
|
1468
|
-
/**
|
|
1469
|
-
* Info associated with mdast root nodes by the ecosystem.
|
|
1470
|
-
*/
|
|
1471
|
-
interface RootData extends Data$1 {}
|
|
1472
|
-
/**
|
|
1473
|
-
* Markdown strong.
|
|
1474
|
-
*/
|
|
1475
|
-
interface Strong extends Parent {
|
|
1476
|
-
/**
|
|
1477
|
-
* Node type of mdast strong.
|
|
1478
|
-
*/
|
|
1479
|
-
type: "strong";
|
|
1480
|
-
/**
|
|
1481
|
-
* Children of strong.
|
|
1482
|
-
*/
|
|
1483
|
-
children: PhrasingContent[];
|
|
1484
|
-
/**
|
|
1485
|
-
* Data associated with the mdast strong.
|
|
1486
|
-
*/
|
|
1487
|
-
data?: StrongData | undefined;
|
|
1488
|
-
}
|
|
1489
|
-
/**
|
|
1490
|
-
* Info associated with mdast strong nodes by the ecosystem.
|
|
1491
|
-
*/
|
|
1492
|
-
interface StrongData extends Data$1 {}
|
|
1493
|
-
/**
|
|
1494
|
-
* Markdown GFM table.
|
|
1495
|
-
*/
|
|
1496
|
-
interface Table extends Parent {
|
|
1497
|
-
/**
|
|
1498
|
-
* Node type of mdast GFM table.
|
|
1499
|
-
*/
|
|
1500
|
-
type: "table";
|
|
1501
|
-
/**
|
|
1502
|
-
* How cells in columns are aligned.
|
|
1503
|
-
*/
|
|
1504
|
-
align?: AlignType[] | null | undefined;
|
|
1505
|
-
/**
|
|
1506
|
-
* Children of GFM table.
|
|
1507
|
-
*/
|
|
1508
|
-
children: TableContent[];
|
|
1509
|
-
/**
|
|
1510
|
-
* Data associated with the mdast GFM table.
|
|
1511
|
-
*/
|
|
1512
|
-
data?: TableData | undefined;
|
|
1513
|
-
}
|
|
1514
|
-
/**
|
|
1515
|
-
* Info associated with mdast GFM table nodes by the ecosystem.
|
|
1516
|
-
*/
|
|
1517
|
-
interface TableData extends Data$1 {}
|
|
1518
|
-
/**
|
|
1519
|
-
* Markdown GFM table row.
|
|
1520
|
-
*/
|
|
1521
|
-
interface TableRow extends Parent {
|
|
1522
|
-
/**
|
|
1523
|
-
* Node type of mdast GFM table row.
|
|
1524
|
-
*/
|
|
1525
|
-
type: "tableRow";
|
|
1526
|
-
/**
|
|
1527
|
-
* Children of GFM table row.
|
|
1528
|
-
*/
|
|
1529
|
-
children: RowContent[];
|
|
1530
|
-
/**
|
|
1531
|
-
* Data associated with the mdast GFM table row.
|
|
1532
|
-
*/
|
|
1533
|
-
data?: TableRowData | undefined;
|
|
1534
|
-
}
|
|
1535
|
-
/**
|
|
1536
|
-
* Info associated with mdast GFM table row nodes by the ecosystem.
|
|
1537
|
-
*/
|
|
1538
|
-
interface TableRowData extends Data$1 {}
|
|
1539
|
-
/**
|
|
1540
|
-
* Markdown GFM table cell.
|
|
1541
|
-
*/
|
|
1542
|
-
interface TableCell extends Parent {
|
|
1543
|
-
/**
|
|
1544
|
-
* Node type of mdast GFM table cell.
|
|
1545
|
-
*/
|
|
1546
|
-
type: "tableCell";
|
|
1547
|
-
/**
|
|
1548
|
-
* Children of GFM table cell.
|
|
1549
|
-
*/
|
|
1550
|
-
children: PhrasingContent[];
|
|
1551
|
-
/**
|
|
1552
|
-
* Data associated with the mdast GFM table cell.
|
|
1553
|
-
*/
|
|
1554
|
-
data?: TableCellData | undefined;
|
|
1555
|
-
}
|
|
1556
|
-
/**
|
|
1557
|
-
* Info associated with mdast GFM table cell nodes by the ecosystem.
|
|
1558
|
-
*/
|
|
1559
|
-
interface TableCellData extends Data$1 {}
|
|
1560
|
-
/**
|
|
1561
|
-
* Markdown text.
|
|
1562
|
-
*/
|
|
1563
|
-
interface Text extends Literal {
|
|
1564
|
-
/**
|
|
1565
|
-
* Node type of mdast text.
|
|
1566
|
-
*/
|
|
1567
|
-
type: "text";
|
|
1568
|
-
/**
|
|
1569
|
-
* Data associated with the mdast text.
|
|
1570
|
-
*/
|
|
1571
|
-
data?: TextData | undefined;
|
|
1572
|
-
}
|
|
1573
|
-
/**
|
|
1574
|
-
* Info associated with mdast text nodes by the ecosystem.
|
|
1575
|
-
*/
|
|
1576
|
-
interface TextData extends Data$1 {}
|
|
1577
|
-
/**
|
|
1578
|
-
* Markdown thematic break (horizontal rule).
|
|
1579
|
-
*/
|
|
1580
|
-
interface ThematicBreak extends Node {
|
|
1581
|
-
/**
|
|
1582
|
-
* Node type of mdast thematic break.
|
|
1583
|
-
*/
|
|
1584
|
-
type: "thematicBreak";
|
|
1585
|
-
/**
|
|
1586
|
-
* Data associated with the mdast thematic break.
|
|
1587
|
-
*/
|
|
1588
|
-
data?: ThematicBreakData | undefined;
|
|
1589
|
-
}
|
|
1590
|
-
/**
|
|
1591
|
-
* Info associated with mdast thematic break nodes by the ecosystem.
|
|
1592
|
-
*/
|
|
1593
|
-
interface ThematicBreakData extends Data$1 {}
|
|
1594
|
-
/**
|
|
1595
|
-
* Markdown YAML.
|
|
1596
|
-
*/
|
|
1597
|
-
interface Yaml$1 extends Literal {
|
|
1598
|
-
/**
|
|
1599
|
-
* Node type of mdast YAML.
|
|
1600
|
-
*/
|
|
1601
|
-
type: "yaml";
|
|
1602
|
-
/**
|
|
1603
|
-
* Data associated with the mdast YAML.
|
|
1604
|
-
*/
|
|
1605
|
-
data?: YamlData | undefined;
|
|
1606
|
-
}
|
|
1607
|
-
/**
|
|
1608
|
-
* Info associated with mdast YAML nodes by the ecosystem.
|
|
1609
|
-
*/
|
|
1610
|
-
interface YamlData extends Data$1 {}
|
|
1611
|
-
//#endregion
|
|
1612
|
-
//#region src/changesets/schemas/dependency-table.d.ts
|
|
1613
569
|
/**
|
|
1614
570
|
* Valid dependency table actions.
|
|
1615
571
|
*
|
|
@@ -1824,8 +780,6 @@ declare const DependencyTableSchema: Schema.$Array<Schema.Struct<{
|
|
|
1824
780
|
/** New version (em dash for removed). */
|
|
1825
781
|
readonly to: Schema.String;
|
|
1826
782
|
}>>;
|
|
1827
|
-
//#endregion
|
|
1828
|
-
//#region src/changesets/api/dependency-table.d.ts
|
|
1829
783
|
/**
|
|
1830
784
|
* Static class for dependency table manipulation.
|
|
1831
785
|
*
|
|
@@ -1837,10 +791,10 @@ declare const DependencyTableSchema: Schema.$Array<Schema.Struct<{
|
|
|
1837
791
|
* @remarks
|
|
1838
792
|
* The typical workflow for processing dependency tables is:
|
|
1839
793
|
*
|
|
1840
|
-
* 1. **Parse** an
|
|
794
|
+
* 1. **Parse** an `@effected/markdown` `Table` node into typed {@link DependencyTableRow} objects
|
|
1841
795
|
* 2. **Collapse** duplicate rows (same package updated multiple times) into single entries
|
|
1842
796
|
* 3. **Sort** rows by dependency type, then alphabetically by package name
|
|
1843
|
-
* 4. **Serialize** back to an
|
|
797
|
+
* 4. **Serialize** back to an `@effected/markdown` `Table` node or directly to a markdown string
|
|
1844
798
|
*
|
|
1845
799
|
* The {@link DependencyTable.aggregate} method combines the collapse and sort
|
|
1846
800
|
* steps into a single call, which is the most common usage pattern.
|
|
@@ -1853,9 +807,9 @@ declare const DependencyTableSchema: Schema.$Array<Schema.Struct<{
|
|
|
1853
807
|
* ```typescript
|
|
1854
808
|
* import { DependencyTable } from "\@savvy-web/changesets";
|
|
1855
809
|
* import type { DependencyTableRow } from "\@savvy-web/changesets";
|
|
1856
|
-
* import type { Table } from "
|
|
810
|
+
* import type { Table } from "\@effected/markdown";
|
|
1857
811
|
*
|
|
1858
|
-
* // Given an
|
|
812
|
+
* // Given an \@effected/markdown Table node from a parsed CHANGELOG
|
|
1859
813
|
* declare const tableNode: Table;
|
|
1860
814
|
*
|
|
1861
815
|
* // Parse into typed rows
|
|
@@ -1864,7 +818,7 @@ declare const DependencyTableSchema: Schema.$Array<Schema.Struct<{
|
|
|
1864
818
|
* // Collapse duplicates and sort by type, then name
|
|
1865
819
|
* const aggregated: DependencyTableRow[] = DependencyTable.aggregate(rows);
|
|
1866
820
|
*
|
|
1867
|
-
* // Serialize back to an
|
|
821
|
+
* // Serialize back to an \@effected/markdown Table node for further AST manipulation
|
|
1868
822
|
* const outputNode: Table = DependencyTable.serialize(aggregated);
|
|
1869
823
|
*
|
|
1870
824
|
* // Or serialize directly to a markdown string
|
|
@@ -1894,7 +848,7 @@ declare const DependencyTableSchema: Schema.$Array<Schema.Struct<{
|
|
|
1894
848
|
declare class DependencyTable {
|
|
1895
849
|
private constructor();
|
|
1896
850
|
/**
|
|
1897
|
-
* Parse an
|
|
851
|
+
* Parse an `@effected/markdown` `Table` node into typed dependency table rows.
|
|
1898
852
|
*
|
|
1899
853
|
* @remarks
|
|
1900
854
|
* Extracts the text content from each table cell and maps it to the
|
|
@@ -1902,21 +856,21 @@ declare class DependencyTable {
|
|
|
1902
856
|
* treated as the header and skipped. Rows that do not have the expected
|
|
1903
857
|
* number of columns are ignored.
|
|
1904
858
|
*
|
|
1905
|
-
* @param tableNode - An
|
|
859
|
+
* @param tableNode - An `@effected/markdown` `Table` node from a parsed markdown tree
|
|
1906
860
|
* @returns Array of {@link DependencyTableRow} objects, one per data row
|
|
1907
861
|
*/
|
|
1908
862
|
static parse(tableNode: Table): DependencyTableRow[];
|
|
1909
863
|
/**
|
|
1910
|
-
* Serialize typed dependency table rows into an
|
|
864
|
+
* Serialize typed dependency table rows into an `@effected/markdown` `Table` node.
|
|
1911
865
|
*
|
|
1912
866
|
* @remarks
|
|
1913
|
-
* Produces a well-formed
|
|
867
|
+
* Produces a well-formed `@effected/markdown` `Table` with a header row
|
|
1914
868
|
* (`Dependency | Type | Action | From | To`) followed by one data row
|
|
1915
|
-
* per input entry. The resulting node can be inserted into a
|
|
869
|
+
* per input entry. The resulting node can be inserted into a kit tree
|
|
1916
870
|
* for further processing or stringification.
|
|
1917
871
|
*
|
|
1918
872
|
* @param rows - Array of {@link DependencyTableRow} objects to serialize
|
|
1919
|
-
* @returns An
|
|
873
|
+
* @returns An `@effected/markdown` `Table` node ready for tree insertion
|
|
1920
874
|
*/
|
|
1921
875
|
static serialize(rows: DependencyTableRow[]): Table;
|
|
1922
876
|
/**
|
|
@@ -1924,7 +878,7 @@ declare class DependencyTable {
|
|
|
1924
878
|
*
|
|
1925
879
|
* @remarks
|
|
1926
880
|
* Convenience method that combines {@link DependencyTable.serialize} with
|
|
1927
|
-
*
|
|
881
|
+
* the canonical `@effected/markdown` emitter. Produces a GFM-compatible markdown table string.
|
|
1928
882
|
*
|
|
1929
883
|
* @param rows - Array of {@link DependencyTableRow} objects to render
|
|
1930
884
|
* @returns A markdown string containing the formatted table
|
|
@@ -1970,12 +924,10 @@ declare class DependencyTable {
|
|
|
1970
924
|
*/
|
|
1971
925
|
static aggregate(rows: DependencyTableRow[]): DependencyTableRow[];
|
|
1972
926
|
}
|
|
1973
|
-
//#endregion
|
|
1974
|
-
//#region src/changesets/api/linter.d.ts
|
|
1975
927
|
/**
|
|
1976
928
|
* Class-based API wrapper for changeset linting.
|
|
1977
929
|
*
|
|
1978
|
-
* Provides a static class interface that runs all five
|
|
930
|
+
* Provides a static class interface that runs all five kit-node lint rules
|
|
1979
931
|
* against changeset markdown files and returns structured diagnostics.
|
|
1980
932
|
*
|
|
1981
933
|
* @internal
|
|
@@ -1984,7 +936,7 @@ declare class DependencyTable {
|
|
|
1984
936
|
* A single lint diagnostic message produced by changeset validation.
|
|
1985
937
|
*
|
|
1986
938
|
* @remarks
|
|
1987
|
-
* Each `LintMessage` corresponds to one
|
|
939
|
+
* Each `LintMessage` corresponds to one lint rule violation found
|
|
1988
940
|
* during changeset validation. Messages include source location information
|
|
1989
941
|
* (file, line, column) for integration with editors, CI reporters, and
|
|
1990
942
|
* the Effect CLI's `lint` and `check` commands.
|
|
@@ -2010,13 +962,13 @@ interface LintMessage {
|
|
|
2010
962
|
*/
|
|
2011
963
|
file: string;
|
|
2012
964
|
/**
|
|
2013
|
-
* Identifier of the
|
|
965
|
+
* Identifier of the lint rule that produced this message.
|
|
2014
966
|
*
|
|
2015
967
|
* @remarks
|
|
2016
|
-
* Corresponds to one of the five built-in rules:
|
|
2017
|
-
* `"
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
968
|
+
* Corresponds to one of the five built-in rules:
|
|
969
|
+
* `"changeset-heading-hierarchy"`, `"changeset-required-sections"`,
|
|
970
|
+
* `"changeset-content-structure"`, `"changeset-dependency-table-format"`,
|
|
971
|
+
* or `"changeset-uncategorized-content"`.
|
|
2020
972
|
*/
|
|
2021
973
|
rule: string;
|
|
2022
974
|
/**
|
|
@@ -2024,16 +976,14 @@ interface LintMessage {
|
|
|
2024
976
|
*
|
|
2025
977
|
* @remarks
|
|
2026
978
|
* Line numbers are relative to the content after YAML frontmatter
|
|
2027
|
-
* stripping
|
|
2028
|
-
* position information.
|
|
979
|
+
* stripping (the blank line after the closing `---` counts as line 1).
|
|
2029
980
|
*/
|
|
2030
981
|
line: number;
|
|
2031
982
|
/**
|
|
2032
983
|
* Column number where the issue was detected (1-based).
|
|
2033
984
|
*
|
|
2034
985
|
* @remarks
|
|
2035
|
-
*
|
|
2036
|
-
* information.
|
|
986
|
+
* Taken from the start position of the offending node.
|
|
2037
987
|
*/
|
|
2038
988
|
column: number;
|
|
2039
989
|
/**
|
|
@@ -2049,7 +999,7 @@ interface LintMessage {
|
|
|
2049
999
|
/**
|
|
2050
1000
|
* Static class for linting changeset markdown files.
|
|
2051
1001
|
*
|
|
2052
|
-
* Runs the five
|
|
1002
|
+
* Runs the five `@effected/markdown` kit-node lint rules (heading-hierarchy, required-sections,
|
|
2053
1003
|
* content-structure, dependency-table-format, uncategorized-content) against
|
|
2054
1004
|
* changeset markdown and returns structured {@link LintMessage} diagnostics.
|
|
2055
1005
|
*
|
|
@@ -2175,8 +1125,6 @@ declare class ChangesetLinter {
|
|
|
2175
1125
|
*/
|
|
2176
1126
|
static validate(dir: string): LintMessage[];
|
|
2177
1127
|
}
|
|
2178
|
-
//#endregion
|
|
2179
|
-
//#region src/changesets/services/maintenance-reason.d.ts
|
|
2180
1128
|
/**
|
|
2181
1129
|
* A group co-member whose own changesets forced this release.
|
|
2182
1130
|
*
|
|
@@ -2239,10 +1187,8 @@ type MaintenanceReason = typeof MaintenanceReasonSchema.Type;
|
|
|
2239
1187
|
* @public
|
|
2240
1188
|
*/
|
|
2241
1189
|
declare function deriveMaintenanceReason(release: ComprehensiveRelease, plan: ReleasePlan, config: Config): MaintenanceReason | undefined;
|
|
2242
|
-
//#endregion
|
|
2243
|
-
//#region src/changesets/remark/plugins/maintenance-note.d.ts
|
|
2244
1190
|
/**
|
|
2245
|
-
* Options for
|
|
1191
|
+
* Options for `maintenanceNote`.
|
|
2246
1192
|
*
|
|
2247
1193
|
* @public
|
|
2248
1194
|
*/
|
|
@@ -2252,9 +1198,6 @@ interface MaintenanceNoteOptions {
|
|
|
2252
1198
|
/** Why the package released with no changesets of its own. */
|
|
2253
1199
|
readonly reason: MaintenanceReason;
|
|
2254
1200
|
}
|
|
2255
|
-
declare const MaintenanceNotePlugin: Plugin<[MaintenanceNoteOptions], Root>;
|
|
2256
|
-
//#endregion
|
|
2257
|
-
//#region src/changesets/api/transformer.d.ts
|
|
2258
1201
|
/**
|
|
2259
1202
|
* Optional per-file behavior for {@link ChangelogTransformer}.
|
|
2260
1203
|
*
|
|
@@ -2274,15 +1217,15 @@ interface TransformOptions {
|
|
|
2274
1217
|
/**
|
|
2275
1218
|
* Static class for post-processing CHANGELOG.md files.
|
|
2276
1219
|
*
|
|
2277
|
-
* Implements the third layer of the three-layer pipeline by running
|
|
2278
|
-
*
|
|
2279
|
-
*
|
|
2280
|
-
*
|
|
1220
|
+
* Implements the third layer of the three-layer pipeline by running seven
|
|
1221
|
+
* `@effected/markdown` kit-node transforms in a fixed order to clean up,
|
|
1222
|
+
* normalize, and enhance changelog output produced by the formatter layer:
|
|
1223
|
+
* aggregate dependency tables, merge duplicate sections, reorder sections by
|
|
1224
|
+
* category priority, deduplicate list items, aggregate contributor thanks,
|
|
1225
|
+
* convert issue references to reference links, and normalize formatting. An
|
|
1226
|
+
* optional maintenance-note transform runs last.
|
|
2281
1227
|
*
|
|
2282
1228
|
* @remarks
|
|
2283
|
-
* See {@link SilkChangesetTransformPreset} for the ordered plugin list and
|
|
2284
|
-
* the rationale behind each plugin's position.
|
|
2285
|
-
*
|
|
2286
1229
|
* The transformer operates on the full CHANGELOG.md content (all versions),
|
|
2287
1230
|
* not just the latest release block. It is idempotent -- running it multiple
|
|
2288
1231
|
* times produces the same output.
|
|
@@ -2331,7 +1274,7 @@ interface TransformOptions {
|
|
|
2331
1274
|
* }
|
|
2332
1275
|
* ```
|
|
2333
1276
|
*
|
|
2334
|
-
* @see {@link Categories} for the priority order used
|
|
1277
|
+
* @see {@link Categories} for the priority order used when reordering sections
|
|
2335
1278
|
* @see {@link ChangesetLinter} for the pre-validation layer (layer 1)
|
|
2336
1279
|
* @see {@link Changelog} for the formatter layer (layer 2)
|
|
2337
1280
|
*
|
|
@@ -2340,15 +1283,14 @@ interface TransformOptions {
|
|
|
2340
1283
|
declare class ChangelogTransformer {
|
|
2341
1284
|
private constructor();
|
|
2342
1285
|
/**
|
|
2343
|
-
* Transform CHANGELOG markdown content by running the
|
|
2344
|
-
*
|
|
1286
|
+
* Transform CHANGELOG markdown content by running the kit-node
|
|
1287
|
+
* changelog transforms.
|
|
2345
1288
|
*
|
|
2346
1289
|
* @remarks
|
|
2347
|
-
* The input is parsed
|
|
2348
|
-
*
|
|
2349
|
-
*
|
|
2350
|
-
*
|
|
2351
|
-
* idempotent.
|
|
1290
|
+
* The input is parsed into `@effected/markdown` nodes (GFM dialect, author
|
|
1291
|
+
* spellings canonicalized), folded through every transform in order, and
|
|
1292
|
+
* emitted back to markdown through the canonical `@effected/markdown`
|
|
1293
|
+
* stringifier. The operation is synchronous and idempotent.
|
|
2352
1294
|
*
|
|
2353
1295
|
* @param content - Raw CHANGELOG markdown string (may contain multiple
|
|
2354
1296
|
* version blocks, GFM tables, footnotes, and reference links)
|
|
@@ -2361,7 +1303,7 @@ declare class ChangelogTransformer {
|
|
|
2361
1303
|
* Transform a CHANGELOG file in-place.
|
|
2362
1304
|
*
|
|
2363
1305
|
* @remarks
|
|
2364
|
-
* Reads the file synchronously, runs all
|
|
1306
|
+
* Reads the file synchronously, runs all transforms via
|
|
2365
1307
|
* {@link ChangelogTransformer.transformContent}, and writes the result
|
|
2366
1308
|
* back to the same path. The file is overwritten atomically (single
|
|
2367
1309
|
* `writeFileSync` call).
|
|
@@ -2374,8 +1316,6 @@ declare class ChangelogTransformer {
|
|
|
2374
1316
|
*/
|
|
2375
1317
|
static transformFile(filePath: string, options?: TransformOptions): void;
|
|
2376
1318
|
}
|
|
2377
|
-
//#endregion
|
|
2378
|
-
//#region src/changesets/changelog/index.d.ts
|
|
2379
1319
|
/**
|
|
2380
1320
|
* Options for {@link makeChangelogFunctions}.
|
|
2381
1321
|
*
|
|
@@ -2418,8 +1358,6 @@ declare function makeChangelogFunctions(options?: MakeChangelogFunctionsOptions)
|
|
|
2418
1358
|
* @internal
|
|
2419
1359
|
*/
|
|
2420
1360
|
declare const changelogFunctions: ChangelogFunctions;
|
|
2421
|
-
//#endregion
|
|
2422
|
-
//#region src/changesets/changelog/vanilla.d.ts
|
|
2423
1361
|
/**
|
|
2424
1362
|
* The stock `\@changesets/changelog-git` changelog implementation.
|
|
2425
1363
|
*
|
|
@@ -2445,8 +1383,6 @@ declare const changelogFunctions: ChangelogFunctions;
|
|
|
2445
1383
|
* @public
|
|
2446
1384
|
*/
|
|
2447
1385
|
declare const vanillaChangelogFunctions: ChangelogFunctions;
|
|
2448
|
-
//#endregion
|
|
2449
|
-
//#region src/changesets/errors.d.ts
|
|
2450
1386
|
/**
|
|
2451
1387
|
* Tagged errors for \@savvy-web/changesets.
|
|
2452
1388
|
*
|
|
@@ -2595,7 +1531,7 @@ declare const MarkdownParseErrorBase: new <A extends Record<string, any> = {}>(a
|
|
|
2595
1531
|
* Markdown parsing failure.
|
|
2596
1532
|
*
|
|
2597
1533
|
* @remarks
|
|
2598
|
-
* Raised when a markdown file cannot be parsed into an AST by the
|
|
1534
|
+
* Raised when a markdown file cannot be parsed into an AST by the @effected/markdown
|
|
2599
1535
|
* pipeline. Carries optional source file location information (line, column)
|
|
2600
1536
|
* for diagnostic display.
|
|
2601
1537
|
*
|
|
@@ -2898,8 +1834,6 @@ declare class ReleasePlanError extends ReleasePlanErrorBase<{
|
|
|
2898
1834
|
}> {
|
|
2899
1835
|
get message(): string;
|
|
2900
1836
|
}
|
|
2901
|
-
//#endregion
|
|
2902
|
-
//#region src/services/ChangesetConfigReader.d.ts
|
|
2903
1837
|
/**
|
|
2904
1838
|
* The {@link ChangesetConfigReader} service shape.
|
|
2905
1839
|
*
|
|
@@ -2955,8 +1889,6 @@ export declare class ChangesetConfigReader extends ChangesetConfigReader_base {
|
|
|
2955
1889
|
*/
|
|
2956
1890
|
static readonly layer: Layer.Layer<ChangesetConfigReader, never, FileSystem.FileSystem>;
|
|
2957
1891
|
}
|
|
2958
|
-
//#endregion
|
|
2959
|
-
//#region src/changesets/services/config-inspector.d.ts
|
|
2960
1892
|
/** A `versionFiles` entry expanded to its absolute target paths. @public */
|
|
2961
1893
|
declare const ResolvedVersionFileSchema: Schema.Struct<{
|
|
2962
1894
|
readonly glob: Schema.String;
|
|
@@ -3141,8 +2073,6 @@ declare class ConfigInspector extends ConfigInspector_base {
|
|
|
3141
2073
|
* @public
|
|
3142
2074
|
*/
|
|
3143
2075
|
declare function makeConfigInspectorTest(fixed: InspectedConfig): Layer.Layer<ConfigInspector>;
|
|
3144
|
-
//#endregion
|
|
3145
|
-
//#region src/changesets/services/branch-analyzer.d.ts
|
|
3146
2076
|
/** Git diff status as reported by `--name-status`. @public */
|
|
3147
2077
|
declare const FileStatusSchema: Schema.Literals<readonly ["added", "modified", "deleted", "renamed", "copied", "typechange", "unmerged", "unknown"]>;
|
|
3148
2078
|
/** Git diff status as reported by `--name-status`. @public */
|
|
@@ -3254,8 +2184,6 @@ declare class BranchAnalyzer extends BranchAnalyzer_base {
|
|
|
3254
2184
|
* @public
|
|
3255
2185
|
*/
|
|
3256
2186
|
declare function makeBranchAnalyzerTest(fixed: BranchAnalysis): Layer.Layer<BranchAnalyzer>;
|
|
3257
|
-
//#endregion
|
|
3258
|
-
//#region src/changesets/schemas/options.d.ts
|
|
3259
2187
|
/**
|
|
3260
2188
|
* Schema for a GitHub repository in `owner/repo` format.
|
|
3261
2189
|
*
|
|
@@ -3379,8 +2307,6 @@ declare const ChangesetOptionsSchema: Schema.Struct<{
|
|
|
3379
2307
|
* @public
|
|
3380
2308
|
*/
|
|
3381
2309
|
interface ChangesetOptions extends Schema.Schema.Type<typeof ChangesetOptionsSchema> {}
|
|
3382
|
-
//#endregion
|
|
3383
|
-
//#region src/changesets/vendor/github-info.d.ts
|
|
3384
2310
|
/**
|
|
3385
2311
|
* Structured result from the GitHub commit info API.
|
|
3386
2312
|
*
|
|
@@ -3422,8 +2348,6 @@ interface GitHubCommitInfo {
|
|
|
3422
2348
|
user: string | null;
|
|
3423
2349
|
};
|
|
3424
2350
|
}
|
|
3425
|
-
//#endregion
|
|
3426
|
-
//#region src/changesets/services/github.d.ts
|
|
3427
2351
|
/**
|
|
3428
2352
|
* Service interface for GitHub API operations.
|
|
3429
2353
|
*
|
|
@@ -3580,8 +2504,6 @@ declare class GitHubService extends GitHubService_base {
|
|
|
3580
2504
|
* @public
|
|
3581
2505
|
*/
|
|
3582
2506
|
declare function makeGitHubTest(responses: Map<string, GitHubCommitInfo>): Layer.Layer<GitHubService>;
|
|
3583
|
-
//#endregion
|
|
3584
|
-
//#region src/changesets/services/changelog.d.ts
|
|
3585
2507
|
/**
|
|
3586
2508
|
* Service interface for changelog formatting.
|
|
3587
2509
|
*
|
|
@@ -3650,8 +2572,6 @@ declare const ChangelogService_base: Context.ServiceClass<ChangelogService, "Cha
|
|
|
3650
2572
|
* @public
|
|
3651
2573
|
*/
|
|
3652
2574
|
declare class ChangelogService extends ChangelogService_base {}
|
|
3653
|
-
//#endregion
|
|
3654
|
-
//#region src/services/ChangesetConfig.d.ts
|
|
3655
2575
|
/**
|
|
3656
2576
|
* Changeset operating mode for a workspace root.
|
|
3657
2577
|
* @public
|
|
@@ -3710,8 +2630,6 @@ export declare class ChangesetConfig extends ChangesetConfig_base {
|
|
|
3710
2630
|
*/
|
|
3711
2631
|
static readonly layer: Layer.Layer<ChangesetConfig, never, ChangesetConfigReader>;
|
|
3712
2632
|
}
|
|
3713
|
-
//#endregion
|
|
3714
|
-
//#region src/changesets/schemas/deps-regen.d.ts
|
|
3715
2633
|
/**
|
|
3716
2634
|
* One dependency-diff row emitted by the deps-regen planner.
|
|
3717
2635
|
*
|
|
@@ -3814,8 +2732,6 @@ declare const RegenResultSchema: Schema.Struct<{
|
|
|
3814
2732
|
* @public
|
|
3815
2733
|
*/
|
|
3816
2734
|
type RegenResult = Schema.Schema.Type<typeof RegenResultSchema>;
|
|
3817
|
-
//#endregion
|
|
3818
|
-
//#region src/changesets/services/deps-regen.d.ts
|
|
3819
2735
|
/**
|
|
3820
2736
|
* Strict detection of "pure dependency changesets" per the documented
|
|
3821
2737
|
* rules: single-package frontmatter, single `## Dependencies` heading,
|
|
@@ -4051,8 +2967,6 @@ declare function makeDepsRegenDefault(options?: WorkspacesOptions): Layer.Layer<
|
|
|
4051
2967
|
* @public
|
|
4052
2968
|
*/
|
|
4053
2969
|
declare const DepsRegenDefault: Layer.Layer<DepsRegen, never, FileSystem.FileSystem | Path.Path | ChildProcessSpawner.ChildProcessSpawner>;
|
|
4054
|
-
//#endregion
|
|
4055
|
-
//#region src/changesets/schemas/release-plan.d.ts
|
|
4056
2970
|
/** A semantic-version bump level (the `"none"` plan type is filtered out upstream). @public */
|
|
4057
2971
|
declare const BumpTypeSchema: Schema.Literals<readonly ["major", "minor", "patch"]>;
|
|
4058
2972
|
/** A semantic-version bump level. @public */
|
|
@@ -4134,8 +3048,6 @@ declare const AppliedReleaseSchema: Schema.Struct<{
|
|
|
4134
3048
|
}>;
|
|
4135
3049
|
/** Result of a native apply. @public */
|
|
4136
3050
|
type AppliedRelease = Schema.Schema.Type<typeof AppliedReleaseSchema>;
|
|
4137
|
-
//#endregion
|
|
4138
|
-
//#region src/changesets/services/release-planner.d.ts
|
|
4139
3051
|
/**
|
|
4140
3052
|
* Per-call `changeset version --snapshot` parity options, forwarded to
|
|
4141
3053
|
* `@changesets/assemble-release-plan`. Mirrors the CLI's `--snapshot [tag]`
|
|
@@ -4265,8 +3177,6 @@ declare function makeReleasePlannerTest(fixed: {
|
|
|
4265
3177
|
readonly preview?: ChangesetPreview;
|
|
4266
3178
|
readonly apply?: AppliedRelease;
|
|
4267
3179
|
}): Layer.Layer<ReleasePlanner>;
|
|
4268
|
-
//#endregion
|
|
4269
|
-
//#region src/changesets/schemas/changeset.d.ts
|
|
4270
3180
|
/**
|
|
4271
3181
|
* Schema for a changeset summary (1--1000 characters).
|
|
4272
3182
|
*
|
|
@@ -4421,8 +3331,6 @@ declare const DependencyUpdateSchema: Schema.Struct<{
|
|
|
4421
3331
|
* @public
|
|
4422
3332
|
*/
|
|
4423
3333
|
interface DependencyUpdate extends Schema.Schema.Type<typeof DependencyUpdateSchema> {}
|
|
4424
|
-
//#endregion
|
|
4425
|
-
//#region src/changesets/schemas/git.d.ts
|
|
4426
3334
|
/**
|
|
4427
3335
|
* Schema for a git commit hash (at least 7 lowercase hex characters).
|
|
4428
3336
|
*
|
|
@@ -4488,8 +3396,6 @@ declare const VersionTypeSchema: Schema.Literals<readonly ["major", "minor", "pa
|
|
|
4488
3396
|
* @public
|
|
4489
3397
|
*/
|
|
4490
3398
|
type VersionType = typeof VersionTypeSchema.Type;
|
|
4491
|
-
//#endregion
|
|
4492
|
-
//#region src/changesets/schemas/github.d.ts
|
|
4493
3399
|
/**
|
|
4494
3400
|
* Schema for a GitHub username.
|
|
4495
3401
|
*
|
|
@@ -4636,8 +3542,6 @@ declare const GitHubInfoSchema: Schema.Struct<{
|
|
|
4636
3542
|
* @public
|
|
4637
3543
|
*/
|
|
4638
3544
|
interface GitHubInfo extends Schema.Schema.Type<typeof GitHubInfoSchema> {}
|
|
4639
|
-
//#endregion
|
|
4640
|
-
//#region src/changesets/schemas/package-scope.d.ts
|
|
4641
3545
|
/**
|
|
4642
3546
|
* Schema for a single repo-relative glob pattern.
|
|
4643
3547
|
*
|
|
@@ -4733,8 +3637,6 @@ declare const PackagesRecordSchema: Schema.$Record<Schema.String, Schema.Struct<
|
|
|
4733
3637
|
readonly paths: Schema.optional<Schema.$Array<Schema.String>>;
|
|
4734
3638
|
}>>>;
|
|
4735
3639
|
}>>;
|
|
4736
|
-
//#endregion
|
|
4737
|
-
//#region src/changesets/schemas/primitives.d.ts
|
|
4738
3640
|
/**
|
|
4739
3641
|
* A non-empty string schema.
|
|
4740
3642
|
*
|
|
@@ -4788,8 +3690,6 @@ declare const NonEmptyString: Schema.String;
|
|
|
4788
3690
|
* @public
|
|
4789
3691
|
*/
|
|
4790
3692
|
declare const PositiveInteger: Schema.Number;
|
|
4791
|
-
//#endregion
|
|
4792
|
-
//#region src/changesets/schemas/version-files.d.ts
|
|
4793
3693
|
/**
|
|
4794
3694
|
* Schema for a JSONPath expression starting with `$.`.
|
|
4795
3695
|
*
|
|
@@ -4933,8 +3833,6 @@ declare const LegacyVersionFilesSchema: Schema.$Array<Schema.Struct<{
|
|
|
4933
3833
|
/** Workspace package name to source the version from, bypassing path-based resolution. */
|
|
4934
3834
|
readonly package: Schema.optional<Schema.String>;
|
|
4935
3835
|
}>>;
|
|
4936
|
-
//#endregion
|
|
4937
|
-
//#region src/changesets/utils/dep-diff.d.ts
|
|
4938
3836
|
/**
|
|
4939
3837
|
* A workspace package's worth of dependency-table rows.
|
|
4940
3838
|
*
|
|
@@ -4962,8 +3860,6 @@ interface WorkspaceDependencyDiff {
|
|
|
4962
3860
|
* @public
|
|
4963
3861
|
*/
|
|
4964
3862
|
declare function computeWorkspaceDependencyDiffs(before: WorkspaceStateSnapshot, after: WorkspaceStateSnapshot): ReadonlyArray<WorkspaceDependencyDiff>;
|
|
4965
|
-
//#endregion
|
|
4966
|
-
//#region src/changesets/utils/dependency-table.d.ts
|
|
4967
3863
|
/**
|
|
4968
3864
|
* Serialize dependency table rows to a markdown table string.
|
|
4969
3865
|
*
|
|
@@ -4990,8 +3886,6 @@ declare function computeWorkspaceDependencyDiffs(before: WorkspaceStateSnapshot,
|
|
|
4990
3886
|
* @internal
|
|
4991
3887
|
*/
|
|
4992
3888
|
declare function serializeDependencyTableToMarkdown(rows: DependencyTableRow[]): string;
|
|
4993
|
-
//#endregion
|
|
4994
|
-
//#region src/changesets/utils/git.d.ts
|
|
4995
3889
|
/**
|
|
4996
3890
|
* Run `git merge-base <base> HEAD`, returning the SHA. Errors propagate
|
|
4997
3891
|
* as {@link GitError}.
|
|
@@ -4999,8 +3893,6 @@ declare function serializeDependencyTableToMarkdown(rows: DependencyTableRow[]):
|
|
|
4999
3893
|
* @internal
|
|
5000
3894
|
*/
|
|
5001
3895
|
declare function gitMergeBase(cwd: string, base: string): Effect.Effect<string, GitError, Git>;
|
|
5002
|
-
//#endregion
|
|
5003
|
-
//#region src/changesets/utils/publishability.d.ts
|
|
5004
3896
|
/**
|
|
5005
3897
|
* Compute the set of currently-publishable workspace package names.
|
|
5006
3898
|
*
|
|
@@ -5024,8 +3916,6 @@ declare function gitMergeBase(cwd: string, base: string): Effect.Effect<string,
|
|
|
5024
3916
|
* @public
|
|
5025
3917
|
*/
|
|
5026
3918
|
declare function listPublishablePackageNames(packages: ReadonlyArray<WorkspacePackage>, _root: string): Effect.Effect<ReadonlySet<string>, never, PublishabilityDetector>;
|
|
5027
|
-
//#endregion
|
|
5028
|
-
//#region src/changesets/utils/version-files.d.ts
|
|
5029
3919
|
/**
|
|
5030
3920
|
* Result of a single version file update.
|
|
5031
3921
|
*
|
|
@@ -5305,8 +4195,6 @@ declare class VersionFiles {
|
|
|
5305
4195
|
/** Render a `PlatformError` the way the old `node:fs` catch rendered an `Error`. */
|
|
5306
4196
|
private static describeFailure;
|
|
5307
4197
|
}
|
|
5308
|
-
//#endregion
|
|
5309
|
-
//#region ../../node_modules/.pnpm/micromark-util-types@2.0.2/node_modules/micromark-util-types/index.d.ts
|
|
5310
4198
|
/**
|
|
5311
4199
|
* Enum of allowed token types.
|
|
5312
4200
|
*/
|
|
@@ -5424,8 +4312,6 @@ interface TokenTypeMap {
|
|
|
5424
4312
|
chunkText: 'chunkText';
|
|
5425
4313
|
chunkString: 'chunkString';
|
|
5426
4314
|
}
|
|
5427
|
-
//#endregion
|
|
5428
|
-
//#region ../../node_modules/.pnpm/markdownlint@0.41.1_supports-color@8.1.1/node_modules/markdownlint/lib/markdownlint.d.mts
|
|
5429
4315
|
/**
|
|
5430
4316
|
* Function to implement rule logic.
|
|
5431
4317
|
*/
|
|
@@ -5697,11 +4583,7 @@ type Rule$2 = {
|
|
|
5697
4583
|
* Rule configuration.
|
|
5698
4584
|
*/
|
|
5699
4585
|
type RuleConfiguration = boolean | any;
|
|
5700
|
-
//#endregion
|
|
5701
|
-
//#region ../../node_modules/.pnpm/markdownlint@0.41.1_supports-color@8.1.1/node_modules/markdownlint/lib/exports.d.mts
|
|
5702
4586
|
type Rule$1 = Rule$2;
|
|
5703
|
-
//#endregion
|
|
5704
|
-
//#region src/changesets/markdownlint/rules/content-structure.d.ts
|
|
5705
4587
|
/**
|
|
5706
4588
|
* markdownlint rule: `changeset-content-structure` (CSH003).
|
|
5707
4589
|
*
|
|
@@ -5716,7 +4598,7 @@ type Rule$1 = Rule$2;
|
|
|
5716
4598
|
* `content` token before the next prefix or end of list.
|
|
5717
4599
|
*
|
|
5718
4600
|
* @remarks
|
|
5719
|
-
* This rule mirrors the
|
|
4601
|
+
* This rule mirrors the kit rule `contentStructure` in `src/changesets/rules/content-structure.ts` but uses
|
|
5720
4602
|
* markdownlint's micromark token API so it can run inside markdownlint-cli2 and
|
|
5721
4603
|
* the VS Code markdownlint extension.
|
|
5722
4604
|
*
|
|
@@ -5728,21 +4610,17 @@ type Rule$1 = Rule$2;
|
|
|
5728
4610
|
* ```
|
|
5729
4611
|
*
|
|
5730
4612
|
* @see {@link https://github.com/savvy-web/systems/blob/main/packages/silk-effects/docs/rules/CSH003.md | CSH003 rule documentation}
|
|
5731
|
-
* @see `src/
|
|
4613
|
+
* @see `src/changesets/rules/content-structure.ts` for the corresponding kit-node rule
|
|
5732
4614
|
*
|
|
5733
4615
|
* @public
|
|
5734
4616
|
*/
|
|
5735
|
-
declare const ContentStructureRule
|
|
5736
|
-
//#endregion
|
|
5737
|
-
//#region src/changesets/markdownlint/rules/dependency-table-format.d.ts
|
|
4617
|
+
declare const ContentStructureRule: Rule$1;
|
|
5738
4618
|
/**
|
|
5739
4619
|
* The markdownlint `Rule` object for CSH005 (`changeset-dependency-table-format`).
|
|
5740
4620
|
*
|
|
5741
4621
|
* @public
|
|
5742
4622
|
*/
|
|
5743
|
-
declare const DependencyTableFormatRule
|
|
5744
|
-
//#endregion
|
|
5745
|
-
//#region src/changesets/markdownlint/rules/heading-hierarchy.d.ts
|
|
4623
|
+
declare const DependencyTableFormatRule: Rule$1;
|
|
5746
4624
|
/**
|
|
5747
4625
|
* markdownlint rule: `changeset-heading-hierarchy` (CSH001).
|
|
5748
4626
|
*
|
|
@@ -5756,7 +4634,7 @@ declare const DependencyTableFormatRule$1: Rule$1;
|
|
|
5756
4634
|
* (h2 then h3, not h2 then h4).
|
|
5757
4635
|
*
|
|
5758
4636
|
* @remarks
|
|
5759
|
-
* This rule mirrors the
|
|
4637
|
+
* This rule mirrors the kit rule `headingHierarchy` in `src/changesets/rules/heading-hierarchy.ts` but uses
|
|
5760
4638
|
* markdownlint's micromark token API so it can run inside markdownlint-cli2 and
|
|
5761
4639
|
* the VS Code markdownlint extension.
|
|
5762
4640
|
*
|
|
@@ -5768,13 +4646,11 @@ declare const DependencyTableFormatRule$1: Rule$1;
|
|
|
5768
4646
|
* ```
|
|
5769
4647
|
*
|
|
5770
4648
|
* @see {@link https://github.com/savvy-web/systems/blob/main/packages/silk-effects/docs/rules/CSH001.md | CSH001 rule documentation}
|
|
5771
|
-
* @see `src/
|
|
4649
|
+
* @see `src/changesets/rules/heading-hierarchy.ts` for the corresponding kit-node rule
|
|
5772
4650
|
*
|
|
5773
4651
|
* @public
|
|
5774
4652
|
*/
|
|
5775
|
-
declare const HeadingHierarchyRule
|
|
5776
|
-
//#endregion
|
|
5777
|
-
//#region src/changesets/markdownlint/rules/required-sections.d.ts
|
|
4653
|
+
declare const HeadingHierarchyRule: Rule$1;
|
|
5778
4654
|
/**
|
|
5779
4655
|
* markdownlint rule: `changeset-required-sections` (CSH002).
|
|
5780
4656
|
*
|
|
@@ -5788,7 +4664,7 @@ declare const HeadingHierarchyRule$1: Rule$1;
|
|
|
5788
4664
|
* (`src/categories/index.ts`). This rule inspects `atxHeading` micromark
|
|
5789
4665
|
* tokens and extracts their text via the {@link getHeadingText} utility.
|
|
5790
4666
|
*
|
|
5791
|
-
* This rule mirrors the
|
|
4667
|
+
* This rule mirrors the kit rule `requiredSections` in `src/changesets/rules/required-sections.ts` but uses
|
|
5792
4668
|
* markdownlint's micromark token API so it can run inside markdownlint-cli2 and
|
|
5793
4669
|
* the VS Code markdownlint extension.
|
|
5794
4670
|
*
|
|
@@ -5800,13 +4676,11 @@ declare const HeadingHierarchyRule$1: Rule$1;
|
|
|
5800
4676
|
* ```
|
|
5801
4677
|
*
|
|
5802
4678
|
* @see {@link https://github.com/savvy-web/systems/blob/main/packages/silk-effects/docs/rules/CSH002.md | CSH002 rule documentation}
|
|
5803
|
-
* @see `src/
|
|
4679
|
+
* @see `src/changesets/rules/required-sections.ts` for the corresponding kit-node rule
|
|
5804
4680
|
*
|
|
5805
4681
|
* @public
|
|
5806
4682
|
*/
|
|
5807
|
-
declare const RequiredSectionsRule
|
|
5808
|
-
//#endregion
|
|
5809
|
-
//#region src/changesets/markdownlint/rules/uncategorized-content.d.ts
|
|
4683
|
+
declare const RequiredSectionsRule: Rule$1;
|
|
5810
4684
|
/**
|
|
5811
4685
|
* markdownlint rule: `changeset-uncategorized-content` (CSH004).
|
|
5812
4686
|
*
|
|
@@ -5821,7 +4695,7 @@ declare const RequiredSectionsRule$1: Rule$1;
|
|
|
5821
4695
|
* triggers an error. This ensures that changeset content is always grouped
|
|
5822
4696
|
* under a recognized category heading.
|
|
5823
4697
|
*
|
|
5824
|
-
* This rule mirrors the
|
|
4698
|
+
* This rule mirrors the kit rule `uncategorizedContent` in `src/changesets/rules/uncategorized-content.ts` but
|
|
5825
4699
|
* uses markdownlint's micromark token API so it can run inside
|
|
5826
4700
|
* markdownlint-cli2 and the VS Code markdownlint extension.
|
|
5827
4701
|
*
|
|
@@ -5833,13 +4707,11 @@ declare const RequiredSectionsRule$1: Rule$1;
|
|
|
5833
4707
|
* ```
|
|
5834
4708
|
*
|
|
5835
4709
|
* @see {@link https://github.com/savvy-web/systems/blob/main/packages/silk-effects/docs/rules/CSH004.md | CSH004 rule documentation}
|
|
5836
|
-
* @see `src/
|
|
4710
|
+
* @see `src/changesets/rules/uncategorized-content.ts` for the corresponding kit-node rule
|
|
5837
4711
|
*
|
|
5838
4712
|
* @public
|
|
5839
4713
|
*/
|
|
5840
|
-
declare const UncategorizedContentRule
|
|
5841
|
-
//#endregion
|
|
5842
|
-
//#region src/changesets/markdownlint/index.d.ts
|
|
4714
|
+
declare const UncategorizedContentRule: Rule$1;
|
|
5843
4715
|
/**
|
|
5844
4716
|
* All changeset rules as an array for markdownlint-cli2 `customRules` config.
|
|
5845
4717
|
*
|
|
@@ -5853,150 +4725,9 @@ declare const UncategorizedContentRule$1: Rule$1;
|
|
|
5853
4725
|
* @public
|
|
5854
4726
|
*/
|
|
5855
4727
|
declare const SilkChangesetsRules: Rule$1[];
|
|
5856
|
-
//#endregion
|
|
5857
|
-
//#region src/changesets/remark/plugins/aggregate-dependency-tables.d.ts
|
|
5858
|
-
declare const AggregateDependencyTablesPlugin: Plugin<[], Root>;
|
|
5859
|
-
//#endregion
|
|
5860
|
-
//#region src/changesets/remark/plugins/contributor-footnotes.d.ts
|
|
5861
|
-
/**
|
|
5862
|
-
* Options for {@link ContributorFootnotesPlugin}.
|
|
5863
|
-
*
|
|
5864
|
-
* @public
|
|
5865
|
-
*/
|
|
5866
|
-
interface ContributorFootnotesOptions {
|
|
5867
|
-
/**
|
|
5868
|
-
* Whether to emit the aggregated `### Thanks` section. Defaults to
|
|
5869
|
-
* `true`. When `false`, inline attributions and any existing Thanks
|
|
5870
|
-
* section are stripped and nothing is emitted.
|
|
5871
|
-
*/
|
|
5872
|
-
readonly thanks?: boolean;
|
|
5873
|
-
}
|
|
5874
|
-
declare const ContributorFootnotesPlugin: Plugin<[ContributorFootnotesOptions?], Root>;
|
|
5875
|
-
//#endregion
|
|
5876
|
-
//#region src/changesets/remark/plugins/deduplicate-items.d.ts
|
|
5877
|
-
declare const DeduplicateItemsPlugin: Plugin<[], Root>;
|
|
5878
|
-
//#endregion
|
|
5879
|
-
//#region src/changesets/remark/plugins/issue-link-refs.d.ts
|
|
5880
|
-
declare const IssueLinkRefsPlugin: Plugin<[], Root>;
|
|
5881
|
-
//#endregion
|
|
5882
|
-
//#region src/changesets/remark/plugins/merge-sections.d.ts
|
|
5883
|
-
declare const MergeSectionsPlugin: Plugin<[], Root>;
|
|
5884
|
-
//#endregion
|
|
5885
|
-
//#region src/changesets/remark/plugins/normalize-format.d.ts
|
|
5886
|
-
declare const NormalizeFormatPlugin: Plugin<[], Root>;
|
|
5887
|
-
//#endregion
|
|
5888
|
-
//#region src/changesets/remark/plugins/reorder-sections.d.ts
|
|
5889
|
-
declare const ReorderSectionsPlugin: Plugin<[], Root>;
|
|
5890
|
-
//#endregion
|
|
5891
|
-
//#region src/changesets/remark/presets.d.ts
|
|
5892
|
-
/**
|
|
5893
|
-
* Remark preset collections for changeset lint rules and transform plugins.
|
|
5894
|
-
*
|
|
5895
|
-
* @remarks
|
|
5896
|
-
* Presets bundle related remark plugins into ordered arrays for convenient
|
|
5897
|
-
* consumption. Each preset is a `readonly` tuple so that TypeScript can
|
|
5898
|
-
* narrow element types. Iterate and `.use()` each entry with `unified()`.
|
|
5899
|
-
*
|
|
5900
|
-
* @see {@link SilkChangesetPreset} for lint rules
|
|
5901
|
-
* @see {@link SilkChangesetTransformPreset} for transform plugins
|
|
5902
|
-
*/
|
|
5903
|
-
/**
|
|
5904
|
-
* Preset combining all changeset lint rules for convenient consumption.
|
|
5905
|
-
*
|
|
5906
|
-
* @remarks
|
|
5907
|
-
* Includes the following rules in order:
|
|
5908
|
-
*
|
|
5909
|
-
* 1. {@link HeadingHierarchyRule} (CSH001) -- no h1, no depth skips
|
|
5910
|
-
* 2. {@link RequiredSectionsRule} (CSH002) -- h2 headings must match a known category
|
|
5911
|
-
* 3. {@link ContentStructureRule} (CSH003) -- non-empty sections, code fence languages, non-empty list items
|
|
5912
|
-
* 4. {@link UncategorizedContentRule} (CSH004) -- no content before the first h2 heading
|
|
5913
|
-
* 5. {@link DependencyTableFormatRule} (CSH005) -- dependency table column/value validation
|
|
5914
|
-
*
|
|
5915
|
-
* Rule execution order is not significant for lint rules; all rules run
|
|
5916
|
-
* independently over the same AST and report warnings to the virtual file.
|
|
5917
|
-
*
|
|
5918
|
-
* @example
|
|
5919
|
-
* ```typescript
|
|
5920
|
-
* import { SilkChangesetPreset } from "\@savvy-web/changesets/remark";
|
|
5921
|
-
* import remarkParse from "remark-parse";
|
|
5922
|
-
* import { unified } from "unified";
|
|
5923
|
-
* import { read } from "to-vfile";
|
|
5924
|
-
*
|
|
5925
|
-
* const processor = unified().use(remarkParse);
|
|
5926
|
-
* for (const rule of SilkChangesetPreset) {
|
|
5927
|
-
* processor.use(rule);
|
|
5928
|
-
* }
|
|
5929
|
-
*
|
|
5930
|
-
* const file = await read("changeset.md");
|
|
5931
|
-
* const result = await processor.process(file);
|
|
5932
|
-
* console.log(result.messages); // lint warnings
|
|
5933
|
-
* ```
|
|
5934
|
-
*
|
|
5935
|
-
* @see {@link SilkChangesetTransformPreset} for the corresponding transform preset
|
|
5936
|
-
*
|
|
5937
|
-
* @public
|
|
5938
|
-
*/
|
|
5939
|
-
declare const SilkChangesetPreset: readonly [import("unified-lint-rule").Plugin<Root, unknown>, import("unified-lint-rule").Plugin<Root, unknown>, import("unified-lint-rule").Plugin<Root, unknown>, import("unified-lint-rule").Plugin<Root, unknown>, import("unified-lint-rule").Plugin<Root, unknown>];
|
|
5940
|
-
/**
|
|
5941
|
-
* Ordered array of all transform plugins in the correct execution order.
|
|
5942
|
-
*
|
|
5943
|
-
* @remarks
|
|
5944
|
-
* Plugin ordering is significant -- each plugin may depend on the output of
|
|
5945
|
-
* earlier plugins in the pipeline:
|
|
5946
|
-
*
|
|
5947
|
-
* 1. {@link AggregateDependencyTablesPlugin} -- merge duplicate dependency sections (must run first so downstream plugins see a single Dependencies section)
|
|
5948
|
-
* 2. {@link MergeSectionsPlugin} -- merge duplicate h3 headings (must run before reorder so that priority is computed on consolidated sections)
|
|
5949
|
-
* 3. {@link ReorderSectionsPlugin} -- sort sections by category priority (Breaking Changes first, Other last)
|
|
5950
|
-
* 4. {@link DeduplicateItemsPlugin} -- remove duplicate list items within each section
|
|
5951
|
-
* 5. {@link ContributorFootnotesPlugin} -- extract inline `Thanks \@user!` attributions and aggregate them into a summary paragraph per version block
|
|
5952
|
-
* 6. {@link IssueLinkRefsPlugin} -- convert inline `[#N](url)` links to reference-style `[#N]` with definitions at the end of each version block
|
|
5953
|
-
* 7. {@link NormalizeFormatPlugin} -- final cleanup removing empty sections and empty lists
|
|
5954
|
-
*
|
|
5955
|
-
* @example
|
|
5956
|
-
* ```typescript
|
|
5957
|
-
* import { SilkChangesetTransformPreset } from "\@savvy-web/changesets/remark";
|
|
5958
|
-
* import remarkGfm from "remark-gfm";
|
|
5959
|
-
* import remarkParse from "remark-parse";
|
|
5960
|
-
* import remarkStringify from "remark-stringify";
|
|
5961
|
-
* import { unified } from "unified";
|
|
5962
|
-
* import { read } from "to-vfile";
|
|
5963
|
-
*
|
|
5964
|
-
* const processor = unified().use(remarkParse).use(remarkGfm);
|
|
5965
|
-
* for (const plugin of SilkChangesetTransformPreset) {
|
|
5966
|
-
* processor.use(plugin);
|
|
5967
|
-
* }
|
|
5968
|
-
* processor.use(remarkStringify);
|
|
5969
|
-
*
|
|
5970
|
-
* const file = await read("CHANGELOG.md");
|
|
5971
|
-
* const result = await processor.process(file);
|
|
5972
|
-
* console.log(String(result));
|
|
5973
|
-
* ```
|
|
5974
|
-
*
|
|
5975
|
-
* @see {@link SilkChangesetPreset} for the corresponding lint preset
|
|
5976
|
-
*
|
|
5977
|
-
* @public
|
|
5978
|
-
*/
|
|
5979
|
-
declare const SilkChangesetTransformPreset: readonly [import("unified").Plugin<[], Root>, import("unified").Plugin<[], Root>, import("unified").Plugin<[], Root>, import("unified").Plugin<[], Root>, import("unified").Plugin<[ContributorFootnotesOptions?], Root>, import("unified").Plugin<[], Root>, import("unified").Plugin<[], Root>];
|
|
5980
|
-
//#endregion
|
|
5981
|
-
//#region src/changesets/remark/rules/content-structure.d.ts
|
|
5982
|
-
declare const ContentStructureRule: import("unified-lint-rule").Plugin<Root, unknown>;
|
|
5983
|
-
//#endregion
|
|
5984
|
-
//#region src/changesets/remark/rules/dependency-table-format.d.ts
|
|
5985
|
-
declare const DependencyTableFormatRule: import("unified-lint-rule").Plugin<Root, unknown>;
|
|
5986
|
-
//#endregion
|
|
5987
|
-
//#region src/changesets/remark/rules/heading-hierarchy.d.ts
|
|
5988
|
-
declare const HeadingHierarchyRule: import("unified-lint-rule").Plugin<Root, unknown>;
|
|
5989
|
-
//#endregion
|
|
5990
|
-
//#region src/changesets/remark/rules/required-sections.d.ts
|
|
5991
|
-
declare const RequiredSectionsRule: import("unified-lint-rule").Plugin<Root, unknown>;
|
|
5992
|
-
//#endregion
|
|
5993
|
-
//#region src/changesets/remark/rules/uncategorized-content.d.ts
|
|
5994
|
-
declare const UncategorizedContentRule: import("unified-lint-rule").Plugin<Root, unknown>;
|
|
5995
4728
|
declare namespace index_d_exports {
|
|
5996
|
-
export {
|
|
4729
|
+
export { AppliedRelease, AppliedReleaseEntry, AppliedReleaseEntrySchema, AppliedReleaseSchema, ApplyOptions, ApplyStep, BranchAnalysis, BranchAnalysisSchema, BranchAnalyzer, BranchAnalyzerShape, BranchFileEntry, BranchFileEntrySchema, BumpType, BumpTypeSchema, Categories, Changelog, ChangelogService, ChangelogServiceShape, ChangelogTransformer, Changeset, ChangesetIOError, ChangesetLinter, ChangesetLogMode, ChangesetLogModeValue, ChangesetOptions, ChangesetOptionsSchema, ChangesetPreview, ChangesetPreviewSchema, ChangesetSchema, ChangesetSummarySchema, ChangesetValidationError, Classification, ClassificationReason, ClassificationReasonSchema, ClassificationSchema, CoexistingChangeset, CoexistingChangesetSchema, CommitHashSchema, ConfigInspector, ConfigInspectorShape, ConfigurationError, DependencyAction, DependencyActionSchema, DependencyTable, DependencyTableRow, DependencyTableRowSchema, DependencyTableSchema, DependencyTableType, DependencyTableTypeSchema, DependencyType, DependencyTypeSchema, DependencyUpdate, DependencyUpdateSchema, DepsRegen, DepsRegenDefault, DepsRegenExecuteOptions, DepsRegenOptions, DepsRegenPlanError, DepsRegenShape, FileStatus, FileStatusSchema, GitError, GitHubApiError, GitHubCommitInfo, GitHubInfo, GitHubInfoSchema, GitHubService, GitHubServiceShape, GlobSchema, HookReplayError, InspectedConfig, InspectedConfigSchema, IssueNumberSchema, JsonPathSchema, LegacyVersionFileConfig, LegacyVersionFileConfigSchema, LegacyVersionFilesSchema, LintMessage, MaintenanceNoteOptions, MaintenanceReason, MaintenanceReasonSchema, MaintenanceTrigger, MaintenanceTriggerSchema, MakeChangelogFunctionsOptions, MarkdownParseError, ContentStructureRule as MarkdownlintContentStructureRule, DependencyTableFormatRule as MarkdownlintDependencyTableFormatRule, HeadingHierarchyRule as MarkdownlintHeadingHierarchyRule, RequiredSectionsRule as MarkdownlintRequiredSectionsRule, UncategorizedContentRule as MarkdownlintUncategorizedContentRule, NonEmptyString, PackageScope, PackageScopeSchema, PackagesRecordSchema, PendingChangeset, PendingChangesetSchema, PositiveInteger, PreviewRelease, PreviewReleaseSchema, RegenDiffRow, RegenDiffRowSchema, RegenPlan, RegenPlanSchema, RegenResult, RegenResultSchema, RegenStep, ReleasePlanError, ReleasePlanner, ReleasePlannerShape, RepoSchema, ResolvedPackageScope, ResolvedPackageScopeSchema, ResolvedVersionFile, ResolvedVersionFileSchema, SectionCategory, SectionCategorySchema, SilkChangesetsRules, SnapshotOptions, TransformOptions, UrlOrMarkdownLinkSchema, UsernameSchema, VERSION_RE, VersionFileConfig, VersionFileConfigSchema, VersionFileError, VersionFileUpdate, VersionFileUpdateRecord, VersionFileUpdateRecordSchema, VersionFiles, VersionFilesSchema, VersionOrEmptySchema, VersionType, VersionTypeSchema, WorkspaceDependencyDiff, WorkspaceVersion, changelogFunctions, computeWorkspaceDependencyDiffs, deriveMaintenanceReason, gitMergeBase, isPureDependencyChangeset, listPublishablePackageNames, makeBranchAnalyzerTest, makeChangelogFunctions, makeConfigInspectorTest, makeDepsRegenDefault, makeGitHubTest, makeReleasePlannerTest, parseChangesetPackages, serializeDependencyTableToMarkdown, vanillaChangelogFunctions };
|
|
5997
4730
|
}
|
|
5998
|
-
//#endregion
|
|
5999
|
-
//#region src/commitlint/config/schema.d.ts
|
|
6000
4731
|
/**
|
|
6001
4732
|
* Release format type for the release commit type.
|
|
6002
4733
|
*
|
|
@@ -6107,8 +4838,6 @@ interface ConfigOptions {
|
|
|
6107
4838
|
*/
|
|
6108
4839
|
cwd?: string;
|
|
6109
4840
|
}
|
|
6110
|
-
//#endregion
|
|
6111
|
-
//#region src/commitlint/config/types.d.ts
|
|
6112
4841
|
/**
|
|
6113
4842
|
* Rule severity level.
|
|
6114
4843
|
* - 0: Disabled
|
|
@@ -6222,8 +4951,6 @@ interface CommitTypeDefinition {
|
|
|
6222
4951
|
*/
|
|
6223
4952
|
readonly emoji?: string;
|
|
6224
4953
|
}
|
|
6225
|
-
//#endregion
|
|
6226
|
-
//#region src/commitlint/config/rules.d.ts
|
|
6227
4954
|
/**
|
|
6228
4955
|
* Allowed commit types for conventional commits.
|
|
6229
4956
|
*
|
|
@@ -6300,8 +5027,6 @@ declare const DEFAULT_BODY_MAX_LINE_LENGTH = 300;
|
|
|
6300
5027
|
* @public
|
|
6301
5028
|
*/
|
|
6302
5029
|
declare const DCO_SIGNOFF_TEXT = "Signed-off-by:";
|
|
6303
|
-
//#endregion
|
|
6304
|
-
//#region src/commitlint/static.d.ts
|
|
6305
5030
|
/**
|
|
6306
5031
|
* Static commitlint configuration.
|
|
6307
5032
|
*
|
|
@@ -6316,8 +5041,6 @@ declare const DCO_SIGNOFF_TEXT = "Signed-off-by:";
|
|
|
6316
5041
|
* @public
|
|
6317
5042
|
*/
|
|
6318
5043
|
declare const staticConfig: CommitlintUserConfig;
|
|
6319
|
-
//#endregion
|
|
6320
|
-
//#region src/commitlint/formatter/format.d.ts
|
|
6321
5044
|
/**
|
|
6322
5045
|
* Individual rule result.
|
|
6323
5046
|
*
|
|
@@ -6364,8 +5087,6 @@ interface FormatterResult {
|
|
|
6364
5087
|
* @public
|
|
6365
5088
|
*/
|
|
6366
5089
|
declare function format(formatterResult: FormatterResult): string;
|
|
6367
|
-
//#endregion
|
|
6368
|
-
//#region src/commitlint/formatter/messages.d.ts
|
|
6369
5090
|
/**
|
|
6370
5091
|
* Detailed error explanations for common rule failures.
|
|
6371
5092
|
*
|
|
@@ -6404,8 +5125,6 @@ declare function getExplanation(ruleName: string): string | undefined;
|
|
|
6404
5125
|
* @public
|
|
6405
5126
|
*/
|
|
6406
5127
|
declare function getSuggestion(ruleName: string): string | undefined;
|
|
6407
|
-
//#endregion
|
|
6408
|
-
//#region src/commitlint/prompt/config.d.ts
|
|
6409
5128
|
/**
|
|
6410
5129
|
* Type enum entry for prompt configuration.
|
|
6411
5130
|
*
|
|
@@ -6545,8 +5264,6 @@ declare const defaultPromptConfig: ResolvedPromptConfig;
|
|
|
6545
5264
|
* @public
|
|
6546
5265
|
*/
|
|
6547
5266
|
declare const emojiPromptConfig: ResolvedPromptConfig;
|
|
6548
|
-
//#endregion
|
|
6549
|
-
//#region src/commitlint/prompt/emojis.d.ts
|
|
6550
5267
|
/**
|
|
6551
5268
|
* Emoji shortcode mapping for commit types.
|
|
6552
5269
|
*
|
|
@@ -6585,8 +5302,6 @@ declare const TYPE_EMOJIS_UNICODE: Record<CommitType, string>;
|
|
|
6585
5302
|
* ```
|
|
6586
5303
|
*/
|
|
6587
5304
|
declare function getTypeEmoji(type: CommitType, unicode?: boolean): string;
|
|
6588
|
-
//#endregion
|
|
6589
|
-
//#region src/commitlint/prompt/prompter.d.ts
|
|
6590
5305
|
/**
|
|
6591
5306
|
* Inquirer instance provided by commitizen.
|
|
6592
5307
|
*/
|
|
@@ -6652,8 +5367,6 @@ interface PrompterOptions {
|
|
|
6652
5367
|
* @public
|
|
6653
5368
|
*/
|
|
6654
5369
|
declare function prompter(cz: Inquirer, commit: (message: string) => void, options?: PrompterOptions): void;
|
|
6655
|
-
//#endregion
|
|
6656
|
-
//#region src/commitlint/detection/dco.d.ts
|
|
6657
5370
|
/**
|
|
6658
5371
|
* Detect if DCO signoff should be required.
|
|
6659
5372
|
*
|
|
@@ -6668,8 +5381,6 @@ declare function prompter(cz: Inquirer, commit: (message: string) => void, optio
|
|
|
6668
5381
|
* @public
|
|
6669
5382
|
*/
|
|
6670
5383
|
declare function detectDCO(cwd?: string): boolean;
|
|
6671
|
-
//#endregion
|
|
6672
|
-
//#region src/commitlint/detection/scopes.d.ts
|
|
6673
5384
|
/**
|
|
6674
5385
|
* Detect package scopes from workspace configuration.
|
|
6675
5386
|
*
|
|
@@ -6683,8 +5394,6 @@ declare function detectDCO(cwd?: string): boolean;
|
|
|
6683
5394
|
* @public
|
|
6684
5395
|
*/
|
|
6685
5396
|
declare const detectScopes: Effect.Effect<string[], WorkspaceDiscoveryFailure, WorkspaceDiscovery>;
|
|
6686
|
-
//#endregion
|
|
6687
|
-
//#region src/commitlint/hook/envelope.d.ts
|
|
6688
5397
|
declare const PreToolUseEnvelope: Schema.Struct<{
|
|
6689
5398
|
readonly hook_event_name: Schema.Literal<"PreToolUse">;
|
|
6690
5399
|
readonly tool_name: Schema.String;
|
|
@@ -6708,8 +5417,6 @@ declare const SessionStartEnvelope: Schema.Struct<{
|
|
|
6708
5417
|
readonly source: Schema.optional<Schema.String>;
|
|
6709
5418
|
}>;
|
|
6710
5419
|
type SessionStartEnvelope = Schema.Schema.Type<typeof SessionStartEnvelope>;
|
|
6711
|
-
//#endregion
|
|
6712
|
-
//#region src/commitlint/hook/output.d.ts
|
|
6713
5420
|
/**
|
|
6714
5421
|
* Helpers that build the JSON output the bash hooks pass through to Claude.
|
|
6715
5422
|
*
|
|
@@ -6722,8 +5429,6 @@ declare function preToolUseAdvise(message: string): HookOutput;
|
|
|
6722
5429
|
declare function preToolUseSilent(): HookOutput;
|
|
6723
5430
|
declare function sessionStartContext(message: string): HookOutput;
|
|
6724
5431
|
declare function postToolUseAdvise(message: string): HookOutput;
|
|
6725
|
-
//#endregion
|
|
6726
|
-
//#region src/commitlint/hook/parse-bash-command.d.ts
|
|
6727
5432
|
type ParsedKind = "git-commit" | "git-commit-amend" | "gh-pr-create" | "gh-pr-edit" | "unknown";
|
|
6728
5433
|
interface ParsedCommit {
|
|
6729
5434
|
kind: ParsedKind;
|
|
@@ -6736,31 +5441,21 @@ interface ParsedCommit {
|
|
|
6736
5441
|
source: "inline" | "file" | "heredoc" | "stdin" | "none";
|
|
6737
5442
|
}
|
|
6738
5443
|
declare function parseBashCommand(command: string): ParsedCommit;
|
|
6739
|
-
//#endregion
|
|
6740
|
-
//#region src/commitlint/hook/silence-logger.d.ts
|
|
6741
5444
|
/**
|
|
6742
5445
|
* Combined hook logger layer: stderr redirect merged with the Warn minimum
|
|
6743
5446
|
* log level. Provided by hook command wrappers to keep stdout corruption-proof.
|
|
6744
5447
|
*/
|
|
6745
5448
|
declare const HookSilencer: Layer.Layer<never, never, never>;
|
|
6746
|
-
//#endregion
|
|
6747
|
-
//#region src/commitlint/hook/diagnostics/branch.d.ts
|
|
6748
5449
|
interface BranchInfo {
|
|
6749
5450
|
branch: string | null;
|
|
6750
5451
|
inferredTicketId: number | null;
|
|
6751
5452
|
}
|
|
6752
5453
|
declare function inferTicketId(branch: string): number | null;
|
|
6753
5454
|
declare function readBranchInfo(): Effect.Effect<BranchInfo, never, Git>;
|
|
6754
|
-
//#endregion
|
|
6755
|
-
//#region src/commitlint/hook/diagnostics/cache.d.ts
|
|
6756
5455
|
declare function readCache<T>(path: string, ttlSeconds: number): Effect.Effect<T | null>;
|
|
6757
5456
|
declare function writeCache<T>(path: string, data: T, when?: Date): Effect.Effect<void>;
|
|
6758
|
-
//#endregion
|
|
6759
|
-
//#region src/commitlint/hook/diagnostics/commitlint-config.d.ts
|
|
6760
5457
|
declare function parseHuskyConfigPath(huskyContent: string, root: string): string | null;
|
|
6761
5458
|
declare function readCommitlintConfigPath(root: string): Promise<string | null>;
|
|
6762
|
-
//#endregion
|
|
6763
|
-
//#region src/commitlint/hook/diagnostics/open-issues.d.ts
|
|
6764
5459
|
interface OpenIssue {
|
|
6765
5460
|
number: number;
|
|
6766
5461
|
title: string;
|
|
@@ -6784,8 +5479,6 @@ declare function resolveIssuesCachePath(options?: {
|
|
|
6784
5479
|
declare function readOpenIssuesFromCache(cachePath: string, ttlSeconds?: number): Effect.Effect<OpenIssue[] | null>;
|
|
6785
5480
|
declare function fetchAndCacheOpenIssues(cachePath: string): Effect.Effect<OpenIssue[] | null, never, ChildProcessSpawner.ChildProcessSpawner>;
|
|
6786
5481
|
declare function readOrFetchOpenIssues(cachePath: string): Effect.Effect<OpenIssue[] | null, never, ChildProcessSpawner.ChildProcessSpawner>;
|
|
6787
|
-
//#endregion
|
|
6788
|
-
//#region src/commitlint/hook/diagnostics/package-manager.d.ts
|
|
6789
5482
|
type PackageManager$1 = "pnpm" | "yarn" | "bun" | "npm";
|
|
6790
5483
|
interface LockfilePresence {
|
|
6791
5484
|
pnpm: boolean;
|
|
@@ -6795,8 +5488,6 @@ interface LockfilePresence {
|
|
|
6795
5488
|
declare function parsePackageManagerField(packageJsonContent: string): PackageManager$1 | null;
|
|
6796
5489
|
declare function detectFromLockfiles(presence: LockfilePresence): PackageManager$1;
|
|
6797
5490
|
declare function detectPackageManager(root: string): Promise<PackageManager$1>;
|
|
6798
|
-
//#endregion
|
|
6799
|
-
//#region src/commitlint/hook/diagnostics/signing.d.ts
|
|
6800
5491
|
interface SigningDiagnostic {
|
|
6801
5492
|
format: "gpg" | "ssh" | "none";
|
|
6802
5493
|
autoSignEnabled: boolean;
|
|
@@ -6817,8 +5508,6 @@ interface RawSigningInputs {
|
|
|
6817
5508
|
declare function parseGpgKeyExpiry(colonsOutput: string): string | null;
|
|
6818
5509
|
declare function buildSigningDiagnostic(raw: RawSigningInputs): SigningDiagnostic;
|
|
6819
5510
|
declare function readSigningDiagnostic(): Effect.Effect<SigningDiagnostic, never, Git | ChildProcessSpawner.ChildProcessSpawner>;
|
|
6820
|
-
//#endregion
|
|
6821
|
-
//#region src/commitlint/hook/rules/types.d.ts
|
|
6822
5511
|
type RuleSeverity$1 = "deny" | "advise";
|
|
6823
5512
|
interface RuleHit {
|
|
6824
5513
|
ruleId: string;
|
|
@@ -6834,8 +5523,6 @@ declare function partitionHits(hits: ReadonlyArray<RuleHit>): {
|
|
|
6834
5523
|
deny: RuleHit[];
|
|
6835
5524
|
advise: RuleHit[];
|
|
6836
5525
|
};
|
|
6837
|
-
//#endregion
|
|
6838
|
-
//#region src/commitlint/hook/rules/closes-trailer.d.ts
|
|
6839
5526
|
interface ClosesTrailerInput {
|
|
6840
5527
|
message: string;
|
|
6841
5528
|
}
|
|
@@ -6860,20 +5547,14 @@ interface ClosesTrailerCtx {
|
|
|
6860
5547
|
*/
|
|
6861
5548
|
declare function hasClosingTrailer(message: string, ticketId: number): boolean;
|
|
6862
5549
|
declare const closesTrailerRule: Rule<ClosesTrailerInput, ClosesTrailerCtx>;
|
|
6863
|
-
//#endregion
|
|
6864
|
-
//#region src/commitlint/hook/rules/forbidden-content.d.ts
|
|
6865
5550
|
interface ForbiddenContentInput {
|
|
6866
5551
|
message: string;
|
|
6867
5552
|
}
|
|
6868
5553
|
declare const forbiddenContentRule: Rule<ForbiddenContentInput, never>;
|
|
6869
|
-
//#endregion
|
|
6870
|
-
//#region src/commitlint/hook/rules/plan-leakage.d.ts
|
|
6871
5554
|
interface PlanLeakageInput {
|
|
6872
5555
|
message: string;
|
|
6873
5556
|
}
|
|
6874
5557
|
declare const planLeakageRule: Rule<PlanLeakageInput, never>;
|
|
6875
|
-
//#endregion
|
|
6876
|
-
//#region src/commitlint/hook/rules/signing-flag-conflict.d.ts
|
|
6877
5558
|
interface SigningFlagInput {
|
|
6878
5559
|
flags: ParsedCommit["flags"];
|
|
6879
5560
|
}
|
|
@@ -6881,14 +5562,10 @@ interface SigningFlagCtx {
|
|
|
6881
5562
|
autoSignEnabled: boolean;
|
|
6882
5563
|
}
|
|
6883
5564
|
declare const signingFlagConflictRule: Rule<SigningFlagInput, SigningFlagCtx>;
|
|
6884
|
-
//#endregion
|
|
6885
|
-
//#region src/commitlint/hook/rules/soft-wrap.d.ts
|
|
6886
5565
|
interface SoftWrapInput {
|
|
6887
5566
|
message: string;
|
|
6888
5567
|
}
|
|
6889
5568
|
declare const softWrapRule: Rule<SoftWrapInput, never>;
|
|
6890
|
-
//#endregion
|
|
6891
|
-
//#region src/commitlint/hook/rules/verbosity.d.ts
|
|
6892
5569
|
interface VerbosityInput {
|
|
6893
5570
|
message: string;
|
|
6894
5571
|
}
|
|
@@ -6945,8 +5622,6 @@ declare class CommitlintConfig {
|
|
|
6945
5622
|
static silk(options?: ConfigOptions): CommitlintUserConfig;
|
|
6946
5623
|
private constructor();
|
|
6947
5624
|
}
|
|
6948
|
-
//#endregion
|
|
6949
|
-
//#region src/lint/types.d.ts
|
|
6950
5625
|
/**
|
|
6951
5626
|
* A lint-staged handler function.
|
|
6952
5627
|
* Receives an array of staged filenames and returns command(s) to execute.
|
|
@@ -7154,8 +5829,6 @@ interface CreateConfigOptions {
|
|
|
7154
5829
|
* Preset type for standard configurations.
|
|
7155
5830
|
*/
|
|
7156
5831
|
type PresetType = "minimal" | "standard" | "silk";
|
|
7157
|
-
//#endregion
|
|
7158
|
-
//#region src/lint/Handler.d.ts
|
|
7159
5832
|
/**
|
|
7160
5833
|
* Abstract base class for lint-staged handlers.
|
|
7161
5834
|
*
|
|
@@ -7188,8 +5861,6 @@ declare abstract class Handler {
|
|
|
7188
5861
|
*/
|
|
7189
5862
|
static create(_options?: BaseHandlerOptions): LintStagedHandler;
|
|
7190
5863
|
}
|
|
7191
|
-
//#endregion
|
|
7192
|
-
//#region src/lint/handlers/Biome.d.ts
|
|
7193
5864
|
/**
|
|
7194
5865
|
* Handler for JavaScript, TypeScript, and JSON files.
|
|
7195
5866
|
*
|
|
@@ -7293,8 +5964,6 @@ declare class Biome {
|
|
|
7293
5964
|
*/
|
|
7294
5965
|
static create(options?: BiomeOptions): LintStagedHandler;
|
|
7295
5966
|
}
|
|
7296
|
-
//#endregion
|
|
7297
|
-
//#region src/lint/handlers/Markdown.d.ts
|
|
7298
5967
|
/**
|
|
7299
5968
|
* Handler for Markdown files.
|
|
7300
5969
|
*
|
|
@@ -7382,8 +6051,6 @@ declare class Markdown {
|
|
|
7382
6051
|
*/
|
|
7383
6052
|
static create(options?: MarkdownOptions): LintStagedHandler;
|
|
7384
6053
|
}
|
|
7385
|
-
//#endregion
|
|
7386
|
-
//#region src/lint/handlers/PackageJson.d.ts
|
|
7387
6054
|
/**
|
|
7388
6055
|
* Handler for package.json files.
|
|
7389
6056
|
*
|
|
@@ -7480,8 +6147,6 @@ declare class PackageJson {
|
|
|
7480
6147
|
*/
|
|
7481
6148
|
static create(options?: PackageJsonOptions): LintStagedHandler;
|
|
7482
6149
|
}
|
|
7483
|
-
//#endregion
|
|
7484
|
-
//#region src/lint/handlers/PnpmWorkspace.d.ts
|
|
7485
6150
|
/**
|
|
7486
6151
|
* Shape of pnpm-workspace.yaml content.
|
|
7487
6152
|
*/
|
|
@@ -7587,8 +6252,6 @@ declare class PnpmWorkspace {
|
|
|
7587
6252
|
*/
|
|
7588
6253
|
static create(options?: PnpmWorkspaceOptions): LintStagedHandler;
|
|
7589
6254
|
}
|
|
7590
|
-
//#endregion
|
|
7591
|
-
//#region src/lint/handlers/ShellScripts.d.ts
|
|
7592
6255
|
/**
|
|
7593
6256
|
* Handler for shell script files.
|
|
7594
6257
|
*
|
|
@@ -7637,8 +6300,6 @@ declare class ShellScripts {
|
|
|
7637
6300
|
*/
|
|
7638
6301
|
static create(options?: ShellScriptsOptions): LintStagedHandler;
|
|
7639
6302
|
}
|
|
7640
|
-
//#endregion
|
|
7641
|
-
//#region src/lint/handlers/TextFiles.d.ts
|
|
7642
6303
|
/**
|
|
7643
6304
|
* Why a file is not grep-visible text.
|
|
7644
6305
|
*
|
|
@@ -7875,8 +6536,6 @@ declare class TextFiles {
|
|
|
7875
6536
|
*/
|
|
7876
6537
|
static create(options?: TextFilesOptions): LintStagedHandler;
|
|
7877
6538
|
}
|
|
7878
|
-
//#endregion
|
|
7879
|
-
//#region src/lint/handlers/TypeScript.d.ts
|
|
7880
6539
|
/**
|
|
7881
6540
|
* TypeScript compiler to use.
|
|
7882
6541
|
*/
|
|
@@ -7976,8 +6635,6 @@ declare class TypeScript {
|
|
|
7976
6635
|
*/
|
|
7977
6636
|
static create(options?: TypeScriptOptions): LintStagedHandler;
|
|
7978
6637
|
}
|
|
7979
|
-
//#endregion
|
|
7980
|
-
//#region src/lint/handlers/Yaml.d.ts
|
|
7981
6638
|
/**
|
|
7982
6639
|
* Handler for YAML files.
|
|
7983
6640
|
*
|
|
@@ -8102,8 +6759,6 @@ declare class Yaml {
|
|
|
8102
6759
|
*/
|
|
8103
6760
|
static create(options?: YamlOptions): LintStagedHandler;
|
|
8104
6761
|
}
|
|
8105
|
-
//#endregion
|
|
8106
|
-
//#region src/lint/config/createConfig.d.ts
|
|
8107
6762
|
/**
|
|
8108
6763
|
* Create a complete lint-staged configuration with all handlers.
|
|
8109
6764
|
*
|
|
@@ -8128,8 +6783,6 @@ declare class Yaml {
|
|
|
8128
6783
|
* ```
|
|
8129
6784
|
*/
|
|
8130
6785
|
declare function createConfig(options?: CreateConfigOptions): LintStagedConfig;
|
|
8131
|
-
//#endregion
|
|
8132
|
-
//#region src/lint/config/Preset.d.ts
|
|
8133
6786
|
/**
|
|
8134
6787
|
* Options for extending a preset.
|
|
8135
6788
|
* Alias for {@link CreateConfigOptions}.
|
|
@@ -8241,8 +6894,6 @@ declare class Preset {
|
|
|
8241
6894
|
*/
|
|
8242
6895
|
static get(name: "minimal" | "standard" | "silk", extend?: PresetExtendOptions): LintStagedConfig;
|
|
8243
6896
|
}
|
|
8244
|
-
//#endregion
|
|
8245
|
-
//#region src/lint/utils/Command.d.ts
|
|
8246
6897
|
/**
|
|
8247
6898
|
* Utilities for shell command operations.
|
|
8248
6899
|
*
|
|
@@ -8429,8 +7080,6 @@ declare class Command {
|
|
|
8429
7080
|
*/
|
|
8430
7081
|
static execSilent(command: string): boolean;
|
|
8431
7082
|
}
|
|
8432
|
-
//#endregion
|
|
8433
|
-
//#region src/lint/utils/Filter.d.ts
|
|
8434
7083
|
/**
|
|
8435
7084
|
* Static utility class for filtering file lists.
|
|
8436
7085
|
*/
|
|
@@ -8504,8 +7153,6 @@ declare class Filter {
|
|
|
8504
7153
|
*/
|
|
8505
7154
|
static shellEscape(filenames: readonly string[]): string;
|
|
8506
7155
|
}
|
|
8507
|
-
//#endregion
|
|
8508
|
-
//#region src/lint/utils/Workspace.d.ts
|
|
8509
7156
|
/**
|
|
8510
7157
|
* Workspace-aware discovery utilities.
|
|
8511
7158
|
*
|
|
@@ -8567,8 +7214,6 @@ declare function isWorkspacePackagePath(filePath: string): boolean;
|
|
|
8567
7214
|
* Call this in test teardown to ensure clean state between tests.
|
|
8568
7215
|
*/
|
|
8569
7216
|
declare function resetWorkspaceCache(): void;
|
|
8570
|
-
//#endregion
|
|
8571
|
-
//#region src/lint/cli/sections.d.ts
|
|
8572
7217
|
/** Path for the husky pre-commit hook. */
|
|
8573
7218
|
declare const HUSKY_HOOK_PATH = ".husky/pre-commit";
|
|
8574
7219
|
/** Path for the husky post-checkout hook. */
|
|
@@ -8612,8 +7257,6 @@ declare function savvyLintBlock(configPath: string): Section;
|
|
|
8612
7257
|
* @param configPath - Path to the lint-staged config file
|
|
8613
7258
|
*/
|
|
8614
7259
|
declare function generateManagedContent(configPath: string): string;
|
|
8615
|
-
//#endregion
|
|
8616
|
-
//#region src/lint/cli/templates/markdownlint.gen.d.ts
|
|
8617
7260
|
/** Full markdownlint-cli2 config template. */
|
|
8618
7261
|
declare const MARKDOWNLINT_TEMPLATE: {
|
|
8619
7262
|
readonly $schema: "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.22.0/schema/markdownlint-cli2-config-schema.json";
|
|
@@ -8782,8 +7425,6 @@ declare const MARKDOWNLINT_CONFIG: {
|
|
|
8782
7425
|
declare namespace index_d_exports$2 {
|
|
8783
7426
|
export { BaseHandlerOptions, Biome, BiomeOptions, Command, CreateConfigOptions, DEFAULT_CONFIG_PATH, Filter, HUSKY_HOOK_PATH, Handler, LegacySavvyLintHygieneDef, LintStagedConfig, LintStagedEntry, LintStagedHandler, MARKDOWNLINT_CONFIG, MARKDOWNLINT_CONFIG_PATH, MARKDOWNLINT_SCHEMA, MARKDOWNLINT_TEMPLATE, Markdown, MarkdownOptions, POST_CHECKOUT_HOOK_PATH, POST_COMMIT_HOOK_PATH, POST_MERGE_HOOK_PATH, PackageJson, PackageJsonOptions, PackageManager, PnpmWorkspace, PnpmWorkspaceContent, PnpmWorkspaceOptions, Preset, PresetExtendOptions, PresetType, SavvyLintSectionDef, ShellScripts, ShellScriptsOptions, TextFileFinding, TextFileStagedCheck, TextFileStagedReadError, TextFileStagedReadErrorBase, TextFileViolation, TextFileViolationReason, TextFiles, TextFilesListOptions, TextFilesOptions, ToolSearchResult, TypeScript, TypeScriptCompiler, TypeScriptOptions, WorkspacePackageInfo, Yaml, YamlOptions, createConfig, generateManagedContent, getWorkspacePackagePaths, getWorkspacePackages, getWorkspaceRoot, isWorkspacePackagePath, resetWorkspaceCache, savvyLintBlock };
|
|
8784
7427
|
}
|
|
8785
|
-
//#endregion
|
|
8786
|
-
//#region src/repos/constants.d.ts
|
|
8787
7428
|
/**
|
|
8788
7429
|
* Directory vendored reference repos live under, relative to the repo root.
|
|
8789
7430
|
* @public
|
|
@@ -8800,8 +7441,6 @@ declare const MANIFEST_PATH = ".repos/config.json";
|
|
|
8800
7441
|
* @public
|
|
8801
7442
|
*/
|
|
8802
7443
|
declare const NOTE_LIMIT = 10;
|
|
8803
|
-
//#endregion
|
|
8804
|
-
//#region src/repos/errors.d.ts
|
|
8805
7444
|
/** @internal */
|
|
8806
7445
|
declare const ReposConfigErrorBase: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
8807
7446
|
readonly _tag: "ReposConfigError";
|
|
@@ -8873,8 +7512,6 @@ declare class ReposLockdownError extends ReposLockdownErrorBase<{
|
|
|
8873
7512
|
}> {
|
|
8874
7513
|
get message(): string;
|
|
8875
7514
|
}
|
|
8876
|
-
//#endregion
|
|
8877
|
-
//#region src/repos/schemas/drift.d.ts
|
|
8878
7515
|
/**
|
|
8879
7516
|
* The kinds of drift {@link ReposDrift} can detect between the five
|
|
8880
7517
|
* authorities it reconciles: the manifest, `.gitmodules`, the worktree,
|
|
@@ -8913,8 +7550,6 @@ declare const ReposDriftReport_base: Schema.Class<ReposDriftReport, Schema.Struc
|
|
|
8913
7550
|
* @public
|
|
8914
7551
|
*/
|
|
8915
7552
|
declare class ReposDriftReport extends ReposDriftReport_base {}
|
|
8916
|
-
//#endregion
|
|
8917
|
-
//#region src/repos/schemas/manifest.d.ts
|
|
8918
7553
|
/**
|
|
8919
7554
|
* A vendored-repo manifest key: non-empty, contains no `/` or `\`, and is
|
|
8920
7555
|
* never `.` or `..` — safe to join onto a filesystem path segment
|
|
@@ -8995,8 +7630,6 @@ declare const ReposManifestFile: Schema.Struct<{
|
|
|
8995
7630
|
}>;
|
|
8996
7631
|
/** @public */
|
|
8997
7632
|
type ReposManifestFile = typeof ReposManifestFile.Type;
|
|
8998
|
-
//#endregion
|
|
8999
|
-
//#region src/repos/schemas/reports.d.ts
|
|
9000
7633
|
/**
|
|
9001
7634
|
* Status of one vendored repo: gitlink presence and dirtiness, plus notes
|
|
9002
7635
|
* that no longer match the pinned ref.
|
|
@@ -9225,8 +7858,6 @@ declare const ReposNoteResult: Schema.Struct<{
|
|
|
9225
7858
|
}>;
|
|
9226
7859
|
/** @public */
|
|
9227
7860
|
type ReposNoteResult = typeof ReposNoteResult.Type;
|
|
9228
|
-
//#endregion
|
|
9229
|
-
//#region src/repos/services/config-store.d.ts
|
|
9230
7861
|
/**
|
|
9231
7862
|
* The {@link ReposConfigStore} service shape.
|
|
9232
7863
|
* @public
|
|
@@ -9256,8 +7887,6 @@ declare class ReposConfigStore extends ReposConfigStore_base {
|
|
|
9256
7887
|
*/
|
|
9257
7888
|
static readonly layer: Layer.Layer<ReposConfigStore, never, FileSystem.FileSystem | Path.Path>;
|
|
9258
7889
|
}
|
|
9259
|
-
//#endregion
|
|
9260
|
-
//#region src/repos/services/drift.d.ts
|
|
9261
7890
|
/**
|
|
9262
7891
|
* Extracts the submodule NAME from a `submodule.<name>.<property>` config key.
|
|
9263
7892
|
*
|
|
@@ -9306,8 +7935,6 @@ declare class ReposDrift extends ReposDrift_base {
|
|
|
9306
7935
|
*/
|
|
9307
7936
|
static readonly layer: Layer.Layer<ReposDrift, never, ReposConfigStore | Git | FileSystem.FileSystem | Path.Path>;
|
|
9308
7937
|
}
|
|
9309
|
-
//#endregion
|
|
9310
|
-
//#region src/repos/services/lockdown.d.ts
|
|
9311
7938
|
/**
|
|
9312
7939
|
* The {@link ReposLockdown} service shape.
|
|
9313
7940
|
* @public
|
|
@@ -9388,8 +8015,6 @@ declare class ReposLockdown extends ReposLockdown_base {
|
|
|
9388
8015
|
*/
|
|
9389
8016
|
static readonly layer: Layer.Layer<ReposLockdown, never, FileSystem.FileSystem | Path.Path>;
|
|
9390
8017
|
}
|
|
9391
|
-
//#endregion
|
|
9392
|
-
//#region src/repos/services/manager.d.ts
|
|
9393
8018
|
/**
|
|
9394
8019
|
* Minimum age (in milliseconds) a `.lock` file must reach before `sync` will
|
|
9395
8020
|
* remove it. An ACTIVE git process can legitimately hold
|
|
@@ -9522,8 +8147,6 @@ declare class ReposManager extends ReposManager_base {
|
|
|
9522
8147
|
declare namespace index_d_exports$3 {
|
|
9523
8148
|
export { DriftKind, GitSubmoduleError, GitSubmoduleErrorBase, MANIFEST_PATH, NOTE_LIMIT, NoteNotFoundError, NoteNotFoundErrorBase, REPOS_DIR, RepoDrift, RepoEntry, RepoName, RepoNotFoundError, RepoNotFoundErrorBase, RepoNote, RepoOrientation, RepoStatusEntry, ReposAddResult, ReposConfigError, ReposConfigErrorBase, ReposConfigStore, ReposConfigStoreShape, ReposDeregisterResult, ReposDrift, ReposDriftReport, ReposDriftShape, ReposLockdown, ReposLockdownError, ReposLockdownErrorBase, ReposLockdownShape, ReposManager, ReposManagerShape, ReposManifestFile, ReposNoteResult, ReposPinResult, ReposRemoveResult, ReposRenameResult, ReposRestoreResult, ReposStatusReport, ReposSyncReport, STALE_LOCK_MAX_AGE_MS, resolveModuleDir, submoduleNameFromKey };
|
|
9524
8149
|
}
|
|
9525
|
-
//#endregion
|
|
9526
|
-
//#region src/services/BiomeSchemaSync.d.ts
|
|
9527
8150
|
/**
|
|
9528
8151
|
* Strip leading semver range operators from a version string.
|
|
9529
8152
|
*
|
|
@@ -9619,8 +8242,6 @@ export declare class BiomeSchemaSync extends BiomeSchemaSync_base {
|
|
|
9619
8242
|
*/
|
|
9620
8243
|
static readonly layer: Layer.Layer<BiomeSchemaSync, never, FileSystem.FileSystem>;
|
|
9621
8244
|
}
|
|
9622
|
-
//#endregion
|
|
9623
|
-
//#region src/services/ConfigDiscovery.d.ts
|
|
9624
8245
|
/**
|
|
9625
8246
|
* The {@link ConfigDiscovery} service shape.
|
|
9626
8247
|
*
|
|
@@ -9697,8 +8318,15 @@ export declare class ConfigDiscovery extends ConfigDiscovery_base {
|
|
|
9697
8318
|
*/
|
|
9698
8319
|
static readonly layer: Layer.Layer<ConfigDiscovery, never, FileSystem.FileSystem>;
|
|
9699
8320
|
}
|
|
9700
|
-
|
|
9701
|
-
|
|
8321
|
+
/**
|
|
8322
|
+
* Which release versions a publish target receives (mirrors the bundler's `ReleaseChannel`).
|
|
8323
|
+
*
|
|
8324
|
+
* @remarks
|
|
8325
|
+
* `"all"` takes every version, `"stable"` only versions without a SemVer prerelease suffix, and
|
|
8326
|
+
* `"prerelease"` only versions with one. An undeclared value reads as `"all"`.
|
|
8327
|
+
* @public
|
|
8328
|
+
*/
|
|
8329
|
+
type ReleaseChannel = "all" | "stable" | "prerelease";
|
|
9702
8330
|
/**
|
|
9703
8331
|
* A single object-form publish target in the `publishConfig.targets` map (mirrors the bundler's `PublishTargetObject`).
|
|
9704
8332
|
* @public
|
|
@@ -9710,6 +8338,10 @@ interface RawTargetObject {
|
|
|
9710
8338
|
readonly name?: string;
|
|
9711
8339
|
/** Reuse another target's group bytes. Mutually exclusive with `name`. */
|
|
9712
8340
|
readonly from?: string;
|
|
8341
|
+
/** Which release versions this target receives. Defaults to `"all"`. */
|
|
8342
|
+
readonly releases?: ReleaseChannel;
|
|
8343
|
+
/** Force the provenance attestation on or off, overriding the registry-derived default. */
|
|
8344
|
+
readonly provenance?: boolean;
|
|
9713
8345
|
}
|
|
9714
8346
|
/**
|
|
9715
8347
|
* A `publishConfig.targets` value: `true` (well-known registry, base name), a string (name override), or an object.
|
|
@@ -9761,6 +8393,17 @@ interface TargetBinding {
|
|
|
9761
8393
|
readonly name: string;
|
|
9762
8394
|
/** The resolved registry endpoint. */
|
|
9763
8395
|
readonly registry: string;
|
|
8396
|
+
/**
|
|
8397
|
+
* Which release versions this target receives. The bundler always writes it; a binding from a
|
|
8398
|
+
* bundler that predates the field omits it, which reads as `"all"`.
|
|
8399
|
+
*/
|
|
8400
|
+
readonly releases?: ReleaseChannel;
|
|
8401
|
+
/**
|
|
8402
|
+
* The declared provenance override. Absent when none was declared, or in a binding from a
|
|
8403
|
+
* bundler that predates the field; either way the target object's own `provenance` applies,
|
|
8404
|
+
* then the registry default.
|
|
8405
|
+
*/
|
|
8406
|
+
readonly provenance?: boolean;
|
|
9764
8407
|
}
|
|
9765
8408
|
/**
|
|
9766
8409
|
* The `dist/prod/targets.json` binding the bundler emits for the release action to consume.
|
|
@@ -9776,6 +8419,25 @@ interface TargetsBinding {
|
|
|
9776
8419
|
readonly groups: ReadonlyArray<TargetGroupBinding>;
|
|
9777
8420
|
readonly targets: ReadonlyArray<TargetBinding>;
|
|
9778
8421
|
}
|
|
8422
|
+
/**
|
|
8423
|
+
* A resolved publish target judged against a specific release version, with the facts a publisher needs alongside it.
|
|
8424
|
+
*
|
|
8425
|
+
* @remarks
|
|
8426
|
+
* Returned by {@link SilkPublishability.resolveReleaseTargets}, one per resolved target whether or
|
|
8427
|
+
* not it takes the version, so a publisher can report what it skipped without a second join.
|
|
8428
|
+
* `id` is the `publishConfig.targets` key the target came from, or `undefined` for a package
|
|
8429
|
+
* published through the `access`/`private` fallbacks, which have no keyed targets.
|
|
8430
|
+
* @public
|
|
8431
|
+
*/
|
|
8432
|
+
interface ReleaseTarget {
|
|
8433
|
+
readonly target: PublishTarget;
|
|
8434
|
+
readonly id: string | undefined;
|
|
8435
|
+
readonly releases: ReleaseChannel;
|
|
8436
|
+
/** Whether this target takes the version; `false` means its `releases` filters it out. */
|
|
8437
|
+
readonly receives: boolean;
|
|
8438
|
+
/** The npm dist-tag this version publishes under; see {@link SilkPublishability.distTagFor}. */
|
|
8439
|
+
readonly distTag: string;
|
|
8440
|
+
}
|
|
9779
8441
|
/**
|
|
9780
8442
|
* Raw `package.json` shape consumed by `SilkPublishability.detect`.
|
|
9781
8443
|
* @public
|
|
@@ -9851,6 +8513,48 @@ export declare class SilkPublishability {
|
|
|
9851
8513
|
* placeholder directories are left alone.
|
|
9852
8514
|
*/
|
|
9853
8515
|
static resolveTargets(pkg: WorkspacePackage, _root: string): Effect.Effect<ReadonlyArray<PublishTarget>, PublishTargetBindingError$1, PublishabilityDetector | FileSystem.FileSystem>;
|
|
8516
|
+
/**
|
|
8517
|
+
* True when a version carries a SemVer prerelease suffix (`1.2.0-rc.1`). Build metadata is ignored.
|
|
8518
|
+
*/
|
|
8519
|
+
static isPrerelease(version: string): boolean;
|
|
8520
|
+
/**
|
|
8521
|
+
* The npm dist-tag a version publishes under.
|
|
8522
|
+
*
|
|
8523
|
+
* @remarks
|
|
8524
|
+
* A final version is `latest`. A prerelease takes its first prerelease identifier (`beta` for
|
|
8525
|
+
* `2.0.0-beta.3`, `rc` for `2.0.0-rc.1`), or `next` when that identifier is empty or would
|
|
8526
|
+
* parse as a SemVer range (`2.0.0-0`, `2.0.0-x.1`, `2.0.0-v2.1`), since npm rejects such a
|
|
8527
|
+
* dist-tag. A `latest` identifier (`2.0.0-latest.1`) also takes `next`, so a prerelease never
|
|
8528
|
+
* becomes the version a bare install resolves. The range check is `v*` followed by digits or a
|
|
8529
|
+
* lone `x`/`X`, matching what `semver.validRange` accepts for a prerelease identifier.
|
|
8530
|
+
*/
|
|
8531
|
+
static distTagFor(version: string): string;
|
|
8532
|
+
/** Whether a target with this {@link ReleaseChannel} receives the given version. */
|
|
8533
|
+
static receives(releases: ReleaseChannel, version: string): boolean;
|
|
8534
|
+
/**
|
|
8535
|
+
* Every resolved publish target judged against a specific version: {@link SilkPublishability.resolveTargets},
|
|
8536
|
+
* each paired with its target key, its `releases` filter, whether it `receives` the version, and the dist-tag.
|
|
8537
|
+
*
|
|
8538
|
+
* @remarks
|
|
8539
|
+
* A strict superset of `resolveTargets`, which it calls first, so the private-directory filter
|
|
8540
|
+
* and the `PublishTargetBindingError` integrity check apply unchanged. The release filter runs
|
|
8541
|
+
* here rather than in the `PublishabilityDetector` layer because the kit's
|
|
8542
|
+
* `VersioningStrategy.detect` counts publishable packages through the detector, and a package
|
|
8543
|
+
* whose only target skips this version is still a publishable package.
|
|
8544
|
+
*
|
|
8545
|
+
* Each detected target is joined back to its declaration: through `dist/prod/targets.json` by
|
|
8546
|
+
* group directory and registry after the prod build, or by its placeholder directory
|
|
8547
|
+
* (`dist/prod/<id>/pkg`) against `publishConfig.targets` before it. A binding entry with no
|
|
8548
|
+
* `releases` (written by a bundler older than the field) takes the filter declared on
|
|
8549
|
+
* `publishConfig.targets[id]`, so upgrading the publisher before the bundler never widens it. A target with no keyed
|
|
8550
|
+
* declaration (the `access`/`private` fallbacks) has no filter and receives every version.
|
|
8551
|
+
* Filtered targets are returned with `receives: false`, never dropped, so a publisher reports the
|
|
8552
|
+
* skip from the same join it publishes from. A result with no `receives: true` entry means this
|
|
8553
|
+
* version publishes nowhere, which is not an error. A declared `releases` that is not a known
|
|
8554
|
+
* channel fails with `ReleaseChannelError` rather than defaulting, since both sources are
|
|
8555
|
+
* read from disk and may have been edited by hand.
|
|
8556
|
+
*/
|
|
8557
|
+
static resolveReleaseTargets(pkg: WorkspacePackage, version: string): Effect.Effect<ReadonlyArray<ReleaseTarget>, PublishTargetBindingError$1 | ReleaseChannelError$1, PublishabilityDetector | FileSystem.FileSystem>;
|
|
9854
8558
|
/**
|
|
9855
8559
|
* The publishable, non-ignored packages, resolved through the single
|
|
9856
8560
|
* {@link SilkPublishability} (which already honors changeset ignore in adaptive mode).
|
|
@@ -9896,8 +8600,6 @@ export declare class SilkPublishability {
|
|
|
9896
8600
|
* @public
|
|
9897
8601
|
*/
|
|
9898
8602
|
export declare const readTargetsBinding: (fs: FileSystem.FileSystem, pkgPath: string) => Effect.Effect<TargetsBinding | null>;
|
|
9899
|
-
//#endregion
|
|
9900
|
-
//#region src/services/SilkWorkspaceAnalyzer.d.ts
|
|
9901
8603
|
/**
|
|
9902
8604
|
* The {@link SilkWorkspaceAnalyzer} service shape.
|
|
9903
8605
|
*
|
|
@@ -9960,8 +8662,6 @@ export declare class SilkWorkspaceAnalyzer extends SilkWorkspaceAnalyzer_base {
|
|
|
9960
8662
|
*/
|
|
9961
8663
|
static readonly layer: Layer.Layer<SilkWorkspaceAnalyzer, never, FileSystem.FileSystem | WorkspaceDiscovery | PackageManagerDetector | ChangesetConfigReader>;
|
|
9962
8664
|
}
|
|
9963
|
-
//#endregion
|
|
9964
|
-
//#region src/turbo/schemas/DryRun.d.ts
|
|
9965
8665
|
/** turbo's per-target cache descriptor in `--dry=json`. */
|
|
9966
8666
|
declare const TurboCache: Schema.Struct<{
|
|
9967
8667
|
readonly local: Schema.Boolean;
|
|
@@ -10069,8 +8769,6 @@ declare const TurboDryRun: Schema.Struct<{
|
|
|
10069
8769
|
}>;
|
|
10070
8770
|
type TurboDryRunType = Schema.Schema.Type<typeof TurboDryRun>;
|
|
10071
8771
|
type TurboDryTaskType = Schema.Schema.Type<typeof TurboDryTask>;
|
|
10072
|
-
//#endregion
|
|
10073
|
-
//#region src/turbo/schemas/results.d.ts
|
|
10074
8772
|
/** Per-package cache outcome for one task. */
|
|
10075
8773
|
declare const PackageCacheStatus: Schema.Struct<{
|
|
10076
8774
|
readonly package: Schema.String;
|
|
@@ -10153,8 +8851,6 @@ declare const AffectedResult: Schema.Struct<{
|
|
|
10153
8851
|
type CacheDiagnosisType = Schema.Schema.Type<typeof CacheDiagnosis>;
|
|
10154
8852
|
type TaskGraphResultType = Schema.Schema.Type<typeof TaskGraphResult>;
|
|
10155
8853
|
type AffectedResultType = Schema.Schema.Type<typeof AffectedResult>;
|
|
10156
|
-
//#endregion
|
|
10157
|
-
//#region src/turbo/digest.d.ts
|
|
10158
8854
|
/**
|
|
10159
8855
|
* Pure transforms from decoded turbo dry-run JSON to digested result shapes.
|
|
10160
8856
|
* No dependency injection — directly unit-testable.
|
|
@@ -10186,8 +8882,6 @@ declare class TurboDigest {
|
|
|
10186
8882
|
*/
|
|
10187
8883
|
static affected(base: string, changedFiles: readonly string[], dry: TurboDryRunType): AffectedResultType;
|
|
10188
8884
|
}
|
|
10189
|
-
//#endregion
|
|
10190
|
-
//#region src/turbo/errors.d.ts
|
|
10191
8885
|
declare const TurboNotInstalledError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
10192
8886
|
readonly _tag: "TurboNotInstalledError";
|
|
10193
8887
|
} & Readonly<A>;
|
|
@@ -10250,8 +8944,6 @@ declare class TurboExecError extends TurboExecError_base<{
|
|
|
10250
8944
|
* @since 0.7.0
|
|
10251
8945
|
*/
|
|
10252
8946
|
type TurboError = TurboNotInstalledError | NotATurboRepoError | DryRunParseError | TurboExecError;
|
|
10253
|
-
//#endregion
|
|
10254
|
-
//#region src/turbo/services/TurboInspector.d.ts
|
|
10255
8947
|
/**
|
|
10256
8948
|
* The {@link TurboInspector} service shape.
|
|
10257
8949
|
*
|
|
@@ -10315,6 +9007,5 @@ declare class TurboInspector extends TurboInspector_base {
|
|
|
10315
9007
|
declare namespace index_d_exports$4 {
|
|
10316
9008
|
export { AffectedResult, AffectedResultType, CacheDiagnosis, CacheDiagnosisType, DryRunParseError, GlobalHashSummary, GraphNode, MissExplanation, NotATurboRepoError, PackageCacheStatus, TaskGraphResult, TaskGraphResultType, TurboCache, TurboDigest, TurboDryRun, TurboDryRunType, TurboDryTask, TurboDryTaskType, TurboEnvVars, TurboError, TurboExecError, TurboGlobalCacheInputs, TurboInspector, TurboInspectorShape, TurboNotInstalledError };
|
|
10317
9009
|
}
|
|
10318
|
-
|
|
10319
|
-
export { AnalyzedWorkspace, type BiomeSchemaSyncShape, BiomeSyncError, type BiomeSyncOptions, type BiomeSyncResult, ChangesetConfigError, type ChangesetConfigFile, type ChangesetConfigReaderShape, type ChangesetConfigShape, type ChangesetMode, index_d_exports as Changesets, index_d_exports$1 as Commitlint, type CommitlintPlugin, type CommitlintUserConfig, type ConfigDiscoveryOptions, type ConfigDiscoveryShape, type ConfigLocation, ConfigNotFoundError, type ConfigSource, LIFECYCLE_SCRIPTS_CONFIG_KEY, index_d_exports$2 as Lint, PrBody, type PromptConfig, type PromptSettings, PublishTargetBindingError, type PublishablePackage, type RawPackageJson, type RawPublishConfig, type RawPublishTargets, type RawTargetObject, type RawTargetValue, index_d_exports$3 as Repos, type RuleApplicability, type RuleConfigTuple, type RuleSeverity, type RulesConfig, SavvyBaseSection, SavvyHooksSection, type SavvyInstallHook, SavvyInstallSection, SavvyOkfSection, SavvyToolchainSection, type SilkChangesetConfigFile, SilkPublishConfig, type SilkWorkspaceAnalyzerShape, type TargetBinding, type TargetGroupBinding, type TargetsBinding, index_d_exports$4 as Turbo, WorkspaceAnalysis, WorkspaceAnalysisError, publishesBuiltLinkDirectory, savvyBasePreamble, savvyHooksHygiene, savvyInstallBlock, savvyInstallDeps, savvyOkfBlock, savvyOkfSync, savvyToolSection, savvyToolchainCheck };
|
|
9010
|
+
export { AnalyzedWorkspace, type BiomeSchemaSyncShape, BiomeSyncError, type BiomeSyncOptions, type BiomeSyncResult, ChangesetConfigError, type ChangesetConfigFile, type ChangesetConfigReaderShape, type ChangesetConfigShape, type ChangesetMode, index_d_exports as Changesets, index_d_exports$1 as Commitlint, type CommitlintPlugin, type CommitlintUserConfig, type ConfigDiscoveryOptions, type ConfigDiscoveryShape, type ConfigLocation, ConfigNotFoundError, type ConfigSource, LIFECYCLE_SCRIPTS_CONFIG_KEY, index_d_exports$2 as Lint, PrBody, type PromptConfig, type PromptSettings, PublishTargetBindingError, type PublishablePackage, type RawPackageJson, type RawPublishConfig, type RawPublishTargets, type RawTargetObject, type RawTargetValue, type ReleaseChannel, ReleaseChannelError, type ReleaseTarget, index_d_exports$3 as Repos, type RuleApplicability, type RuleConfigTuple, type RuleSeverity, type RulesConfig, SavvyBaseSection, SavvyHooksSection, type SavvyInstallHook, SavvyInstallSection, SavvyOkfSection, SavvyToolchainSection, type SilkChangesetConfigFile, SilkPublishConfig, type SilkWorkspaceAnalyzerShape, type TargetBinding, type TargetGroupBinding, type TargetsBinding, index_d_exports$4 as Turbo, WorkspaceAnalysis, WorkspaceAnalysisError, publishesBuiltLinkDirectory, savvyBasePreamble, savvyHooksHygiene, savvyInstallBlock, savvyInstallDeps, savvyOkfBlock, savvyOkfSync, savvyToolSection, savvyToolchainCheck };
|
|
10320
9011
|
//# sourceMappingURL=index.d.ts.map
|