@qlover/fe-release 1.0.8 → 1.0.10

package/dist/index.d.ts

@@ -3,81 +3,6 @@ import { AsyncExecutor, ExecutorContext, ExecutorPlugin, Logger } from '@qlover/
 import { Env } from '@qlover/env-loader';
 import { OptionValues } from 'commander';
 
-interface InitOptions {
-    token?: string;
-    repoName?: string;
-    authorName?: string;
-}
-interface PullRequestInterface {
-    init(params: InitOptions): Promise<unknown>;
-    mergePullRequest(params: unknown): Promise<unknown>;
-    /**
-     *
-     * @param params
-     */
-    getPullRequest(params: {
-        pull_number: number;
-    }): Promise<unknown>;
-    deleteBranch(params: unknown): Promise<unknown>;
-    addPullRequestLabels(params: unknown): Promise<unknown>;
-    createPullRequestLabel(params: unknown): Promise<unknown>;
-    createPullRequest(params: unknown): Promise<{
-        /**
-         * pr number
-         */
-        number: number;
-        [key: string]: unknown;
-    }>;
-}
-
-interface ReleaseItProps extends ReleaseItInstanceOptions {
-    /**
-     * Receive the `release-it` instance
-     */
-    releaseIt: ReleaseItInstanceType;
-}
-type ReleaseItInstanceType = (options: ReleaseItInstanceOptions) => Promise<ReleaseItInstanceResult>;
-type ReleaseItInstanceOptions = Record<string, unknown>;
-type ReleaseItInstanceResult = {
-    changelog: string;
-    version: string;
-};
-declare class ReleaseIt {
-    private context;
-    private releaseItInstance;
-    private templateOptions;
-    private templateJson;
-    private lastPath;
-    constructor(context: ReleaseContext, props?: ReleaseItProps);
-    /**
-     * Run release-it in the publish path
-     *
-     * Because `release-it` only support signle publish path,
-     * so we need to change the current working directory to the publish path.
-     *
-     * @note This method will change the current working directory to the publish path.
-     * @param options - The options for the release-it process.
-     * @returns The output from the release-it process.
-     */
-    run(options?: ReleaseItInstanceOptions): Promise<ReleaseItInstanceResult>;
-    getOptions(context?: SharedReleaseOptions, mergeOptions?: Partial<ReleaseItInstanceOptions>): ReleaseItInstanceOptions;
-    publishNpm(): Promise<ReleaseItInstanceResult>;
-    createChangelog(): Promise<ReleaseItInstanceResult>;
-}
-
-interface PublishNpmProps {
-    npmToken?: string;
-    /**
-     * Whether to skip setting the npmrc file
-     *
-     * @default `false`
-     */
-    skipNpmrc?: boolean;
-}
-
-type ConstructorType<T, Args extends unknown[]> = (new (...args: Args) => T) | ((...args: Args) => T);
-declare function factory<T, Args extends unknown[]>(Constructor: ConstructorType<T, Args>, ...args: Args): T;
-
 declare class ReleaseTask {
     private executor;
     private defaultTuples;
@@ -133,6 +58,14 @@ interface WorkspaceValue {
      * The package.json of the workspace
      */
     packageJson: PackageJson;
+    /**
+     * The tag name of the workspace
+     */
+    tagName?: string;
+    /**
+     * The changelog of the workspace
+     */
+    changelog?: string;
 }
 
 type ReleaseParamsConfig = {
@@ -176,23 +109,88 @@ type ReleaseParamsConfig = {
     PRBody?: string;
 };
 
-interface ReleasePullRequestProps extends ReleaseParamsConfig {
+interface GitBaseProps {
     /**
-     * The increment of the release
+     * The token for the GitHub API
      *
-     * @default `patch`
+     * @default `GITHUB_TOKEN`
      */
-    increment: string;
+    tokenRef?: string;
     /**
-     * Whether to dry run the creation of the pull request
+     * The timeout for the GitHub API
+     */
+    timeout?: number;
+}
+
+interface GithubPRProps extends ReleaseParamsConfig, GitBaseProps {
+    /**
+     * The command to run before the release
+     *
+     * @default `pnpm dlx`
+     */
+    commandPrefix?: string;
+    /**
+     * Whether to publish a PR
      *
      * @default `false`
      */
-    dryRunCreatePR?: boolean;
+    releasePR?: boolean;
+    /**
+     * The commit message of the release
+     *
+     * support WorkspaceValue
+     *
+     * @default 'chore(tag): {{name}} v${version}'
+     */
+    commitMessage?: string;
     /**
-     * The pull request interface
+     * The commit args of the release
+     *
+     * @default []
+     */
+    commitArgs?: string[];
+    /**
+     * The release name of the release
+     *
+     * @default 'Release ${name} v${version}'
+     */
+    releaseName?: string;
+    /**
+     * Whether to create a draft release
+     *
+     * @default false
+     */
+    draft?: boolean;
+    /**
+     * Whether to create a pre-release
+     *
+     * @default false
+     */
+    preRelease?: boolean;
+    /**
+     * Whether to auto-generate the release notes
+     *
+     * @default false
+     */
+    autoGenerate?: boolean;
+    /**
+     * Whether to make the latest release
+     *
+     * @default true
+     */
+    makeLatest?: boolean | 'true' | 'false' | 'legacy';
+    /**
+     * The release notes of the release
+     *
+     * @default undefined
+     */
+    releaseNotes?: string;
+    /**
+     * The discussion category name of the release
+     *
+     * @default undefined
      */
-    pullRequestInterface: ConstructorType<PullRequestInterface, [ReleaseContext]>;
+    discussionCategoryName?: string;
 }
 
 interface ExecutorReleaseContext extends ExecutorContext<ReleaseContext> {
@@ -206,9 +204,7 @@ type DeepPartial<T> = {
     [P in keyof T]?: DeepPartial<T[P]>;
 };
 interface ReleaseConfig {
-    publishNpm?: PublishNpmProps;
-    githubPR?: ReleasePullRequestProps;
-    releaseIt: ReleaseItProps;
+    githubPR?: GithubPRProps;
     workspaces?: WorkspacesProps;
 }
 interface ReleaseContextOptions<T extends ReleaseConfig = ReleaseConfig> extends Omit<FeScriptContextOptions<T>, 'constructor'> {
@@ -216,6 +212,7 @@ interface ReleaseContextOptions<T extends ReleaseConfig = ReleaseConfig> extends
 }
 type StepOption<T> = {
     label: string;
+    enabled?: boolean;
     task: () => Promise<T>;
 };
 type PackageJson = Record<string, unknown>;
@@ -242,7 +239,7 @@ declare abstract class Plugin<Props = unknown> implements ExecutorPlugin<Release
     get shell(): Shell;
     get options(): Props;
     getEnv(key: string, defaultValue?: string): string | undefined;
-    enabled(): boolean;
+    enabled(_name: string, _context: ExecutorReleaseContext): boolean;
     getConfig<T>(keys?: string | string[], defaultValue?: T): T;
     setConfig(config: DeepPartial<Props>): void;
     onBefore?(_context: ExecutorReleaseContext): void | Promise<void>;
@@ -276,6 +273,11 @@ type PluginTuple<T extends PluginClass> = [
 ];
 declare function tuple<T extends PluginClass>(plugin: T | string, ...args: PluginConstructorParams<T>): PluginTuple<T>;
 
+/**
+ * This is the shared options for the release.
+ *
+ * extends `FeReleaseConfig`
+ */
 interface SharedReleaseOptions extends FeReleaseConfig {
     /**
      * The source branch of the project
@@ -302,45 +304,39 @@ interface SharedReleaseOptions extends FeReleaseConfig {
      * @default `process.cwd()`
      */
     rootPath?: string;
-    /**
-     * Whether to publish a PR
-     *
-     * @default `false`
-     */
-    releasePR?: boolean;
     /**
      * Plugins
      */
     plugins?: PluginTuple<PluginClass<unknown[]>>[];
+    /**
+     * The name of the repository
+     */
     repoName?: string;
+    /**
+     * The name of the author
+     */
     authorName?: string;
-    currentBranch?: string;
     /**
-     * Merge publish?
-     *
-     * If true, the PR will be created for all workspaces, instead of creating one PR per workspace.
-     *
-     * @default `false`
+     * The current branch of the project
      */
-    mergePublish?: boolean;
+    currentBranch?: string;
 }
 
 declare class ReleaseContext<T extends ReleaseConfig = ReleaseConfig> extends FeScriptContext<T> {
     protected readonly _env: Env;
-    readonly releaseIt: ReleaseIt;
     /**
      * Shared Config
      */
     shared: SharedReleaseOptions;
     constructor(context: ReleaseContextOptions<T>);
     private getDefaultShreadOptions;
-    get releasePR(): boolean;
     get rootPath(): string;
     get sourceBranch(): string;
     get releaseEnv(): string;
     get env(): Env;
     get workspaces(): WorkspaceValue[] | undefined;
     get workspace(): WorkspaceValue | undefined;
+    setWorkspaces(workspaces: WorkspaceValue[]): void;
     setConfig(config: DeepPartial<ReleaseConfig>): void;
     getConfig<T = unknown>(key: string | string[], defaultValue?: T): T;
     setShared(shared: Partial<SharedReleaseOptions>): void;
@@ -372,7 +368,10 @@ declare class ReleaseLabel {
 declare function load<T>(pluginName: string): Promise<[string, T]>;
 declare function loaderPluginsFromPluginTuples<T extends Plugin<unknown>>(context: ReleaseContext, pluginsTuples: PluginTuple<PluginClass>[], maxLimit?: number): Promise<T[]>;
 
+type ConstructorType<T, Args extends unknown[]> = (new (...args: Args) => T) | ((...args: Args) => T);
+declare function factory<T, Args extends unknown[]>(Constructor: ConstructorType<T, Args>, ...args: Args): T;
+
 declare function reduceOptions(opts: OptionValues, commonKey?: string): OptionValues;
 
 export { Plugin, ReleaseContext, ReleaseLabel, ReleaseTask, factory, load, loaderPluginsFromPluginTuples, reduceOptions, tuple };
-export type { ConstructorType, DeepPartial, ExecutorReleaseContext, InitOptions, PackageJson, PluginClass, PluginConstructorParams, PluginTuple, PullRequestInterface, ReleaseConfig, ReleaseContextOptions, ReleaseLabelCompare, ReleaseLabelOptions, ReleaseReturnValue, StepOption, TemplateContext };
+export type { ConstructorType, DeepPartial, ExecutorReleaseContext, PackageJson, PluginClass, PluginConstructorParams, PluginTuple, ReleaseConfig, ReleaseContextOptions, ReleaseLabelCompare, ReleaseLabelOptions, ReleaseReturnValue, StepOption, TemplateContext };