changelogen - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

dist/index.d.ts

@@ -10,9 +10,12 @@ type RepoProvider = "github" | "gitlab" | "bitbucket";
 declare function formatCompareChanges(v: string, config: ChangelogConfig): string;
+declare function resolveRepoConfig(cwd: string): Promise<RepoConfig>;
 declare function getRepoConfig(repoUrl?: string): RepoConfig;
 
-type SemverBumpType = "major" | "minor" | "patch";
+type SemverBumpType = "major" | "premajor" | "minor" | "preminor" | "patch" | "prepatch" | "prerelease";
 declare function determineSemverChange(commits: GitCommit[], config: ChangelogConfig): SemverBumpType | null;
-declare function bumpVersion(commits: GitCommit[], config: ChangelogConfig, opts?: {
+type BumpVersionOptions = {
     type?: SemverBumpType;
-}): Promise<string | false>;
+    preid?: string;
+};
+declare function bumpVersion(commits: GitCommit[], config: ChangelogConfig, opts?: BumpVersionOptions): Promise<string | false>;
 
@@ -32,2 +35,7 @@ interface ChangelogConfig {
     output: string | boolean;
+    templates: {
+        commitMessage?: string;
+        tagMessage?: string;
+        tagBody?: string;
+    };
 }
@@ -58,6 +66,7 @@ declare function loadChangelogConfig(cwd: string, overrides?: Partial<ChangelogConfig>): Promise<ChangelogConfig>;
 }
-declare function getLastGitTag(): Promise<string>;
+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 getGitDiff(from: string | undefined, to?: string): Promise<RawGitCommit[]>;
@@ -117,2 +126,2 @@ declare function parseCommits(commits: RawGitCommit[], config: ChangelogConfig): GitCommit[];
 
-export { ChangelogConfig, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, SemverBumpType, bumpVersion, createGithubRelease, determineSemverChange, formatCompareChanges, formatReference, generateMarkDown, getCurrentGitBranch, getCurrentGitRef, getCurrentGitTag, getGitDiff, getGithubChangelog, getGithubReleaseByTag, getLastGitTag, getRepoConfig, githubNewReleaseURL, listGithubReleases, loadChangelogConfig, parseChangelogMarkdown, parseCommits, parseGitCommit, resolveGithubToken, syncGithubRelease, updateGithubRelease };
+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 };

package.json

 {
   "name": "changelogen",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Generate Beautiful Changelogs using Conventional Commits",
@@ -25,11 +25,11 @@ "repository": "unjs/changelogen",
   "dependencies": {
-    "c12": "^1.1.2",
+    "c12": "^1.2.0",
     "colorette": "^2.0.19",
     "consola": "^2.15.3",
     "convert-gitmoji": "^0.1.3",
-    "execa": "^7.0.0",
+    "execa": "^7.1.1",
     "mri": "^1.2.0",
     "node-fetch-native": "^1.0.2",
     "ofetch": "^1.0.1",
-    "open": "^8.4.2",
+    "open": "^9.1.0",
     "pathe": "^1.1.0",
@@ -42,15 +42,15 @@ "pkg-types": "^1.0.2",
   "devDependencies": {
-    "@types/node": "^18.14.2",
+    "@types/node": "^18.15.10",
     "@types/semver": "^7.3.13",
-    "@vitest/coverage-c8": "^0.29.2",
-    "eslint": "^8.35.0",
+    "@vitest/coverage-c8": "^0.29.8",
+    "eslint": "^8.36.0",
     "eslint-config-unjs": "^0.1.0",
-    "jiti": "^1.17.1",
-    "prettier": "^2.8.4",
+    "jiti": "^1.18.2",
+    "prettier": "^2.8.7",
     "standard-version": "^9.5.0",
-    "typescript": "^4.9.5",
+    "typescript": "^5.0.2",
     "unbuild": "^1.1.2",
-    "vitest": "^0.29.2"
+    "vitest": "^0.29.8"
   },
-  "packageManager": "pnpm@7.28.0",
+  "packageManager": "pnpm@8.0.0",
   "scripts": {
@@ -57,0 +57,0 @@ "build": "unbuild",

README.md

@@ -5,10 +5,10 @@ # changelogen
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Github Actions][github-actions-src]][github-actions-href]
 [![Codecov][codecov-src]][codecov-href]
+[![License][license-src]][license-href]
 
-> Generate Beautiful Changelogs using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+Generate Beautiful Changelogs using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
 
 ## Quick Start
 
-Generate changelog in markdown format and show in console:
+Generate a changelog in Markdown format and display in the console:
 
@@ -19,3 +19,3 @@ ```sh
 
-Generate changelog, bump version in `package.json` automatically and update `CHANGELOG.md` (without commit)
+Generate a changelog, bump the version in `package.json` and update `CHANGELOG.md` (without commit):
 
@@ -26,3 +26,3 @@ ```sh
 
-Bump version, update `CHANGELOG.md` and make a git commit and tag:
+Bump the version, update `CHANGELOG.md` and make a git commit and tag:
 
@@ -51,6 +51,10 @@ ```sh
 - `--patch`: Bump as a semver-patch version
+- `--premajor`: Bump as a semver-premajor version, can set id with string.
+- `--preminor`: Bump as a semver-preminor version, can set id with string.
+- `--prepatch`: Bump as a semver-prepatch version, can set id with string.
+- `--prerelease`: Bump as a semver-prerelease version, can set id with string.
 
 ### `changelogen gh release`
 
-Changelogen has built-in functionality to sync with with Github releases!
+Changelogen has built-in functionality to sync with with Github releases.
 
@@ -76,3 +80,3 @@ In order to manually sync a release, you can use `changelogen gh release`. It will parse current `CHANGELOG.md` from current repository (local, then remote) and create or update releases.
 
-Configuration is loaded by [unjs/c12](https://github.com/unjs/c12) from cwd. You can use either `changelog.json`, `changelog.{ts,js,mjs,cjs}`, `.changelogrc` or use the `changelog` field in `package.json`.
+Configuration is loaded by [unjs/c12](https://github.com/unjs/c12) from cwd. You can use either `changelog.config.json`, `changelog.config.{ts,js,mjs,cjs}`, `.changelogrc` or use the `changelog` field in `package.json`.
 
@@ -96,9 +100,9 @@ See [./src/config.ts](./src/config.ts) for available options and defaults.
 
-[npm-version-src]: https://img.shields.io/npm/v/changelogen?style=flat-square
+[npm-version-src]: https://img.shields.io/npm/v/changelogen?style=flat&colorA=18181B&colorB=F0DB4F
 [npm-version-href]: https://npmjs.com/package/changelogen
-[npm-downloads-src]: https://img.shields.io/npm/dm/changelogen?style=flat-square
+[npm-downloads-src]: https://img.shields.io/npm/dm/changelogen?style=flat&colorA=18181B&colorB=F0DB4F
 [npm-downloads-href]: https://npmjs.com/package/changelogen
-[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/changelogen/ci/main?style=flat-square
-[github-actions-href]: https://github.com/unjs/changelogen/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/changelogen/main?style=flat-square
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/changelogen/main?style=flat&colorA=18181B&colorB=F0DB4F
 [codecov-href]: https://codecov.io/gh/unjs/changelogen
+[license-src]: https://img.shields.io/github/license/unjs/changelogen.svg?style=flat&colorA=18181B&colorB=F0DB4F
+[license-href]: https://github.com/unjs/changelogen/blob/main/LICENSE

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

Improved metrics

Total package byte prevSize

65773

increased by5.21%

Lines of code

1746

increased by5.82%

Number of lines in readme file

103

increased by4.04%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Addedbig-integer@1.6.52(transitive)

• + Addedbplist-parser@0.2.0(transitive)

• + Addedbundle-name@3.0.0(transitive)

• + Addeddefault-browser@4.0.0(transitive)

• + Addeddefault-browser-id@3.0.0(transitive)

• + Addeddefine-lazy-prop@3.0.0(transitive)

• + Addedexeca@5.1.1(transitive)

• + Addedhuman-signals@2.1.0(transitive)

• + Addedis-docker@3.0.0(transitive)

• + Addedis-inside-container@1.0.0(transitive)

• + Addedis-stream@2.0.1(transitive)

• + Addedmimic-fn@2.1.0(transitive)

• + Addednpm-run-path@4.0.1(transitive)

• + Addedonetime@5.1.2(transitive)

• + Addedopen@9.1.0(transitive)

• + Addedrun-applescript@5.0.0(transitive)

• + Addedstrip-final-newline@2.0.0(transitive)

• + Addedtitleize@3.0.0(transitive)

• + Addeduntildify@4.0.0(transitive)

• - Removeddefine-lazy-prop@2.0.0(transitive)

• - Removedopen@8.4.2(transitive)

• Updatedc12@^1.2.0

• Updatedexeca@^7.1.1

• Updatedopen@^9.1.0