@soybeanjs/changelog 0.3.25 → 0.4.0-beta.1

package/dist/index.d.cts

@@ -1,139 +0,0 @@
-/** The commit author */
-interface GitCommitAuthor {
-    /** The author name */
-    name: string;
-    /** The author email */
-    email: string;
-}
-/** The raw git commit */
-interface RawGitCommit {
-    /** The commit message */
-    message: string;
-    /** The commit body */
-    body: string;
-    /** The commit hash */
-    shortHash: string;
-    /** The commit author */
-    author: GitCommitAuthor;
-}
-/** The reference of the commit */
-interface Reference {
-    /** The reference type */
-    type: 'hash' | 'issue' | 'pull-request';
-    /** The reference value */
-    value: string;
-}
-/** The resolved github author */
-interface ResolvedAuthor extends GitCommitAuthor {
-    /** The git commit of the author */
-    commits: string[];
-    /** The github logged username of the author */
-    login: string;
-}
-/** Git commit config */
-interface GitCommit extends RawGitCommit {
-    /** The commit description */
-    description: string;
-    /** The commit scope type */
-    type: string;
-    /** The commit scope */
-    scope: string;
-    /** The commit references */
-    references: Reference[];
-    /** The commit authors */
-    authors: GitCommitAuthor[];
-    /** The resolved authors */
-    resolvedAuthors: ResolvedAuthor[];
-    /** The commit breaking changes */
-    isBreaking: boolean;
-}
-/** Github config */
-interface GithubConfig {
-    /**
-     * The github repository name
-     *
-     * @example
-     *   soybeanjs / changelog;
-     */
-    repo: string;
-    /** The github token */
-    token: string;
-}
-interface ChangelogOption {
-    /**
-     * The directory of the project
-     *
-     * @default process.cwd()
-     */
-    cwd: string;
-    /** The commit scope types */
-    types: Record<string, string>;
-    /** Github config */
-    github: GithubConfig;
-    /** The commit hash or tag */
-    from: string;
-    /** The commit hash or tag */
-    to: string;
-    /** The whole commit tags */
-    tags: string[];
-    /** The commit tag and date map */
-    tagDateMap: Map<string, string>;
-    /** Whether to capitalize the first letter of the commit type */
-    capitalize: boolean;
-    /**
-     * Use emojis in section titles
-     *
-     * @default true
-     */
-    emoji: boolean;
-    /** The section titles */
-    titles: {
-        /** The title of breaking changes section */
-        breakingChanges: string;
-    };
-    /** The output file path of the changelog */
-    output: string;
-    /**
-     * Whether to regenerate the changelog if it already exists
-     *
-     * @example
-     *   the changelog already exists the content of v0.0.1, but you want to regenerate it
-     */
-    regenerate: boolean;
-    /** Mark the release as prerelease */
-    prerelease?: boolean;
-}
-
-/**
- * Get the changelog markdown by two git tags
- *
- * @param options The changelog options
- * @param showTitle Whither show the title
- */
-declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTitle?: boolean): Promise<{
-    markdown: string;
-    commits: GitCommit[];
-    options: ChangelogOption;
-}>;
-/**
- * Get the changelog markdown by the total git tags
- *
- * @param options The changelog options
- * @param showProgress Whither show the progress bar
- */
-declare function getTotalChangelogMarkdown(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<string>;
-/**
- * Generate the changelog markdown by two git tags
- *
- * @param options The changelog options
- */
-declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<void>;
-/**
- * Generate the changelog markdown by the total git tags
- *
- * @param options The changelog options
- * @param showProgress Whither show the progress bar
- */
-declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
-
-export { type ChangelogOption, generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };