0.1.1-alpha.1 • Published 2 years ago

@bassist/changelog v0.1.1-alpha.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@bassist/changelog

Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.

Usage

This is a CLI tool, so you can use it with npx in your project root path.

npx @bassist/changelog

You can also install it locally and run it through commands such as pnpm exec.

pnpm add -D @bassist/changelog

In your package.json :

{
  "scripts": {
    "gen:changelog": "pnpm exec changelog"
  }
}

Options

On the command line, options can be passed to the program, e.g. --preset angular.

OptionDefault ValueDescription
presetangularName of the preset you want to use. Must be one of the following: angular, atom, codemirror, conventionalcommits, ember, eslint, express, jquery or jshint
infileCHANGELOG.mdRead the CHANGELOG from this file, and outputting to the same file
path./srcGenerate a changelog scoped to a specific directory

Release Notes

Please refer to CHANGELOG for details.

License

MIT License © 2023-PRESENT chengpeiquan