@qlover/fe-release 2.3.4 → 3.0.0

package/dist/index.d.ts

@@ -1,22 +1,35 @@
-import { FeScriptContextOptions, Shell, FeReleaseConfig, FeScriptContext } from '@qlover/scripts-context';
-import { AsyncExecutor, ExecutorContext, ExecutorPlugin } from '@qlover/fe-corekit';
-import { LoggerInterface } from '@qlover/logger';
-import { Env } from '@qlover/env-loader';
+import { AsyncExecutor, ExecutorContext } from '@qlover/fe-corekit';
+import { ScriptPlugin, ScriptContext, ScriptPluginProps, ScriptSharedInterface, ScriptContextInterface, FeReleaseConfig, ShellInterface } from '@qlover/scripts-context';
+export { ScriptPlugin } from '@qlover/scripts-context';
 import { CommitField } from 'gitlog';
+import { LoggerInterface } from '@qlover/logger';
 import { OptionValues } from 'commander';
 
+type PluginClass<T extends unknown[] = any[]> = new (...args: T) => ScriptPlugin<ScriptContext<any>, ScriptPluginProps>;
+/**
+ * Represents the constructor parameters for a specific Plugin class, excluding the first parameter.
+ * This assumes that the constructor parameters are known and can be inferred.
+ */
+type PluginConstructorParams<T extends PluginClass> = T extends new (first: any, ...args: infer P) => unknown ? P : never;
+type PluginTuple<T extends PluginClass> = [
+    T | string,
+    ...PluginConstructorParams<T>
+];
+declare function tuple<T extends PluginClass>(plugin: T | string, ...args: PluginConstructorParams<T>): PluginTuple<T>;
+
 declare class ReleaseTask {
     private executor;
     private defaultTuples;
     protected context: ReleaseContext;
-    constructor(options?: ReleaseContextOptions, executor?: AsyncExecutor, defaultTuples?: PluginTuple<PluginClass>[]);
+    constructor(options?: Partial<ReleaseContextOptions>, executor?: AsyncExecutor, defaultTuples?: PluginTuple<PluginClass>[]);
     getContext(): ReleaseContext;
-    usePlugins(externalTuples?: PluginTuple<PluginClass>[]): Promise<Plugin[]>;
+    usePlugins(externalTuples?: PluginTuple<PluginClass>[]): Promise<ScriptPlugin<ScriptContext<any>, ScriptPluginProps>[]>;
     run(): Promise<unknown>;
     exec(externalTuples?: PluginTuple<PluginClass>[]): Promise<unknown>;
 }
 
-interface WorkspacesProps {
+type PackageJson$1 = Record<string, unknown>;
+interface WorkspacesProps extends ScriptPluginProps {
     /**
      * Whether to skip workspaces
      *
@@ -74,7 +87,7 @@ interface WorkspaceValue {
     /**
      * The package.json of the workspace
      */
-    packageJson: PackageJson;
+    packageJson: PackageJson$1;
     /**
      * The tag name of the workspace
      * @private
@@ -139,7 +152,7 @@ type ReleaseParamsConfig = {
     PRBody?: string;
 };
 
-interface GitBaseProps {
+interface GitBaseProps extends ScriptPluginProps {
     /**
      * The token for the GitHub API
      *
@@ -248,12 +261,11 @@ type ReleaseReturnValue = {
 type DeepPartial<T> = {
     [P in keyof T]?: DeepPartial<T[P]>;
 };
-interface ReleaseConfig {
+interface ReleaseConfig extends ScriptSharedInterface {
     githubPR?: GithubPRProps;
     workspaces?: WorkspacesProps;
 }
-interface ReleaseContextOptions<T extends ReleaseConfig = ReleaseConfig> extends Omit<FeScriptContextOptions<T>, 'constructor'> {
-    shared?: SharedReleaseOptions;
+interface ReleaseContextOptions$1<T extends ReleaseConfig = ReleaseConfig> extends ScriptContextInterface<T> {
 }
 type StepOption<T> = {
     label: string;
@@ -261,7 +273,7 @@ type StepOption<T> = {
     task: () => Promise<T>;
 };
 type PackageJson = Record<string, unknown>;
-interface TemplateContext extends SharedReleaseOptions, WorkspaceValue {
+interface TemplateContext extends ReleaseContextOptions$1, WorkspaceValue {
     publishPath: string;
     /**
      * @deprecated  use `releaseEnv` from `shared`
@@ -273,67 +285,19 @@ interface TemplateContext extends SharedReleaseOptions, WorkspaceValue {
     branch: string;
 }
 
-declare abstract class Plugin<Props = unknown> implements ExecutorPlugin<ReleaseContext> {
-    protected context: ReleaseContext;
-    readonly pluginName: string;
-    protected props: Props;
-    readonly onlyOne = true;
-    constructor(context: ReleaseContext, pluginName: string, props?: Props);
-    getInitialProps(props?: Props): Props;
-    get logger(): LoggerInterface;
-    get shell(): Shell;
-    get options(): Props;
-    getEnv(key: string, defaultValue?: string): string | undefined;
-    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>;
-    onExec?(_context: ExecutorReleaseContext): void | Promise<void>;
-    onSuccess?(_context: ExecutorReleaseContext): void | Promise<void>;
-    onError?(_context: ExecutorReleaseContext): void | Promise<void>;
-    /**
-     * run a step
-     *
-     * this will log the step and return the result of the task
-     *
-     * @param label - the label of the step
-     * @param task - the task to run
-     * @returns the result of the task
-     */
-    step<T>({ label, task }: StepOption<T>): Promise<T>;
+interface ReleaseContextOptions extends ScriptContextInterface<ReleaseContextConfig> {
 }
-
-/**
- * Represents a class that extends Plugin.
- */
-type PluginClass<T extends unknown[] = any[]> = new (...args: T) => Plugin;
-/**
- * Represents the constructor parameters for a specific Plugin class, excluding the first parameter.
- * This assumes that the constructor parameters are known and can be inferred.
- */
-type PluginConstructorParams<T extends PluginClass> = T extends new (first: any, ...args: infer P) => unknown ? P : never;
-type PluginTuple<T extends PluginClass> = [
-    T | string,
-    ...PluginConstructorParams<T>
-];
-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 {
+interface ReleaseContextConfig extends FeReleaseConfig, ScriptSharedInterface {
     /**
-     * The source branch of the project
-     *
-     * default:
-     * - first, get from `FE_RELEASE_SOURCE_BRANCH`
-     * - second, get from `FE_RELEASE_BRANCH`
-     * - `master`
-     *
+     * The github PR of the project
+     * @private
      */
-    sourceBranch?: string;
+    githubPR?: GithubPRProps;
+    /**
+     * The workspaces of the project
+     * @private
+     */
+    workspaces?: WorkspacesProps;
     /**
      * The environment of the project
      *
@@ -343,12 +307,6 @@ interface SharedReleaseOptions extends FeReleaseConfig {
      * - `development`
      */
     releaseEnv?: string;
-    /**
-     * The root path of the project
-     *
-     * @default `process.cwd()`
-     */
-    rootPath?: string;
     /**
      * Plugins
      */
@@ -366,25 +324,14 @@ interface SharedReleaseOptions extends FeReleaseConfig {
      */
     currentBranch?: string;
 }
-
-declare class ReleaseContext<T extends ReleaseConfig = ReleaseConfig> extends FeScriptContext<T> {
-    protected readonly _env: Env;
-    /**
-     * Shared Config
-     */
-    shared: SharedReleaseOptions;
-    constructor(context: ReleaseContextOptions<T>);
-    private getDefaultShreadOptions;
+declare class ReleaseContext extends ScriptContext<ReleaseContextConfig> {
+    constructor(name: string, options: Partial<ReleaseContextOptions>);
     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;
     getPkg<T>(key?: string, defaultValue?: T): T;
     getTemplateContext(): TemplateContext;
     runChangesetsCli(name: string, args?: string[]): Promise<string>;
@@ -431,7 +378,7 @@ interface GitChangelogOptions {
      * gitlog default fields
      * @default ["abbrevHash", "hash", "subject", "authorName", "authorDate"]
      */
-    fileds?: CommitField[];
+    fields?: CommitField[];
     /**
      * not include merge commit
      * @default true
@@ -498,7 +445,7 @@ interface ChangeLogInterface {
 
 declare const CHANGELOG_ALL_FIELDS: CommitField[];
 interface GitChangelogProps extends GitChangelogOptions {
-    shell: Shell;
+    shell: ShellInterface;
     logger: LoggerInterface;
 }
 declare class GitChangelog implements ChangeLogInterface {
@@ -532,10 +479,10 @@ interface Options extends GitChangelogOptions {
 }
 declare class GitChangelogFormatter implements ChangelogFormatter {
     protected options: Options & {
-        shell: Shell;
+        shell: ShellInterface;
     };
     constructor(options: Options & {
-        shell: Shell;
+        shell: ShellInterface;
     });
     format(commits: CommitValue[], options?: Options): string[];
     formatCommit(commit: CommitValue, options?: Options): string;
@@ -550,12 +497,11 @@ interface GithubChangelogProps extends GitChangelogProps {
 }
 
 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[]>;
+declare function loaderPluginsFromPluginTuples<T extends ScriptPlugin<ScriptContext<any>, ScriptPluginProps>>(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 { CHANGELOG_ALL_FIELDS, GitChangelog, GitChangelogFormatter, Plugin, ReleaseContext, ReleaseLabel, ReleaseTask, factory, load, loaderPluginsFromPluginTuples, reduceOptions, tuple };
-export type { ConstructorType, DeepPartial, ExecutorReleaseContext, GitChangelogProps, GithubChangelogProps, Options, PackageJson, PluginClass, PluginConstructorParams, PluginTuple, ReleaseConfig, ReleaseContextOptions, ReleaseLabelCompare, ReleaseLabelOptions, ReleaseReturnValue, StepOption, TemplateContext };
+export { CHANGELOG_ALL_FIELDS, type ConstructorType, type DeepPartial, type ExecutorReleaseContext, GitChangelog, GitChangelogFormatter, type GitChangelogProps, type GithubChangelogProps, type Options, type PackageJson, type PluginClass, type PluginConstructorParams, type PluginTuple, type ReleaseConfig, ReleaseContext, type ReleaseContextOptions$1 as ReleaseContextOptions, ReleaseLabel, type ReleaseLabelCompare, type ReleaseLabelOptions, type ReleaseReturnValue, ReleaseTask, type StepOption, type TemplateContext, factory, load, loaderPluginsFromPluginTuples, reduceOptions, tuple };