conventional-changelog 8.0.0 → 8.0.1

package/README.md

@@ -36,46 +36,22 @@ Generate a changelog from git metadata.
 > [!NOTE]
 > You don't have to use the angular commit convention. For the best result of the tool to tokenize your commit and produce flexible output, it's recommended to use a commit convention.
 
-<hr />
-<a href="#install">Install</a>
-<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="#usage">Usage</a>
-<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="#recommended-workflow">Recommended workflow</a>
-<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="#why">Why</a>
-<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="#presets">Presets</a>
-<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="#js-api">JS API</a>
-<br />
-<hr />
-
 ## Install
 
+Install `conventional-changelog` along with the preset you want to use, for example `angular`:
+
 ```bash
 # pnpm
-pnpm add conventional-changelog
+pnpm add conventional-changelog conventional-changelog-angular
 # yarn
-yarn add conventional-changelog
+yarn add conventional-changelog conventional-changelog-angular
 # npm
-npm i conventional-changelog
+npm i conventional-changelog conventional-changelog-angular
 ```
 
 ## Usage
 
-Install the preset you want to use alongside `conventional-changelog`, for example `angular`:
-
-```sh
-# pnpm
-pnpm add conventional-changelog-angular
-# yarn
-yarn add conventional-changelog-angular
-# npm
-npm i conventional-changelog-angular
-```
-
-Then pass the preset name with `-p`:
+Pass the preset name with `-p`:
 
 ```sh
 conventional-changelog -p angular
@@ -83,82 +59,9 @@ conventional-changelog -p angular
 
 This will *not* overwrite any previous changelogs. The above generates a changelog based on commits since the last semver tag that matches the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
 
-If this is your first time using this tool and you want to generate all previous changelogs, you could do
-
-```sh
-conventional-changelog -p angular -r 0
-```
-
-This *will* overwrite any previous changelogs if they exist.
-
-To generate a changelog for a specific commit range, pass tags or SHAs with `--from` and `--to`:
-
-```sh
-conventional-changelog -p angular --from v1.0.0 --to HEAD
-```
-
 All available command line parameters can be listed using CLI: `conventional-changelog --help`.
 
-> [!TIP]
-> You can alias your command or add it to your package.json. EG: `"changelog": "conventional-changelog -p angular -r 0"`.
-
-## Recommended workflow
-
-1. Make changes
-2. Commit those changes
-3. Make sure Travis turns green
-4. Bump version in `package.json`
-5. `conventional-changelog`
-6. Commit `package.json` and `CHANGELOG.md` files
-7. Tag
-8. Push
-
-The reason why you should commit and tag after `conventional-changelog` is that the CHANGELOG should be included in the new release, hence `commits.from` defaults to the latest semver tag.
-
-### With `npm version`
-
-Using the npm scripts to our advantage with the following hooks:
-
-```json
-{
-  "scripts": {
-    "version": "conventional-changelog -p angular && git add CHANGELOG.md"
-  }
-}
-```
-
-You could follow the following workflow
-
-1. Make changes
-2. Commit those changes
-3. Pull all the tags
-4. Run the [`npm version [patch|minor|major]`](https://docs.npmjs.com/cli/version) command
-5. Push
-
-You could optionally add a `preversion` script to package your project or running a full suit of test.
-And a `postversion` script to clean your system and push your release and tags.
-
-By adding a `.npmrc` you could also automate your commit message and set your tag prefix as such:
-
-```
-tag-version-prefix=""
-message="chore(release): %s :tada:"
-```
-
-## Why
-
-- Easy fully automate changelog generation. You could still add more points on top of it.
-- Ignoring reverted commits, templating with [handlebars.js](https://github.com/handlebars-lang/handlebars.js) and links to references, etc.
-- Intelligently setup defaults but yet fully configurable with presets of [popular projects](#presets).
-- Everything internally or externally is pluggable.
-- A lot of tests and actively maintained.
-
-## Presets
-
-- [angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
-- [conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits)
-
-## JS API
+JS API is also available:
 
 ```js
 import { ConventionalChangelog } from 'conventional-changelog'
@@ -170,109 +73,11 @@ const generator = new ConventionalChangelog()
 generator
   .writeStream()
   .pipe(process.stdout)
-
-// or
-
-for await (const chunk of generator.write()) {
-  console.log(chunk)
-}
 ```
 
-### `new ConventionalChangelog(cwdOrGitClient: string | ConventionalGitClient = process.cwd())`
-
-Create a new instance of conventional-changelog generator. `cwdOrGitClient` is the current working directory or a `ConventionalGitClient` instance.
-
-#### `generator.loadPreset(preset: PresetParams): this`
-
-Load and set necessary params from a preset.
-
-#### `generator.config(config: Preset | Promise<Preset>): this`
-
-Set the config directly.
-
-#### `generator.readPackage(transform?: PackageTransform): this`
-
-Find `package.json` up the directory tree and read it. Optionally transform the package data.
-
-#### `generator.readPackage(path: string, transform?: PackageTransform): this`
-
-Read a `package.json` file from a specific path. Optionally transform the package data.
-
-#### `generator.package(pkg: Record<string, unknown>): this`
-
-Set the package data directly.
-
-#### `generator.readRepository(): this`
-
-Read and parse the repository URL from current git repository.
-
-#### `generator.repository(infoOrGitUrl: string | Partial<HostedGitInfo>): this`
-
-Set the repository info directly.
-
-#### `generator.options(options: Options): this`
-
-Set conventional-changelog options.
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| reset | `boolean` | `false` | Whether to reset the changelog or not. |
-| append | `boolean` | `false`  | Should the log be appended to existing data. |
-| releaseCount | `number` | 1 | How many releases of changelog you want to generate. It counts from the upcoming release. Useful when you forgot to generate any previous changelog. Set to `0` to regenerate all. |
-| outputUnreleased | `boolean` | `true` if a different version than last release is given. Otherwise `false` | If this value is `true` and `context.version` equals last release then `context.version` will be changed to `'Unreleased'`. |
-| transformCommit | `(commit: Commit, params: Params) => Partial<Commit> \| Promise<Partial<Commit> \| null> \| null` |  | A transform function that applies after the parser and before the writer. |
-| warn | `function` |  | Logger for warnings |
-| debug | `function` |  | Logger for debug messages |
-| formatDate | `(date: Date) => string` |  | Custom date formatter function. |
-
-#### `generator.context(context: TemplateContext): this`
-
-Set the [writer context](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#context).
-
-#### `generator.tags(params: GetSemverTagsParams): this`
-
-Set params to get semver tags.
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| prefix | `string \| RegExp` |  | Specify a prefix for the git tag that will be taken into account during the comparison. |
-| skipUnstable | `boolean` | `false` | If set, unstable release tags will be skipped, e.g. x.x.x-rc. |
-| clean | `boolean` | `false` | Clean version from prefix and trash. |
-
-If you want to take package-prefixed tags, for example lerna-style tags, you should use `packagePrefix` utility function:
-
-```js
-import {
-  ConventionalChangelog,
-  packagePrefix
-} from 'conventional-changelog'
-
-const generator = new ConventionalChangelog()
-  .readPackage()
-  .loadPreset('angular')
-  .tags({
-    prefix: packagePrefix('foo-package')
-  })
-```
-
-#### `generator.commits(params: GetCommitsParams, parserOptions?: ParserStreamOptions): this`
-
-Set params to get commits.
-
-- [GetCommitsParams](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/git-client/src/types.ts#L1-L41)
-- [ParserStreamOptions](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-commits-parser/src/types.ts#L1-L68)
-
-#### `generator.writer(params: WriterOptions): this`
-
-Set [writer options](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#options).
-
-#### `generator.write(includeDetails?: boolean): AsyncGenerator<string | Details<Commit>, void>`
-
-Generate changelog.
-
-#### `generator.writeStream(includeDetails?: boolean): Readable`
+## Documentation
 
-Generate changelog stream.
+For comprehensive guides, CLI options, and API reference, visit the [documentation website](https://conventional-changelog.js.org/conventional-changelog/).
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "conventional-changelog",
   "type": "module",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "Generate a changelog from git metadata.",
   "author": {
     "name": "Steve Mao",
@@ -20,7 +20,7 @@
     }
   ],
   "license": "MIT",
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#readme",
+  "homepage": "https://conventional-changelog.js.org/conventional-changelog/",
   "repository": {
     "type": "git",
     "url": "https://github.com/conventional-changelog/conventional-changelog.git",
@@ -51,10 +51,10 @@
     "@simple-libs/normalize-package-data": "^1.0.0",
     "fd-package-json": "^2.0.0",
     "meow": "^14.0.0",
-    "conventional-changelog-preset-loader": "^6.0.0",
-    "@conventional-changelog/git-client": "^3.0.0",
-    "conventional-commits-parser": "^7.0.0",
-    "conventional-changelog-writer": "^9.0.0"
+    "@conventional-changelog/git-client": "^3.0.2",
+    "conventional-changelog-preset-loader": "^6.0.1",
+    "conventional-changelog-writer": "^9.1.1",
+    "conventional-commits-parser": "^7.0.1"
   },
   "bin": {
     "conventional-changelog": "./dist/cli/index.js"