@absolutejs/changelog 0.1.2 → 0.3.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/dist/entries.d.ts CHANGED
@@ -8,10 +8,18 @@ export type LoadedEntries = {
8
8
  entries: LoadedEntry[];
9
9
  problems: string[];
10
10
  };
11
- /** Every declaration file a build produced, so a release can be checked
12
- * against the types it is about to publish rather than against the ones it
13
- * published last time. */
14
- export declare const builtSurface: (packageRoot: string, out?: string) => Promise<import("./surface").PackageSurface | undefined>;
11
+ /**
12
+ * The public surface a build produced, read the way a consumer would.
13
+ *
14
+ * From the entry points the manifest declares, following the export graph --
15
+ * not by heaping every declaration file together, which counts names no
16
+ * consumer can import and cannot see one being withdrawn.
17
+ *
18
+ * Nothing when the manifest's entry points are not on disk: that is a package
19
+ * about to publish types it has not built, and passing it would be the gate
20
+ * going quiet at the worst possible moment.
21
+ */
22
+ export declare const builtSurface: (packageRoot: string) => Promise<import("./surface").PackageSurface | undefined>;
15
23
  export declare const changelogPaths: (packageRoot: string) => {
16
24
  history: string;
17
25
  json: string;
@@ -19,5 +27,16 @@ export declare const changelogPaths: (packageRoot: string) => {
19
27
  unreleased: string;
20
28
  };
21
29
  /** Every pending entry, in a stable order so a release reads the same twice. */
22
- export declare const loadUnreleased: (packageRoot: string) => Promise<LoadedEntries>;
30
+ export declare const loadUnreleased: (packageRoot: string) => Promise<{
31
+ entries: LoadedEntry[];
32
+ problems: string[];
33
+ }>;
23
34
  export declare const readJsonFile: (path: string) => Promise<unknown>;
35
+ /**
36
+ * Anything in the entry directory that is not an entry.
37
+ *
38
+ * A `.md` note dropped in here, or a `.txt` somebody meant as a placeholder,
39
+ * is read by nothing and consumed by nothing -- it sits there through every
40
+ * release looking like a change that was recorded.
41
+ */
42
+ export declare const strayEntries: (packageRoot: string) => Promise<string[]>;
package/dist/index.d.ts CHANGED
@@ -3,8 +3,8 @@ export { change, manual, moved, renamed } from "./authoring";
3
3
  export { builtSurface, changelogPaths, loadUnreleased, readJsonFile, type LoadedEntries, type LoadedEntry, } from "./entries";
4
4
  export { changesBetween, disruptiveBetween, mechanicalMigrations, migrationsBetween, parseChangelog, releasesBetween, symbolsDisturbedBetween, validateChange, type ChangeAt, type ChangelogRead, type MigrationAt, } from "./read";
5
5
  export { describeReconciliation, reconcile, type Reconciliation, type Unannounced, } from "./reconcile";
6
- export { packageArchive, packageVersions, publishedChangelog, publishedSurface, type PackageVersions, type RegistryOptions, } from "./registry";
7
- export { changeShape, diffSurface, exportedDeclarations, notable, surfaceOfArchive, surfaceOfFiles, type ChangeShape, type PackageSurface, type SurfaceChange, type SurfaceDiff, } from "./surface";
6
+ export { isPackageName, packageArchive, packageVersions, publishedChangelog, publishedSurface, type PackageVersions, type RegistryOptions, } from "./registry";
7
+ export { changeShape, declaresTypes, diffSurface, notable, surfaceOfArchive, surfaceOfFiles, typeEntriesOf, type ChangeShape, type PackageSurface, type SurfaceChange, type SurfaceDiff, } from "./surface";
8
8
  export { asText, readTar, type TarLimits } from "./tarball";
9
9
  export { CHANGELOG_CONTRACT, CHANGELOG_FILE, CHANGELOG_MARKDOWN, CHANGE_KINDS, DISRUPTIVE_KINDS, isDisruptive, isMechanical, UNRELEASED_DIRECTORY, type Change, type ChangeKind, type Changelog, type DisruptiveChange, type DisruptiveKind, type Migration, type NonEmpty, type OrdinaryChange, type Release, } from "./types";
10
10
  export { compareVersions, isPrerelease, nextVersion, parseVersion, releaseKindFor, type ReleaseKind, } from "./versioning";