@savvy-web/silk 1.3.9 → 1.3.11
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/changesets-changelog.cjs +9204 -685
- package/changesets-changelog.d.cts +120 -29
- package/changesets-changelog.d.ts +120 -29
- package/changesets-markdownlint.cjs +9204 -685
- package/changesets-markdownlint.d.cts +120 -29
- package/changesets-markdownlint.d.ts +120 -29
- package/package.json +11 -11
- package/packages/silk-effects/dist/dev/pkg/changesets/api/transformer.cjs +24 -30
- package/packages/silk-effects/dist/dev/pkg/changesets/api/transformer.js +24 -30
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/formatting.cjs +4 -10
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/formatting.js +4 -10
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/getDependencyReleaseLine.cjs +13 -9
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/getDependencyReleaseLine.js +13 -9
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/getReleaseLine.cjs +8 -8
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/getReleaseLine.js +8 -8
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/index.cjs +1 -1
- package/packages/silk-effects/dist/dev/pkg/changesets/changelog/index.js +1 -1
- package/packages/silk-effects/dist/dev/pkg/changesets/index.cjs +12 -2
- package/packages/silk-effects/dist/dev/pkg/changesets/index.js +9 -3
- package/packages/silk-effects/dist/dev/pkg/changesets/remark/plugins/deduplicate-items.cjs +11 -9
- package/packages/silk-effects/dist/dev/pkg/changesets/remark/plugins/deduplicate-items.js +11 -9
- package/packages/silk-effects/dist/dev/pkg/changesets/remark/plugins/maintenance-note.cjs +61 -0
- package/packages/silk-effects/dist/dev/pkg/changesets/remark/plugins/maintenance-note.js +61 -0
- package/packages/silk-effects/dist/dev/pkg/changesets/remark/presets.cjs +1 -1
- package/packages/silk-effects/dist/dev/pkg/changesets/remark/presets.js +1 -1
- package/packages/silk-effects/dist/dev/pkg/changesets/services/maintenance-reason.cjs +68 -0
- package/packages/silk-effects/dist/dev/pkg/changesets/services/maintenance-reason.js +66 -0
- package/packages/silk-effects/dist/dev/pkg/changesets/services/release-planner.cjs +75 -16
- package/packages/silk-effects/dist/dev/pkg/changesets/services/release-planner.js +76 -17
- package/tsconfig/node/dist/tsconfig.tsbuildinfo +1 -1
|
@@ -4799,6 +4799,37 @@ type PackageJSON = {
|
|
|
4799
4799
|
registry?: string;
|
|
4800
4800
|
};
|
|
4801
4801
|
};
|
|
4802
|
+
type PackageGroup = ReadonlyArray<string>;
|
|
4803
|
+
type Fixed = ReadonlyArray<PackageGroup>;
|
|
4804
|
+
type Linked = ReadonlyArray<PackageGroup>;
|
|
4805
|
+
interface PrivatePackages {
|
|
4806
|
+
version: boolean;
|
|
4807
|
+
tag: boolean;
|
|
4808
|
+
}
|
|
4809
|
+
type Config = {
|
|
4810
|
+
changelog: false | readonly [string, any];
|
|
4811
|
+
commit: false | readonly [string, any];
|
|
4812
|
+
fixed: Fixed;
|
|
4813
|
+
linked: Linked;
|
|
4814
|
+
access: AccessType;
|
|
4815
|
+
baseBranch: string;
|
|
4816
|
+
changedFilePatterns: readonly string[]; /** When false, Changesets won't format with Prettier */
|
|
4817
|
+
prettier: boolean; /** Features enabled for Private packages */
|
|
4818
|
+
privatePackages: PrivatePackages; /** The minimum bump type to trigger automatic update of internal dependencies that are part of the same release */
|
|
4819
|
+
updateInternalDependencies: "patch" | "minor";
|
|
4820
|
+
ignore: ReadonlyArray<string>; /** This is supposed to be used with pnpm's `link-workspace-packages: false` and Berry's `enableTransparentWorkspaces: false` */
|
|
4821
|
+
bumpVersionsWithWorkspaceProtocolOnly?: boolean;
|
|
4822
|
+
___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: Omit<Required<ExperimentalOptions>, "useCalculatedVersionForSnapshots">;
|
|
4823
|
+
snapshot: {
|
|
4824
|
+
useCalculatedVersion: boolean;
|
|
4825
|
+
prereleaseTemplate: string | null;
|
|
4826
|
+
};
|
|
4827
|
+
};
|
|
4828
|
+
type ExperimentalOptions = {
|
|
4829
|
+
onlyUpdatePeerDependentsWhenOutOfRange?: boolean;
|
|
4830
|
+
updateInternalDependents?: "always" | "out-of-range"; /** @deprecated Since snapshot feature is now stable, you should migrate to use "snapshot.useCalculatedVersion". */
|
|
4831
|
+
useCalculatedVersionForSnapshots?: boolean;
|
|
4832
|
+
};
|
|
4802
4833
|
type NewChangesetWithCommit = NewChangeset & {
|
|
4803
4834
|
commit?: string;
|
|
4804
4835
|
};
|
|
@@ -6508,37 +6539,93 @@ declare class ChangesetLinter {
|
|
|
6508
6539
|
*/
|
|
6509
6540
|
static validate(dir: string): LintMessage[];
|
|
6510
6541
|
} //#endregion
|
|
6511
|
-
//#region src/changesets/
|
|
6542
|
+
//#region src/changesets/services/maintenance-reason.d.ts
|
|
6512
6543
|
/**
|
|
6513
|
-
*
|
|
6544
|
+
* A group co-member whose own changesets forced this release.
|
|
6514
6545
|
*
|
|
6515
|
-
*
|
|
6516
|
-
|
|
6517
|
-
|
|
6546
|
+
* @public
|
|
6547
|
+
*/
|
|
6548
|
+
declare const MaintenanceTriggerSchema: Schema.Struct<{
|
|
6549
|
+
/** Package name of the triggering co-member. */name: typeof Schema.String; /** The co-member's new version in the same release plan. */
|
|
6550
|
+
version: typeof Schema.String;
|
|
6551
|
+
}>;
|
|
6552
|
+
/**
|
|
6553
|
+
* A group co-member whose own changesets forced this release.
|
|
6518
6554
|
*
|
|
6519
|
-
* @
|
|
6555
|
+
* @public
|
|
6556
|
+
*/
|
|
6557
|
+
type MaintenanceTrigger = typeof MaintenanceTriggerSchema.Type;
|
|
6558
|
+
/**
|
|
6559
|
+
* Why a package is releasing with no changesets of its own.
|
|
6560
|
+
*
|
|
6561
|
+
* @public
|
|
6562
|
+
*/
|
|
6563
|
+
declare const MaintenanceReasonSchema: Schema.Struct<{
|
|
6564
|
+
/** Coupling that forced the release; `"unspecified"` when undetermined. */kind: Schema.Literal<["fixed", "linked", "unspecified"]>; /** Triggering co-members; empty for `"unspecified"`. */
|
|
6565
|
+
triggers: Schema.Array$<Schema.Struct<{
|
|
6566
|
+
/** Package name of the triggering co-member. */name: typeof Schema.String; /** The co-member's new version in the same release plan. */
|
|
6567
|
+
version: typeof Schema.String;
|
|
6568
|
+
}>>;
|
|
6569
|
+
}>;
|
|
6570
|
+
/**
|
|
6571
|
+
* Why a package is releasing with no changesets of its own.
|
|
6572
|
+
*
|
|
6573
|
+
* @public
|
|
6520
6574
|
*/
|
|
6575
|
+
type MaintenanceReason = typeof MaintenanceReasonSchema.Type;
|
|
6576
|
+
/**
|
|
6577
|
+
* Derive the {@link MaintenanceReason} for a release, or `undefined` when the
|
|
6578
|
+
* release has its own changesets (not a maintenance release).
|
|
6579
|
+
*
|
|
6580
|
+
* @param release - The release to classify.
|
|
6581
|
+
* @param plan - The full release plan (source of group co-members).
|
|
6582
|
+
* @param config - Resolved changesets config (`fixed` / `linked` groups).
|
|
6583
|
+
* @returns The reason, or `undefined` for releases with their own changesets.
|
|
6584
|
+
*
|
|
6585
|
+
* @remarks
|
|
6586
|
+
* Group entries are matched with {@link ChangesetConfig.matches} — exact names
|
|
6587
|
+
* and trailing `"@scope/*"` prefixes only, a subset of the micromatch globs
|
|
6588
|
+
* changesets accepts. A group entry using richer glob syntax (e.g. `"pkg-*"`)
|
|
6589
|
+
* will not match here; the release then degrades gracefully to the
|
|
6590
|
+
* `"unspecified"` fallback sentence instead of naming its triggers.
|
|
6591
|
+
*
|
|
6592
|
+
* @public
|
|
6593
|
+
*/
|
|
6594
|
+
declare function deriveMaintenanceReason(release: ComprehensiveRelease, plan: ReleasePlan, config: Config): MaintenanceReason | undefined; //#endregion
|
|
6595
|
+
//#region src/changesets/remark/plugins/maintenance-note.d.ts
|
|
6596
|
+
/**
|
|
6597
|
+
* Options for {@link MaintenanceNotePlugin}.
|
|
6598
|
+
*
|
|
6599
|
+
* @public
|
|
6600
|
+
*/
|
|
6601
|
+
interface MaintenanceNoteOptions {
|
|
6602
|
+
/** Version heading text to target (e.g. `"2.3.1"`). */
|
|
6603
|
+
readonly version: string;
|
|
6604
|
+
/** Why the package released with no changesets of its own. */
|
|
6605
|
+
readonly reason: MaintenanceReason;
|
|
6606
|
+
}
|
|
6607
|
+
declare const MaintenanceNotePlugin: Plugin$1<[MaintenanceNoteOptions], Root>; //#endregion
|
|
6608
|
+
//#region src/changesets/api/transformer.d.ts
|
|
6609
|
+
/**
|
|
6610
|
+
* Optional per-file behavior for {@link ChangelogTransformer}.
|
|
6611
|
+
*
|
|
6612
|
+
* @public
|
|
6613
|
+
*/
|
|
6614
|
+
interface TransformOptions {
|
|
6615
|
+
/** Insert a Maintenance note into this version block when it ends up empty. */
|
|
6616
|
+
readonly maintenance?: MaintenanceNoteOptions;
|
|
6617
|
+
}
|
|
6521
6618
|
/**
|
|
6522
6619
|
* Static class for post-processing CHANGELOG.md files.
|
|
6523
6620
|
*
|
|
6524
6621
|
* Implements the third layer of the three-layer pipeline by running
|
|
6525
|
-
*
|
|
6526
|
-
* and enhance changelog output produced
|
|
6622
|
+
* the {@link SilkChangesetTransformPreset} plugins (currently seven) in a
|
|
6623
|
+
* fixed order to clean up, normalize, and enhance changelog output produced
|
|
6624
|
+
* by the formatter layer.
|
|
6527
6625
|
*
|
|
6528
6626
|
* @remarks
|
|
6529
|
-
*
|
|
6530
|
-
*
|
|
6531
|
-
* 1. **MergeSectionsPlugin** -- merges duplicate section headings (e.g., two
|
|
6532
|
-
* "Features" sections from separate changesets are combined into one)
|
|
6533
|
-
* 2. **ReorderSectionsPlugin** -- reorders sections by category priority
|
|
6534
|
-
* (Breaking Changes first, Other last) using the {@link Categories} priority values
|
|
6535
|
-
* 3. **DeduplicateItemsPlugin** -- removes duplicate list items within a section
|
|
6536
|
-
* 4. **ContributorFootnotesPlugin** -- converts inline contributor mentions
|
|
6537
|
-
* into footnote references for cleaner formatting
|
|
6538
|
-
* 5. **IssueLinkRefsPlugin** -- converts inline issue/PR links into markdown
|
|
6539
|
-
* reference-style links collected at the bottom of the document
|
|
6540
|
-
* 6. **NormalizeFormatPlugin** -- applies consistent formatting (spacing,
|
|
6541
|
-
* trailing newlines, heading levels)
|
|
6627
|
+
* See {@link SilkChangesetTransformPreset} for the ordered plugin list and
|
|
6628
|
+
* the rationale behind each plugin's position.
|
|
6542
6629
|
*
|
|
6543
6630
|
* The transformer operates on the full CHANGELOG.md content (all versions),
|
|
6544
6631
|
* not just the latest release block. It is idempotent -- running it multiple
|
|
@@ -6597,19 +6684,22 @@ declare class ChangesetLinter {
|
|
|
6597
6684
|
declare class ChangelogTransformer {
|
|
6598
6685
|
private constructor();
|
|
6599
6686
|
/**
|
|
6600
|
-
* Transform CHANGELOG markdown content by running
|
|
6687
|
+
* Transform CHANGELOG markdown content by running the
|
|
6688
|
+
* {@link SilkChangesetTransformPreset} plugins.
|
|
6601
6689
|
*
|
|
6602
6690
|
* @remarks
|
|
6603
6691
|
* The input is parsed with `remark-parse` and `remark-gfm` (for table
|
|
6604
|
-
* support), processed through
|
|
6605
|
-
* back to markdown. The operation is synchronous
|
|
6692
|
+
* support), processed through every plugin in {@link SilkChangesetTransformPreset}
|
|
6693
|
+
* in order, and stringified back to markdown. The operation is synchronous
|
|
6694
|
+
* and idempotent.
|
|
6606
6695
|
*
|
|
6607
6696
|
* @param content - Raw CHANGELOG markdown string (may contain multiple
|
|
6608
6697
|
* version blocks, GFM tables, footnotes, and reference links)
|
|
6609
|
-
* @
|
|
6610
|
-
*
|
|
6698
|
+
* @param options - Optional transformation options, including maintenance note configuration
|
|
6699
|
+
* @returns The transformed markdown string with dependency tables aggregated,
|
|
6700
|
+
* sections merged, reordered, deduplicated, and normalized
|
|
6611
6701
|
*/
|
|
6612
|
-
static transformContent(content: string): string;
|
|
6702
|
+
static transformContent(content: string, options?: TransformOptions): string;
|
|
6613
6703
|
/**
|
|
6614
6704
|
* Transform a CHANGELOG file in-place.
|
|
6615
6705
|
*
|
|
@@ -6623,8 +6713,9 @@ declare class ChangelogTransformer {
|
|
|
6623
6713
|
* when invoked without the `--dry-run` or `--check` flags.
|
|
6624
6714
|
*
|
|
6625
6715
|
* @param filePath - Absolute or relative path to the CHANGELOG.md file
|
|
6716
|
+
* @param options - Optional transformation options, including maintenance note configuration
|
|
6626
6717
|
*/
|
|
6627
|
-
static transformFile(filePath: string): void;
|
|
6718
|
+
static transformFile(filePath: string, options?: TransformOptions): void;
|
|
6628
6719
|
} //#endregion
|
|
6629
6720
|
//#region src/changesets/changelog/index.d.ts
|
|
6630
6721
|
/**
|
|
@@ -9854,7 +9945,7 @@ declare const RequiredSectionsRule: Plugin<Root, unknown>; //#endregion
|
|
|
9854
9945
|
//#region src/changesets/remark/rules/uncategorized-content.d.ts
|
|
9855
9946
|
declare const UncategorizedContentRule: Plugin<Root, unknown>;
|
|
9856
9947
|
declare namespace index_d_exports {
|
|
9857
|
-
export { AggregateDependencyTablesPlugin, AppliedRelease, AppliedReleaseEntrySchema, AppliedReleaseSchema, BranchAnalysis, BranchAnalysisSchema, BranchAnalyzer, BranchAnalyzerBase, BranchAnalyzerLive, BranchAnalyzerShape, BranchFileEntry, BranchFileEntrySchema, BumpType, BumpTypeSchema, Categories, Changelog, ChangelogService, ChangelogServiceBase, ChangelogServiceShape, ChangelogTransformer, Changeset, ChangesetIOError, ChangesetIOErrorBase, ChangesetLinter, ChangesetOptions, ChangesetOptionsSchema, ChangesetPreview, ChangesetPreviewSchema, ChangesetSchema, ChangesetSummarySchema, ChangesetValidationError, ChangesetValidationErrorBase, Classification, ClassificationReason, ClassificationReasonSchema, ClassificationSchema, CommitHashSchema, ConfigInspector, ConfigInspectorBase, ConfigInspectorLive, ConfigInspectorShape, ConfigurationError, ConfigurationErrorBase, ContentStructureRule, ContributorFootnotesPlugin, DeduplicateItemsPlugin, DependencyAction, DependencyActionSchema, DependencyTable, DependencyTableFormatRule, DependencyTableRow, DependencyTableRowSchema, DependencyTableSchema, DependencyTableType, DependencyTableTypeSchema, DependencyType, DependencyTypeSchema, DependencyUpdate, DependencyUpdateSchema, DepsRegen, DepsRegenBase, DepsRegenDefault, DepsRegenLive, DepsRegenOptions, DepsRegenShape, FileStatus, FileStatusSchema, GitError, GitErrorBase, GitHubApiError, GitHubApiErrorBase, GitHubCommitInfo, GitHubInfo, GitHubInfoSchema, GitHubLive, GitHubService, GitHubServiceBase, GitHubServiceShape, GlobSchema, HeadingHierarchyRule, InspectedConfig, InspectedConfigSchema, IssueLinkRefsPlugin, IssueNumberSchema, JsonPathSchema, LegacyVersionFileConfig, LegacyVersionFileConfigSchema, LegacyVersionFilesSchema, LintMessage, MarkdownLive, MarkdownParseError, MarkdownParseErrorBase, MarkdownService, MarkdownServiceBase, MarkdownServiceShape, ContentStructureRule$1 as MarkdownlintContentStructureRule, DependencyTableFormatRule$1 as MarkdownlintDependencyTableFormatRule, HeadingHierarchyRule$1 as MarkdownlintHeadingHierarchyRule, RequiredSectionsRule$1 as MarkdownlintRequiredSectionsRule, UncategorizedContentRule$1 as MarkdownlintUncategorizedContentRule, MergeSectionsPlugin, NonEmptyString, NormalizeFormatPlugin, PackageScope, PackageScopeSchema, PackagesRecordSchema, PendingChangeset, PendingChangesetSchema, PositiveInteger, PreviewRelease, PreviewReleaseSchema, RegenPlan, RegenResult, ReleasePlanError, ReleasePlanErrorBase, ReleasePlanner, ReleasePlannerBase, ReleasePlannerLive, ReleasePlannerShape, ReorderSectionsPlugin, RepoSchema, RequiredSectionsRule, ResolvedPackageScope, ResolvedPackageScopeSchema, ResolvedVersionFile, ResolvedVersionFileSchema, SectionCategory, SectionCategorySchema, SilkChangesetPreset, SilkChangesetTransformPreset, SilkChangesetsRules, UncategorizedContentRule, UrlOrMarkdownLinkSchema, UsernameSchema, VERSION_RE, VersionFileConfig, VersionFileConfigSchema, VersionFileError, VersionFileErrorBase, VersionFileUpdate, VersionFileUpdateRecordSchema, VersionFiles, VersionFilesSchema, VersionOrEmptySchema, VersionType, VersionTypeSchema, WorkspaceDependencyDiff, WorkspaceVersion, changelogFunctions$1 as changelogFunctions, computeWorkspaceDependencyDiffs, gitMergeBase, isPureDependencyChangeset, listPublishablePackageNames, makeBranchAnalyzerTest, makeConfigInspectorTest, makeGitHubTest, makeReleasePlannerTest, serializeDependencyTableToMarkdown };
|
|
9948
|
+
export { AggregateDependencyTablesPlugin, AppliedRelease, AppliedReleaseEntrySchema, AppliedReleaseSchema, BranchAnalysis, BranchAnalysisSchema, BranchAnalyzer, BranchAnalyzerBase, BranchAnalyzerLive, BranchAnalyzerShape, BranchFileEntry, BranchFileEntrySchema, BumpType, BumpTypeSchema, Categories, Changelog, ChangelogService, ChangelogServiceBase, ChangelogServiceShape, ChangelogTransformer, Changeset, ChangesetIOError, ChangesetIOErrorBase, ChangesetLinter, ChangesetOptions, ChangesetOptionsSchema, ChangesetPreview, ChangesetPreviewSchema, ChangesetSchema, ChangesetSummarySchema, ChangesetValidationError, ChangesetValidationErrorBase, Classification, ClassificationReason, ClassificationReasonSchema, ClassificationSchema, CommitHashSchema, ConfigInspector, ConfigInspectorBase, ConfigInspectorLive, ConfigInspectorShape, ConfigurationError, ConfigurationErrorBase, ContentStructureRule, ContributorFootnotesPlugin, DeduplicateItemsPlugin, DependencyAction, DependencyActionSchema, DependencyTable, DependencyTableFormatRule, DependencyTableRow, DependencyTableRowSchema, DependencyTableSchema, DependencyTableType, DependencyTableTypeSchema, DependencyType, DependencyTypeSchema, DependencyUpdate, DependencyUpdateSchema, DepsRegen, DepsRegenBase, DepsRegenDefault, DepsRegenLive, DepsRegenOptions, DepsRegenShape, FileStatus, FileStatusSchema, GitError, GitErrorBase, GitHubApiError, GitHubApiErrorBase, GitHubCommitInfo, GitHubInfo, GitHubInfoSchema, GitHubLive, GitHubService, GitHubServiceBase, GitHubServiceShape, GlobSchema, HeadingHierarchyRule, InspectedConfig, InspectedConfigSchema, IssueLinkRefsPlugin, IssueNumberSchema, JsonPathSchema, LegacyVersionFileConfig, LegacyVersionFileConfigSchema, LegacyVersionFilesSchema, LintMessage, MaintenanceNoteOptions, MaintenanceNotePlugin, MaintenanceReason, MaintenanceReasonSchema, MaintenanceTrigger, MaintenanceTriggerSchema, MarkdownLive, MarkdownParseError, MarkdownParseErrorBase, MarkdownService, MarkdownServiceBase, MarkdownServiceShape, ContentStructureRule$1 as MarkdownlintContentStructureRule, DependencyTableFormatRule$1 as MarkdownlintDependencyTableFormatRule, HeadingHierarchyRule$1 as MarkdownlintHeadingHierarchyRule, RequiredSectionsRule$1 as MarkdownlintRequiredSectionsRule, UncategorizedContentRule$1 as MarkdownlintUncategorizedContentRule, MergeSectionsPlugin, NonEmptyString, NormalizeFormatPlugin, PackageScope, PackageScopeSchema, PackagesRecordSchema, PendingChangeset, PendingChangesetSchema, PositiveInteger, PreviewRelease, PreviewReleaseSchema, RegenPlan, RegenResult, ReleasePlanError, ReleasePlanErrorBase, ReleasePlanner, ReleasePlannerBase, ReleasePlannerLive, ReleasePlannerShape, ReorderSectionsPlugin, RepoSchema, RequiredSectionsRule, ResolvedPackageScope, ResolvedPackageScopeSchema, ResolvedVersionFile, ResolvedVersionFileSchema, SectionCategory, SectionCategorySchema, SilkChangesetPreset, SilkChangesetTransformPreset, SilkChangesetsRules, TransformOptions, UncategorizedContentRule, UrlOrMarkdownLinkSchema, UsernameSchema, VERSION_RE, VersionFileConfig, VersionFileConfigSchema, VersionFileError, VersionFileErrorBase, VersionFileUpdate, VersionFileUpdateRecordSchema, VersionFiles, VersionFilesSchema, VersionOrEmptySchema, VersionType, VersionTypeSchema, WorkspaceDependencyDiff, WorkspaceVersion, changelogFunctions$1 as changelogFunctions, computeWorkspaceDependencyDiffs, deriveMaintenanceReason, gitMergeBase, isPureDependencyChangeset, listPublishablePackageNames, makeBranchAnalyzerTest, makeConfigInspectorTest, makeGitHubTest, makeReleasePlannerTest, serializeDependencyTableToMarkdown };
|
|
9858
9949
|
} //#endregion
|
|
9859
9950
|
//#region src/commitlint/config/schema.d.ts
|
|
9860
9951
|
/**
|
|
@@ -4799,6 +4799,37 @@ type PackageJSON = {
|
|
|
4799
4799
|
registry?: string;
|
|
4800
4800
|
};
|
|
4801
4801
|
};
|
|
4802
|
+
type PackageGroup = ReadonlyArray<string>;
|
|
4803
|
+
type Fixed = ReadonlyArray<PackageGroup>;
|
|
4804
|
+
type Linked = ReadonlyArray<PackageGroup>;
|
|
4805
|
+
interface PrivatePackages {
|
|
4806
|
+
version: boolean;
|
|
4807
|
+
tag: boolean;
|
|
4808
|
+
}
|
|
4809
|
+
type Config = {
|
|
4810
|
+
changelog: false | readonly [string, any];
|
|
4811
|
+
commit: false | readonly [string, any];
|
|
4812
|
+
fixed: Fixed;
|
|
4813
|
+
linked: Linked;
|
|
4814
|
+
access: AccessType;
|
|
4815
|
+
baseBranch: string;
|
|
4816
|
+
changedFilePatterns: readonly string[]; /** When false, Changesets won't format with Prettier */
|
|
4817
|
+
prettier: boolean; /** Features enabled for Private packages */
|
|
4818
|
+
privatePackages: PrivatePackages; /** The minimum bump type to trigger automatic update of internal dependencies that are part of the same release */
|
|
4819
|
+
updateInternalDependencies: "patch" | "minor";
|
|
4820
|
+
ignore: ReadonlyArray<string>; /** This is supposed to be used with pnpm's `link-workspace-packages: false` and Berry's `enableTransparentWorkspaces: false` */
|
|
4821
|
+
bumpVersionsWithWorkspaceProtocolOnly?: boolean;
|
|
4822
|
+
___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: Omit<Required<ExperimentalOptions>, "useCalculatedVersionForSnapshots">;
|
|
4823
|
+
snapshot: {
|
|
4824
|
+
useCalculatedVersion: boolean;
|
|
4825
|
+
prereleaseTemplate: string | null;
|
|
4826
|
+
};
|
|
4827
|
+
};
|
|
4828
|
+
type ExperimentalOptions = {
|
|
4829
|
+
onlyUpdatePeerDependentsWhenOutOfRange?: boolean;
|
|
4830
|
+
updateInternalDependents?: "always" | "out-of-range"; /** @deprecated Since snapshot feature is now stable, you should migrate to use "snapshot.useCalculatedVersion". */
|
|
4831
|
+
useCalculatedVersionForSnapshots?: boolean;
|
|
4832
|
+
};
|
|
4802
4833
|
type NewChangesetWithCommit = NewChangeset & {
|
|
4803
4834
|
commit?: string;
|
|
4804
4835
|
};
|
|
@@ -6508,37 +6539,93 @@ declare class ChangesetLinter {
|
|
|
6508
6539
|
*/
|
|
6509
6540
|
static validate(dir: string): LintMessage[];
|
|
6510
6541
|
} //#endregion
|
|
6511
|
-
//#region src/changesets/
|
|
6542
|
+
//#region src/changesets/services/maintenance-reason.d.ts
|
|
6512
6543
|
/**
|
|
6513
|
-
*
|
|
6544
|
+
* A group co-member whose own changesets forced this release.
|
|
6514
6545
|
*
|
|
6515
|
-
*
|
|
6516
|
-
|
|
6517
|
-
|
|
6546
|
+
* @public
|
|
6547
|
+
*/
|
|
6548
|
+
declare const MaintenanceTriggerSchema: Schema.Struct<{
|
|
6549
|
+
/** Package name of the triggering co-member. */name: typeof Schema.String; /** The co-member's new version in the same release plan. */
|
|
6550
|
+
version: typeof Schema.String;
|
|
6551
|
+
}>;
|
|
6552
|
+
/**
|
|
6553
|
+
* A group co-member whose own changesets forced this release.
|
|
6518
6554
|
*
|
|
6519
|
-
* @
|
|
6555
|
+
* @public
|
|
6556
|
+
*/
|
|
6557
|
+
type MaintenanceTrigger = typeof MaintenanceTriggerSchema.Type;
|
|
6558
|
+
/**
|
|
6559
|
+
* Why a package is releasing with no changesets of its own.
|
|
6560
|
+
*
|
|
6561
|
+
* @public
|
|
6562
|
+
*/
|
|
6563
|
+
declare const MaintenanceReasonSchema: Schema.Struct<{
|
|
6564
|
+
/** Coupling that forced the release; `"unspecified"` when undetermined. */kind: Schema.Literal<["fixed", "linked", "unspecified"]>; /** Triggering co-members; empty for `"unspecified"`. */
|
|
6565
|
+
triggers: Schema.Array$<Schema.Struct<{
|
|
6566
|
+
/** Package name of the triggering co-member. */name: typeof Schema.String; /** The co-member's new version in the same release plan. */
|
|
6567
|
+
version: typeof Schema.String;
|
|
6568
|
+
}>>;
|
|
6569
|
+
}>;
|
|
6570
|
+
/**
|
|
6571
|
+
* Why a package is releasing with no changesets of its own.
|
|
6572
|
+
*
|
|
6573
|
+
* @public
|
|
6520
6574
|
*/
|
|
6575
|
+
type MaintenanceReason = typeof MaintenanceReasonSchema.Type;
|
|
6576
|
+
/**
|
|
6577
|
+
* Derive the {@link MaintenanceReason} for a release, or `undefined` when the
|
|
6578
|
+
* release has its own changesets (not a maintenance release).
|
|
6579
|
+
*
|
|
6580
|
+
* @param release - The release to classify.
|
|
6581
|
+
* @param plan - The full release plan (source of group co-members).
|
|
6582
|
+
* @param config - Resolved changesets config (`fixed` / `linked` groups).
|
|
6583
|
+
* @returns The reason, or `undefined` for releases with their own changesets.
|
|
6584
|
+
*
|
|
6585
|
+
* @remarks
|
|
6586
|
+
* Group entries are matched with {@link ChangesetConfig.matches} — exact names
|
|
6587
|
+
* and trailing `"@scope/*"` prefixes only, a subset of the micromatch globs
|
|
6588
|
+
* changesets accepts. A group entry using richer glob syntax (e.g. `"pkg-*"`)
|
|
6589
|
+
* will not match here; the release then degrades gracefully to the
|
|
6590
|
+
* `"unspecified"` fallback sentence instead of naming its triggers.
|
|
6591
|
+
*
|
|
6592
|
+
* @public
|
|
6593
|
+
*/
|
|
6594
|
+
declare function deriveMaintenanceReason(release: ComprehensiveRelease, plan: ReleasePlan, config: Config): MaintenanceReason | undefined; //#endregion
|
|
6595
|
+
//#region src/changesets/remark/plugins/maintenance-note.d.ts
|
|
6596
|
+
/**
|
|
6597
|
+
* Options for {@link MaintenanceNotePlugin}.
|
|
6598
|
+
*
|
|
6599
|
+
* @public
|
|
6600
|
+
*/
|
|
6601
|
+
interface MaintenanceNoteOptions {
|
|
6602
|
+
/** Version heading text to target (e.g. `"2.3.1"`). */
|
|
6603
|
+
readonly version: string;
|
|
6604
|
+
/** Why the package released with no changesets of its own. */
|
|
6605
|
+
readonly reason: MaintenanceReason;
|
|
6606
|
+
}
|
|
6607
|
+
declare const MaintenanceNotePlugin: Plugin$1<[MaintenanceNoteOptions], Root>; //#endregion
|
|
6608
|
+
//#region src/changesets/api/transformer.d.ts
|
|
6609
|
+
/**
|
|
6610
|
+
* Optional per-file behavior for {@link ChangelogTransformer}.
|
|
6611
|
+
*
|
|
6612
|
+
* @public
|
|
6613
|
+
*/
|
|
6614
|
+
interface TransformOptions {
|
|
6615
|
+
/** Insert a Maintenance note into this version block when it ends up empty. */
|
|
6616
|
+
readonly maintenance?: MaintenanceNoteOptions;
|
|
6617
|
+
}
|
|
6521
6618
|
/**
|
|
6522
6619
|
* Static class for post-processing CHANGELOG.md files.
|
|
6523
6620
|
*
|
|
6524
6621
|
* Implements the third layer of the three-layer pipeline by running
|
|
6525
|
-
*
|
|
6526
|
-
* and enhance changelog output produced
|
|
6622
|
+
* the {@link SilkChangesetTransformPreset} plugins (currently seven) in a
|
|
6623
|
+
* fixed order to clean up, normalize, and enhance changelog output produced
|
|
6624
|
+
* by the formatter layer.
|
|
6527
6625
|
*
|
|
6528
6626
|
* @remarks
|
|
6529
|
-
*
|
|
6530
|
-
*
|
|
6531
|
-
* 1. **MergeSectionsPlugin** -- merges duplicate section headings (e.g., two
|
|
6532
|
-
* "Features" sections from separate changesets are combined into one)
|
|
6533
|
-
* 2. **ReorderSectionsPlugin** -- reorders sections by category priority
|
|
6534
|
-
* (Breaking Changes first, Other last) using the {@link Categories} priority values
|
|
6535
|
-
* 3. **DeduplicateItemsPlugin** -- removes duplicate list items within a section
|
|
6536
|
-
* 4. **ContributorFootnotesPlugin** -- converts inline contributor mentions
|
|
6537
|
-
* into footnote references for cleaner formatting
|
|
6538
|
-
* 5. **IssueLinkRefsPlugin** -- converts inline issue/PR links into markdown
|
|
6539
|
-
* reference-style links collected at the bottom of the document
|
|
6540
|
-
* 6. **NormalizeFormatPlugin** -- applies consistent formatting (spacing,
|
|
6541
|
-
* trailing newlines, heading levels)
|
|
6627
|
+
* See {@link SilkChangesetTransformPreset} for the ordered plugin list and
|
|
6628
|
+
* the rationale behind each plugin's position.
|
|
6542
6629
|
*
|
|
6543
6630
|
* The transformer operates on the full CHANGELOG.md content (all versions),
|
|
6544
6631
|
* not just the latest release block. It is idempotent -- running it multiple
|
|
@@ -6597,19 +6684,22 @@ declare class ChangesetLinter {
|
|
|
6597
6684
|
declare class ChangelogTransformer {
|
|
6598
6685
|
private constructor();
|
|
6599
6686
|
/**
|
|
6600
|
-
* Transform CHANGELOG markdown content by running
|
|
6687
|
+
* Transform CHANGELOG markdown content by running the
|
|
6688
|
+
* {@link SilkChangesetTransformPreset} plugins.
|
|
6601
6689
|
*
|
|
6602
6690
|
* @remarks
|
|
6603
6691
|
* The input is parsed with `remark-parse` and `remark-gfm` (for table
|
|
6604
|
-
* support), processed through
|
|
6605
|
-
* back to markdown. The operation is synchronous
|
|
6692
|
+
* support), processed through every plugin in {@link SilkChangesetTransformPreset}
|
|
6693
|
+
* in order, and stringified back to markdown. The operation is synchronous
|
|
6694
|
+
* and idempotent.
|
|
6606
6695
|
*
|
|
6607
6696
|
* @param content - Raw CHANGELOG markdown string (may contain multiple
|
|
6608
6697
|
* version blocks, GFM tables, footnotes, and reference links)
|
|
6609
|
-
* @
|
|
6610
|
-
*
|
|
6698
|
+
* @param options - Optional transformation options, including maintenance note configuration
|
|
6699
|
+
* @returns The transformed markdown string with dependency tables aggregated,
|
|
6700
|
+
* sections merged, reordered, deduplicated, and normalized
|
|
6611
6701
|
*/
|
|
6612
|
-
static transformContent(content: string): string;
|
|
6702
|
+
static transformContent(content: string, options?: TransformOptions): string;
|
|
6613
6703
|
/**
|
|
6614
6704
|
* Transform a CHANGELOG file in-place.
|
|
6615
6705
|
*
|
|
@@ -6623,8 +6713,9 @@ declare class ChangelogTransformer {
|
|
|
6623
6713
|
* when invoked without the `--dry-run` or `--check` flags.
|
|
6624
6714
|
*
|
|
6625
6715
|
* @param filePath - Absolute or relative path to the CHANGELOG.md file
|
|
6716
|
+
* @param options - Optional transformation options, including maintenance note configuration
|
|
6626
6717
|
*/
|
|
6627
|
-
static transformFile(filePath: string): void;
|
|
6718
|
+
static transformFile(filePath: string, options?: TransformOptions): void;
|
|
6628
6719
|
} //#endregion
|
|
6629
6720
|
//#region src/changesets/changelog/index.d.ts
|
|
6630
6721
|
/**
|
|
@@ -9854,7 +9945,7 @@ declare const RequiredSectionsRule: Plugin<Root, unknown>; //#endregion
|
|
|
9854
9945
|
//#region src/changesets/remark/rules/uncategorized-content.d.ts
|
|
9855
9946
|
declare const UncategorizedContentRule: Plugin<Root, unknown>;
|
|
9856
9947
|
declare namespace index_d_exports {
|
|
9857
|
-
export { AggregateDependencyTablesPlugin, AppliedRelease, AppliedReleaseEntrySchema, AppliedReleaseSchema, BranchAnalysis, BranchAnalysisSchema, BranchAnalyzer, BranchAnalyzerBase, BranchAnalyzerLive, BranchAnalyzerShape, BranchFileEntry, BranchFileEntrySchema, BumpType, BumpTypeSchema, Categories, Changelog, ChangelogService, ChangelogServiceBase, ChangelogServiceShape, ChangelogTransformer, Changeset, ChangesetIOError, ChangesetIOErrorBase, ChangesetLinter, ChangesetOptions, ChangesetOptionsSchema, ChangesetPreview, ChangesetPreviewSchema, ChangesetSchema, ChangesetSummarySchema, ChangesetValidationError, ChangesetValidationErrorBase, Classification, ClassificationReason, ClassificationReasonSchema, ClassificationSchema, CommitHashSchema, ConfigInspector, ConfigInspectorBase, ConfigInspectorLive, ConfigInspectorShape, ConfigurationError, ConfigurationErrorBase, ContentStructureRule, ContributorFootnotesPlugin, DeduplicateItemsPlugin, DependencyAction, DependencyActionSchema, DependencyTable, DependencyTableFormatRule, DependencyTableRow, DependencyTableRowSchema, DependencyTableSchema, DependencyTableType, DependencyTableTypeSchema, DependencyType, DependencyTypeSchema, DependencyUpdate, DependencyUpdateSchema, DepsRegen, DepsRegenBase, DepsRegenDefault, DepsRegenLive, DepsRegenOptions, DepsRegenShape, FileStatus, FileStatusSchema, GitError, GitErrorBase, GitHubApiError, GitHubApiErrorBase, GitHubCommitInfo, GitHubInfo, GitHubInfoSchema, GitHubLive, GitHubService, GitHubServiceBase, GitHubServiceShape, GlobSchema, HeadingHierarchyRule, InspectedConfig, InspectedConfigSchema, IssueLinkRefsPlugin, IssueNumberSchema, JsonPathSchema, LegacyVersionFileConfig, LegacyVersionFileConfigSchema, LegacyVersionFilesSchema, LintMessage, MarkdownLive, MarkdownParseError, MarkdownParseErrorBase, MarkdownService, MarkdownServiceBase, MarkdownServiceShape, ContentStructureRule$1 as MarkdownlintContentStructureRule, DependencyTableFormatRule$1 as MarkdownlintDependencyTableFormatRule, HeadingHierarchyRule$1 as MarkdownlintHeadingHierarchyRule, RequiredSectionsRule$1 as MarkdownlintRequiredSectionsRule, UncategorizedContentRule$1 as MarkdownlintUncategorizedContentRule, MergeSectionsPlugin, NonEmptyString, NormalizeFormatPlugin, PackageScope, PackageScopeSchema, PackagesRecordSchema, PendingChangeset, PendingChangesetSchema, PositiveInteger, PreviewRelease, PreviewReleaseSchema, RegenPlan, RegenResult, ReleasePlanError, ReleasePlanErrorBase, ReleasePlanner, ReleasePlannerBase, ReleasePlannerLive, ReleasePlannerShape, ReorderSectionsPlugin, RepoSchema, RequiredSectionsRule, ResolvedPackageScope, ResolvedPackageScopeSchema, ResolvedVersionFile, ResolvedVersionFileSchema, SectionCategory, SectionCategorySchema, SilkChangesetPreset, SilkChangesetTransformPreset, SilkChangesetsRules, UncategorizedContentRule, UrlOrMarkdownLinkSchema, UsernameSchema, VERSION_RE, VersionFileConfig, VersionFileConfigSchema, VersionFileError, VersionFileErrorBase, VersionFileUpdate, VersionFileUpdateRecordSchema, VersionFiles, VersionFilesSchema, VersionOrEmptySchema, VersionType, VersionTypeSchema, WorkspaceDependencyDiff, WorkspaceVersion, changelogFunctions$1 as changelogFunctions, computeWorkspaceDependencyDiffs, gitMergeBase, isPureDependencyChangeset, listPublishablePackageNames, makeBranchAnalyzerTest, makeConfigInspectorTest, makeGitHubTest, makeReleasePlannerTest, serializeDependencyTableToMarkdown };
|
|
9948
|
+
export { AggregateDependencyTablesPlugin, AppliedRelease, AppliedReleaseEntrySchema, AppliedReleaseSchema, BranchAnalysis, BranchAnalysisSchema, BranchAnalyzer, BranchAnalyzerBase, BranchAnalyzerLive, BranchAnalyzerShape, BranchFileEntry, BranchFileEntrySchema, BumpType, BumpTypeSchema, Categories, Changelog, ChangelogService, ChangelogServiceBase, ChangelogServiceShape, ChangelogTransformer, Changeset, ChangesetIOError, ChangesetIOErrorBase, ChangesetLinter, ChangesetOptions, ChangesetOptionsSchema, ChangesetPreview, ChangesetPreviewSchema, ChangesetSchema, ChangesetSummarySchema, ChangesetValidationError, ChangesetValidationErrorBase, Classification, ClassificationReason, ClassificationReasonSchema, ClassificationSchema, CommitHashSchema, ConfigInspector, ConfigInspectorBase, ConfigInspectorLive, ConfigInspectorShape, ConfigurationError, ConfigurationErrorBase, ContentStructureRule, ContributorFootnotesPlugin, DeduplicateItemsPlugin, DependencyAction, DependencyActionSchema, DependencyTable, DependencyTableFormatRule, DependencyTableRow, DependencyTableRowSchema, DependencyTableSchema, DependencyTableType, DependencyTableTypeSchema, DependencyType, DependencyTypeSchema, DependencyUpdate, DependencyUpdateSchema, DepsRegen, DepsRegenBase, DepsRegenDefault, DepsRegenLive, DepsRegenOptions, DepsRegenShape, FileStatus, FileStatusSchema, GitError, GitErrorBase, GitHubApiError, GitHubApiErrorBase, GitHubCommitInfo, GitHubInfo, GitHubInfoSchema, GitHubLive, GitHubService, GitHubServiceBase, GitHubServiceShape, GlobSchema, HeadingHierarchyRule, InspectedConfig, InspectedConfigSchema, IssueLinkRefsPlugin, IssueNumberSchema, JsonPathSchema, LegacyVersionFileConfig, LegacyVersionFileConfigSchema, LegacyVersionFilesSchema, LintMessage, MaintenanceNoteOptions, MaintenanceNotePlugin, MaintenanceReason, MaintenanceReasonSchema, MaintenanceTrigger, MaintenanceTriggerSchema, MarkdownLive, MarkdownParseError, MarkdownParseErrorBase, MarkdownService, MarkdownServiceBase, MarkdownServiceShape, ContentStructureRule$1 as MarkdownlintContentStructureRule, DependencyTableFormatRule$1 as MarkdownlintDependencyTableFormatRule, HeadingHierarchyRule$1 as MarkdownlintHeadingHierarchyRule, RequiredSectionsRule$1 as MarkdownlintRequiredSectionsRule, UncategorizedContentRule$1 as MarkdownlintUncategorizedContentRule, MergeSectionsPlugin, NonEmptyString, NormalizeFormatPlugin, PackageScope, PackageScopeSchema, PackagesRecordSchema, PendingChangeset, PendingChangesetSchema, PositiveInteger, PreviewRelease, PreviewReleaseSchema, RegenPlan, RegenResult, ReleasePlanError, ReleasePlanErrorBase, ReleasePlanner, ReleasePlannerBase, ReleasePlannerLive, ReleasePlannerShape, ReorderSectionsPlugin, RepoSchema, RequiredSectionsRule, ResolvedPackageScope, ResolvedPackageScopeSchema, ResolvedVersionFile, ResolvedVersionFileSchema, SectionCategory, SectionCategorySchema, SilkChangesetPreset, SilkChangesetTransformPreset, SilkChangesetsRules, TransformOptions, UncategorizedContentRule, UrlOrMarkdownLinkSchema, UsernameSchema, VERSION_RE, VersionFileConfig, VersionFileConfigSchema, VersionFileError, VersionFileErrorBase, VersionFileUpdate, VersionFileUpdateRecordSchema, VersionFiles, VersionFilesSchema, VersionOrEmptySchema, VersionType, VersionTypeSchema, WorkspaceDependencyDiff, WorkspaceVersion, changelogFunctions$1 as changelogFunctions, computeWorkspaceDependencyDiffs, deriveMaintenanceReason, gitMergeBase, isPureDependencyChangeset, listPublishablePackageNames, makeBranchAnalyzerTest, makeConfigInspectorTest, makeGitHubTest, makeReleasePlannerTest, serializeDependencyTableToMarkdown };
|
|
9858
9949
|
} //#endregion
|
|
9859
9950
|
//#region src/commitlint/config/schema.d.ts
|
|
9860
9951
|
/**
|