changelogen - npm Package Compare versions

Comparing version 0.5.4 to 0.5.5

dist/index.d.ts

@@ -0,1 +1,10 @@
+type SemverBumpType = "major" | "premajor" | "minor" | "preminor" | "patch" | "prepatch" | "prerelease";
+declare function determineSemverChange(commits: GitCommit[], config: ChangelogConfig): SemverBumpType | null;
+type BumpVersionOptions = {
+    type?: SemverBumpType;
+    preid?: string;
+    suffix?: boolean;
+};
+declare function bumpVersion(commits: GitCommit[], config: ChangelogConfig, opts?: BumpVersionOptions): Promise<string | false>;
+
 type RepoProvider = "github" | "gitlab" | "bitbucket";
@@ -9,15 +18,6 @@ type RepoConfig = {
 declare function formatReference(ref: Reference, repo?: RepoConfig): string;
-declare function formatCompareChanges(v: string, config: ChangelogConfig): string;
+declare function formatCompareChanges(v: string, config: ResolvedChangelogConfig): string;
 declare function resolveRepoConfig(cwd: string): Promise<RepoConfig>;
 declare function getRepoConfig(repoUrl?: string): RepoConfig;
 
-type SemverBumpType = "major" | "premajor" | "minor" | "preminor" | "patch" | "prepatch" | "prerelease";
-declare function determineSemverChange(commits: GitCommit[], config: ChangelogConfig): SemverBumpType | null;
-type BumpVersionOptions = {
-    type?: SemverBumpType;
-    preid?: string;
-    suffix?: boolean;
-};
-declare function bumpVersion(commits: GitCommit[], config: ChangelogConfig, opts?: BumpVersionOptions): Promise<string | false>;
-
 interface ChangelogConfig {
@@ -30,3 +30,3 @@ cwd: string;
     scopeMap: Record<string, string>;
-    repo?: RepoConfig;
+    repo?: RepoConfig | string;
     tokens: Partial<Record<RepoProvider, string>>;
@@ -47,4 +47,9 @@ from: string;
     };
+    excludeAuthors: string[];
 }
-declare function loadChangelogConfig(cwd: string, overrides?: Partial<ChangelogConfig>): Promise<ChangelogConfig>;
+type ResolvedChangelogConfig = Omit<ChangelogConfig, "repo"> & {
+    repo: RepoConfig;
+};
+declare function loadChangelogConfig(cwd: string, overrides?: Partial<ChangelogConfig>): Promise<ResolvedChangelogConfig>;
+declare function resolveChangelogConfig(config: ChangelogConfig, cwd: string): Promise<ResolvedChangelogConfig>;
 
@@ -74,6 +79,7 @@ interface GitCommitAuthor {
 declare function getLastGitTag(): Promise<any>;
-declare function getCurrentGitBranch(): Promise<string>;
-declare function getCurrentGitTag(): Promise<string>;
-declare function getCurrentGitRef(): Promise<string>;
-declare function getGitRemoteURL(cwd: string, remote?: string): Promise<string>;
+declare function getCurrentGitBranch(): Promise<string & Buffer>;
+declare function getCurrentGitTag(): Promise<string & Buffer>;
+declare function getCurrentGitRef(): Promise<string & Buffer>;
+declare function getGitRemoteURL(cwd: string, remote?: string): Promise<string & Buffer>;
+declare function getCurrentGitStatus(): Promise<string & Buffer>;
 declare function getGitDiff(from: string | undefined, to?: string): Promise<RawGitCommit[]>;
@@ -95,8 +101,8 @@ declare function parseCommits(commits: RawGitCommit[], config: ChangelogConfig): GitCommit[];
 }
-declare function listGithubReleases(config: ChangelogConfig): Promise<GithubRelease[]>;
-declare function getGithubReleaseByTag(config: ChangelogConfig, tag: string): Promise<GithubRelease>;
-declare function getGithubChangelog(config: ChangelogConfig): Promise<any>;
-declare function createGithubRelease(config: ChangelogConfig, body: GithubRelease): Promise<any>;
-declare function updateGithubRelease(config: ChangelogConfig, id: string, body: GithubRelease): Promise<any>;
-declare function syncGithubRelease(config: ChangelogConfig, release: {
+declare function listGithubReleases(config: ResolvedChangelogConfig): Promise<GithubRelease[]>;
+declare function getGithubReleaseByTag(config: ResolvedChangelogConfig, tag: string): Promise<GithubRelease>;
+declare function getGithubChangelog(config: ResolvedChangelogConfig): Promise<any>;
+declare function createGithubRelease(config: ResolvedChangelogConfig, body: GithubRelease): Promise<any>;
+declare function updateGithubRelease(config: ResolvedChangelogConfig, id: string, body: GithubRelease): Promise<any>;
+declare function syncGithubRelease(config: ResolvedChangelogConfig, release: {
     version: string;
@@ -120,9 +126,9 @@ body: string;
 }>;
-declare function githubNewReleaseURL(config: ChangelogConfig, release: {
+declare function githubNewReleaseURL(config: ResolvedChangelogConfig, release: {
     version: string;
     body: string;
 }): string;
-declare function resolveGithubToken(config: ChangelogConfig): Promise<any>;
+declare function resolveGithubToken(config: ResolvedChangelogConfig): Promise<any>;
 
-declare function generateMarkDown(commits: GitCommit[], config: ChangelogConfig): Promise<string>;
+declare function generateMarkDown(commits: GitCommit[], config: ResolvedChangelogConfig): Promise<string>;
 declare function parseChangelogMarkdown(contents: string): {
@@ -135,2 +141,2 @@ releases: {
 
-export { BumpVersionOptions, ChangelogConfig, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, SemverBumpType, bumpVersion, createGithubRelease, determineSemverChange, formatCompareChanges, formatReference, generateMarkDown, getCurrentGitBranch, getCurrentGitRef, getCurrentGitTag, getGitDiff, getGitRemoteURL, getGithubChangelog, getGithubReleaseByTag, getLastGitTag, getRepoConfig, githubNewReleaseURL, listGithubReleases, loadChangelogConfig, parseChangelogMarkdown, parseCommits, parseGitCommit, resolveGithubToken, resolveRepoConfig, syncGithubRelease, updateGithubRelease };
+export { BumpVersionOptions, ChangelogConfig, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, ResolvedChangelogConfig, SemverBumpType, bumpVersion, createGithubRelease, determineSemverChange, formatCompareChanges, formatReference, generateMarkDown, getCurrentGitBranch, getCurrentGitRef, getCurrentGitStatus, getCurrentGitTag, getGitDiff, getGitRemoteURL, getGithubChangelog, getGithubReleaseByTag, getLastGitTag, getRepoConfig, githubNewReleaseURL, listGithubReleases, loadChangelogConfig, parseChangelogMarkdown, parseCommits, parseGitCommit, resolveChangelogConfig, resolveGithubToken, resolveRepoConfig, syncGithubRelease, updateGithubRelease };

package.json

 {
   "name": "changelogen",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Generate Beautiful Changelogs using Conventional Commits",
@@ -28,5 +28,5 @@ "repository": "unjs/changelogen",
     "colorette": "^2.0.20",
-    "consola": "^3.2.2",
+    "consola": "^3.2.3",
     "convert-gitmoji": "^0.1.3",
-    "execa": "^7.1.1",
+    "execa": "^8.0.1",
     "mri": "^1.2.0",
@@ -39,20 +39,20 @@ "node-fetch-native": "^1.2.0",
     "scule": "^1.0.0",
-    "semver": "^7.5.3",
-    "std-env": "^3.3.3",
+    "semver": "^7.5.4",
+    "std-env": "^3.4.2",
     "yaml": "^2.3.1"
   },
   "devDependencies": {
-    "@types/node": "^20.3.3",
+    "@types/node": "^20.5.2",
     "@types/semver": "^7.5.0",
-    "@vitest/coverage-v8": "^0.32.4",
-    "eslint": "^8.44.0",
+    "@vitest/coverage-v8": "^0.34.2",
+    "eslint": "^8.47.0",
     "eslint-config-unjs": "^0.2.1",
-    "jiti": "^1.18.2",
-    "prettier": "^2.8.8",
+    "jiti": "^1.19.3",
+    "prettier": "^3.0.2",
     "standard-version": "^9.5.0",
     "typescript": "^5.1.6",
     "unbuild": "^1.2.1",
-    "vitest": "^0.32.4"
+    "vitest": "^0.34.2"
   },
-  "packageManager": "pnpm@8.6.5",
+  "packageManager": "pnpm@8.6.12",
   "scripts": {
@@ -59,0 +59,0 @@ "build": "unbuild",

README.md

@@ -41,2 +41,3 @@ # changelogen
 - `--dir`: Path to git repository. When not provided, **current working directory** will be used as as default.
+- `--clean`: Determine if the working directory is clean and if it is not clean, exit.
 - `--output`: Changelog file name to create or update. Defaults to `CHANGELOG.md` and resolved relative to dir. Use `--no-output` to write to console only.
@@ -43,0 +44,0 @@ - `--bump`: Determine semver change and update version in `package.json`.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

74790

increased by3.42%

Lines of code

1967

increased by3.09%

Number of lines in readme file

109

increased by0.93%

Dependency changes

• + Addednypm@0.3.11(transitive)

• - Removednypm@0.3.12(transitive)

• Updatedconsola@^3.2.3

• Updatedexeca@^8.0.1

• Updatedsemver@^7.5.4

• Updatedstd-env@^3.4.2