tegami 0.2.0 → 1.0.0-beta.0

package/dist/{types-CurHqnWl.d.ts → types-DnCUr2dB.d.ts}

@@ -1,4 +1,4 @@
-import z, { z as z$1 } from "zod";
+import z from "zod";
 import { AgentName } from "package-manager-detector";
 
 //#region src/utils/semver.d.ts
@@ -96,6 +96,7 @@ interface DraftPolicy {
 /** Package discovered in the workspace. */
 declare abstract class WorkspacePackage {
   abstract readonly name: string;
+  /** absolute path */
   abstract readonly path: string;
   abstract readonly manager: string;
   abstract readonly version: string;
@@ -158,140 +159,27 @@ interface TegamiContext {
   };
 }
 //#endregion
-//#region src/changelog/generate.d.ts
-interface GenerateFromCommitsOptions {
-  /** Start revision. Defaults to the latest reachable git tag, or all history if none exists. */
-  from?: string;
-  /** End revision. Defaults to HEAD. */
-  to?: string;
-}
-interface CommitChangelog {
-  filename: string;
-  content: string;
-  packages: Record<string, BumpType | ChangelogPackageConfig>;
-  changes: CommitChange[];
-}
-interface CommitChange {
-  hash: string;
-  subject: string;
-  body: string;
-  packages: string[];
-  type: BumpType;
-  title: string;
-}
-//#endregion
-//#region src/plans/publish.d.ts
-interface PublishPlan {
-  options: PublishOptions;
-  /** id -> entry */
-  changelogs: Map<string, ChangelogEntry>;
-  /** id -> package data. The package id will always exist in package graph, stale items will be pruned at init-time */
-  packages: Map<string, PackagePublishPlan>;
-}
-interface PackagePublishPlan {
-  changelogs: ChangelogEntry[];
-  /** whether this package was version-bumped when the lock was written */
-  updated: boolean;
-  /** generated by Git plugin */
-  git?: {
-    /** the associated Git tag of package */tag: string;
-  };
-  /** generated by npm plugin */
-  npm?: {
-    /** dist tag to use if published */distTag?: string;
-  };
-  /** publish result, generated for all packages in publish plan after publishing */
-  publishResult?: PackagePublishResult;
-  /** preflight result, generated for all packages in publish plan after preflights */
-  preflight?: PublishPreflight;
-}
-interface PublishOptions {
-  /** Validate the publish plan without publishing packages, creating tags, or running release plugins. */
-  dryRun?: boolean;
-}
-type PackagePublishResult = {
-  type: "published" | "skipped";
-} | {
-  type: "failed";
-  error: string;
-};
-//#endregion
-//#region src/plans/lock.d.ts
-/**
- * the data structure of `publish-lock.yaml` file.
- */
-declare class PublishLock {
-  /** namespace -> data array */
-  private readonly data;
-  constructor(/** namespace -> data array */
-
-  data?: Map<string, unknown[]>);
-  /** write data to namespace, note that the `data` must be serializable in yaml */
-  write(namespace: string, data: unknown): void;
-  read(namespace: string): unknown | undefined;
-  size(namespace: string): number;
-  serialize(): string;
-}
-//#endregion
-//#region src/index.d.ts
-interface GenerateChangelogOptions extends GenerateFromCommitsOptions {
-  /**
-   * Write changelog files to disk.
-   *
-   * @default true
-   */
-  write?: boolean;
-}
-interface Tegami {
-  /** Create pending changelog files from git commit history. */
-  generateChangelog(options?: GenerateChangelogOptions): Promise<CommitChangelog[]>;
-  /** Build a draft from pending changelog files. */
-  draft(): Promise<Draft>;
-  /** Publish packages from the publish lock. */
-  publish(options?: PublishOptions): Promise<PublishPlan | "skipped">;
-  /**
-   * Check publish status.
-   *
-   * Prefer `publish()` over this if you are publishing packages, it will also check the publish status.
-   */
-  publishStatus(): Promise<"pending" | "success" | "idle">;
-  /** Remove the publish lock file after publishing has finished successfully. */
-  cleanup(): Promise<{
-    state: "removed";
-  } | {
-    state: "skipped";
-    reason: "no-plan" | "pending";
-  }>;
-  /** Internal APIs, do not use it unless you know what you are doing */
-  _internal: {
-    context(): Promise<TegamiContext>;
-    graph(): Promise<PackageGraph>;
-    options: TegamiOptions;
-  };
-}
-/** Create a Tegami project handle. */
-declare function tegami<const Groups extends string = string>(options?: TegamiOptions<Groups>): Tegami;
-//#endregion
-//#region src/schemas.d.ts
-declare const packageManifestSchema: z$1.ZodObject<{
-  name: z$1.ZodString;
-  version: z$1.ZodOptional<z$1.ZodString>;
-  private: z$1.ZodOptional<z$1.ZodBoolean>;
-  publishConfig: z$1.ZodOptional<z$1.ZodObject<{
-    access: z$1.ZodOptional<z$1.ZodEnum<{
+//#region src/providers/npm/schema.d.ts
+declare const packageManifestSchema: z.ZodObject<{
+  name: z.ZodString;
+  version: z.ZodOptional<z.ZodString>;
+  private: z.ZodOptional<z.ZodBoolean>;
+  publishConfig: z.ZodOptional<z.ZodObject<{
+    access: z.ZodOptional<z.ZodEnum<{
       public: "public";
       restricted: "restricted";
     }>>;
-    registry: z$1.ZodOptional<z$1.ZodString>;
-    tag: z$1.ZodOptional<z$1.ZodString>;
-  }, z$1.core.$loose>>;
-  workspaces: z$1.ZodOptional<z$1.ZodArray<z$1.ZodString>>;
-  dependencies: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodString>>;
-  devDependencies: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodString>>;
-  peerDependencies: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodString>>;
-  optionalDependencies: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodString>>;
-}, z$1.core.$loose>;
-type PackageManifest = z$1.infer<typeof packageManifestSchema>;
+    registry: z.ZodOptional<z.ZodString>;
+    tag: z.ZodOptional<z.ZodString>;
+  }, z.core.$loose>>;
+  scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  workspaces: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  optionalDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$loose>;
+type PackageManifest = z.infer<typeof packageManifestSchema>;
 //#endregion
 //#region src/providers/npm.d.ts
 declare const DEP_FIELDS$1: readonly ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies"];
@@ -304,6 +192,7 @@ declare class NpmPackage extends WorkspacePackage {
   get version(): string;
   write(): Promise<void>;
   initDraft(): PackageDraft;
+  configureDraft(draft: PackageDraft, group?: PackageGroup): void;
 }
 type DependencySpec = {
   protocol: "npm";
@@ -330,6 +219,7 @@ interface NpmPluginOptions {
    * Decide how to bump the dependents of a bumped package.
    */
   bumpDep?: (opts: {
+    dependent: NpmPackage;
     kind: (typeof DEP_FIELDS$1)[number];
     name: string;
     spec: DependencySpec;
@@ -382,7 +272,11 @@ interface CargoPluginOptions {
    * @default true
    */
   updateLockFile?: boolean;
+  /**
+   * Decide how to bump the dependents of a bumped package.
+   */
   bumpDep?: (opts: {
+    dependent: CargoPackage;
     kind: (typeof DEP_FIELDS)[number];
     name: string;
     version: string;
@@ -393,6 +287,59 @@ declare function cargo({
   bumpDep: getBumpDepType
 }?: CargoPluginOptions): TegamiPlugin;
 //#endregion
+//#region src/plans/publish.d.ts
+interface PublishPlan {
+  options: PublishOptions;
+  /** id -> entry */
+  changelogs: Map<string, ChangelogEntry>;
+  /** id -> package data. The package id will always exist in package graph, stale items will be pruned at init-time */
+  packages: Map<string, PackagePublishPlan>;
+}
+interface PackagePublishPlan {
+  changelogs: ChangelogEntry[];
+  /** whether this package was version-bumped when the lock was written */
+  updated: boolean;
+  /** generated by Git plugin */
+  git?: {
+    /** the associated Git tag of package */tag: string;
+  };
+  /** generated by npm plugin */
+  npm?: {
+    /** dist tag to use if published */distTag?: string;
+  };
+  /** publish result, generated for all packages in publish plan after publishing */
+  publishResult?: PackagePublishResult;
+  /** preflight result, generated for all packages in publish plan after preflights */
+  preflight?: PublishPreflight;
+}
+interface PublishOptions {
+  /** Validate the publish plan without publishing packages, creating tags, or running release plugins. */
+  dryRun?: boolean;
+}
+type PackagePublishResult = {
+  type: "published" | "skipped";
+} | {
+  type: "failed";
+  error: string;
+};
+//#endregion
+//#region src/plans/lock.d.ts
+/**
+ * the data structure of `publish-lock.yaml` file.
+ */
+declare class PublishLock {
+  /** namespace -> data array */
+  private readonly data;
+  constructor(/** namespace -> data array */
+
+  data?: Map<string, unknown[]>);
+  /** write data to namespace, note that the `data` must be serializable in yaml */
+  write(namespace: string, data: unknown): void;
+  read(namespace: string): unknown | undefined;
+  size(namespace: string): number;
+  serialize(): string;
+}
+//#endregion
 //#region src/types.d.ts
 /** Generates changelog content for a package release. */
 interface LogGenerator {
@@ -411,8 +358,8 @@ interface TegamiOptions<Groups extends string = string> {
   lockPath?: string;
   /** Changelog generator used when applying a draft. */
   generator?: LogGenerator;
-  /** Per-package release and publish options keyed by package name. */
-  packages?: Record<string, PackageOptions<NoInfer<Groups>>>;
+  /** Per-package options keyed by package name or a function. */
+  packages?: Record<string, PackageOptions<NoInfer<Groups>>> | ((pkg: WorkspacePackage) => PackageOptions<NoInfer<Groups>> | undefined);
   plugins?: TegamiPluginOption[];
   groups?: Record<Groups, GroupOptions>;
   /** Package names, ids, or regex patterns to exclude from the dependency graph. */
@@ -454,7 +401,7 @@ type TegamiPluginOption = TegamiPlugin | TegamiPluginOption[];
 interface TegamiPlugin {
   name: string;
   enforce?: "pre" | "default" | "post";
-  /** when Tegami initializes */
+  /** When Tegami initializes */
   init?(this: TegamiContext): Awaitable<void>;
   /** Resolve workspace packages and dependency metadata into the shared graph. */
   resolve?(this: TegamiContext): Awaitable<void>;
@@ -494,7 +441,7 @@ interface TegamiPlugin {
   willPublish?(this: TegamiContext, opts: {
     pkg: WorkspacePackage;
   }): Awaitable<false | void | undefined>;
-  /** Called after a package is published, skipped, or failed. */
+  /** Called after a package is published successfully, or failed. */
   afterPublish?(this: TegamiContext, opts: {
     pkg: WorkspacePackage;
     plan: PublishPlan;
@@ -512,8 +459,8 @@ interface TegamiPlugin {
 }
 type Awaitable<T> = T | Promise<T>;
 interface PublishPreflight {
-  /** if the package should be published, default to `true`. */
-  publish?: boolean;
+  /** if the package should be published. */
+  publish: boolean;
   /**
    * Package ids that must be published before this one, this will automatically disallow circular dependency.
    *
@@ -522,4 +469,4 @@ interface PublishPreflight {
   wait?: string[];
 }
 //#endregion
-export { PackageDraft as A, CommitChangelog as C, WorkspacePackage as D, PackageGroup as E, Draft as O, PublishPlan as S, PackageGraph as T, tegami as _, PublishPreflight as a, PackagePublishResult as b, TegamiPluginOption as c, cargo as d, NpmPackage as f, Tegami as g, GenerateChangelogOptions as h, PackageOptions as i, DraftPolicy as k, CargoPackage as l, npm as m, GroupOptions as n, TegamiOptions as o, NpmPluginOptions as p, LogGenerator as r, TegamiPlugin as s, Awaitable as t, CargoPluginOptions as u, PublishLock as v, TegamiContext as w, PublishOptions as x, PackagePublishPlan as y };
+export { WorkspacePackage as C, ChangelogPackageConfig as D, PackageDraft as E, BumpType as O, PackageGroup as S, DraftPolicy as T, NpmPackage as _, PublishPreflight as a, TegamiContext as b, TegamiPluginOption as c, PackagePublishResult as d, PublishOptions as f, cargo as g, CargoPluginOptions as h, PackageOptions as i, PublishLock as l, CargoPackage as m, GroupOptions as n, TegamiOptions as o, PublishPlan as p, LogGenerator as r, TegamiPlugin as s, Awaitable as t, PackagePublishPlan as u, NpmPluginOptions as v, Draft as w, PackageGraph as x, npm as y };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tegami",
-  "version": "0.2.0",
+  "version": "1.0.0-beta.0",
   "description": "Utility for package versioning & publish",
   "license": "MIT",
   "author": "Fuma Nama",
@@ -18,6 +18,7 @@
     "./generators/simple": "./dist/generators/simple.js",
     "./plugins/git": "./dist/plugins/git.js",
     "./plugins/github": "./dist/plugins/github.js",
+    "./plugins/go": "./dist/plugins/go.js",
     "./providers/cargo": "./dist/providers/cargo.js",
     "./providers/npm": "./dist/providers/npm.js",
     "./package.json": "./package.json"

package/dist/schemas-B7N6EE2k.js

@@ -1,26 +0,0 @@
-import { z as z$1 } from "zod";
-//#region src/schemas.ts
-const stringRecordSchema = z$1.record(z$1.string(), z$1.string());
-const bumpTypeSchema = z$1.enum([
-	"major",
-	"minor",
-	"patch"
-]);
-const pnpmWorkspaceSchema = z$1.looseObject({ packages: z$1.array(z$1.string()).optional() });
-const packageManifestSchema = z$1.looseObject({
-	name: z$1.string(),
-	version: z$1.string().optional(),
-	private: z$1.boolean().optional(),
-	publishConfig: z$1.looseObject({
-		access: z$1.enum(["public", "restricted"]).optional(),
-		registry: z$1.string().optional(),
-		tag: z$1.string().optional()
-	}).optional(),
-	workspaces: z$1.array(z$1.string()).optional(),
-	dependencies: stringRecordSchema.optional(),
-	devDependencies: stringRecordSchema.optional(),
-	peerDependencies: stringRecordSchema.optional(),
-	optionalDependencies: stringRecordSchema.optional()
-});
-//#endregion
-export { packageManifestSchema as n, pnpmWorkspaceSchema as r, bumpTypeSchema as t };