@soybeanjs/changelog 0.3.2 → 0.3.3

package/dist/index.d.cts

@@ -0,0 +1,204 @@
+/**
+ * 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;
+    /**
+     * version from package.json, with prefix "v"
+     * @description if the options "to" is not specified, the version will be used
+     */
+    newVersion: string;
+    /**
+     * 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 };

package/dist/index.d.mts

@@ -0,0 +1,204 @@
+/**
+ * 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;
+    /**
+     * version from package.json, with prefix "v"
+     * @description if the options "to" is not specified, the version will be used
+     */
+    newVersion: string;
+    /**
+     * 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 };

package/dist/index.d.ts

@@ -201,4 +201,4 @@ declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<
  */
 declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
 
-export { ChangelogOption, generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };
+export { type ChangelogOption, generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soybeanjs/changelog",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "generate changelog form git tags and commits for github",
   "author": {
     "name": "Soybean",
@@ -36,18 +36,18 @@
     "convert-gitmoji": "0.1.3",
     "dayjs": "1.11.9",
     "execa": "8.0.1",
-    "ofetch": "1.2.0"
+    "ofetch": "1.2.1"
   },
   "devDependencies": {
-    "@soybeanjs/cli": "0.6.7",
+    "@soybeanjs/cli": "0.7.1",
     "@types/cli-progress": "3.11.0",
-    "@types/node": "20.5.2",
+    "@types/node": "20.5.3",
     "eslint": "8.47.0",
-    "eslint-config-soybeanjs": "0.5.5",
+    "eslint-config-soybeanjs": "0.5.6",
     "simple-git-hooks": "2.9.0",
     "tsx": "3.12.7",
     "typescript": "5.1.6",
-    "unbuild": "1.2.1"
+    "unbuild": "2.0.0"
   },
   "simple-git-hooks": {
     "commit-msg": "pnpm soy git-commit-verify",