@soybeanjs/changelog 0.3.25 → 0.4.0

package/dist/index.d.ts

@@ -1,109 +1,111 @@
+//#region src/types.d.ts
 /** The commit author */
 interface GitCommitAuthor {
-    /** The author name */
-    name: string;
-    /** The author email */
-    email: string;
+  /** 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 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 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;
+  /** 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;
+  /** 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;
+  /**
+   * 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;
+  /**
+   * 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;
 }
-
+//#endregion
+//#region src/index.d.ts
 /**
  * Get the changelog markdown by two git tags
  *
@@ -111,9 +113,9 @@ interface ChangelogOption {
  * @param showTitle Whither show the title
  */
 declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTitle?: boolean): Promise<{
-    markdown: string;
-    commits: GitCommit[];
-    options: ChangelogOption;
+  markdown: string;
+  commits: GitCommit[];
+  options: ChangelogOption;
 }>;
 /**
  * Get the changelog markdown by the total git tags
@@ -135,5 +137,5 @@ declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<
  * @param showProgress Whither show the progress bar
  */
 declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
-
-export { type ChangelogOption, generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };
+//#endregion
+export { type ChangelogOption, generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };