changeloger

0.1.3 • Public • Published

GitHub stars

changeloger

自由、简单,漂亮、高度个性化的版本变更日志

Features

  • 一键生成 CHANGELOG.md

  • 基于 Commits log 生成

  • 自定义过滤规则,过滤无效 log

  • 丰富的日志模板,支持自定义

  • monorepo 支持

Getting Started

pnpm add changeloger -g

Usage

  • 在项目中只需要按照依赖,添加 script 命令即可
{
  "log": "changeloger"
}
  • 全局使用,git 项目中 在 shell 工具中执行 changeloger 即可

  • 支持配置文件,详细参考changeloger.config.js

module.exports = {
  theme: 'default',
  types: {
    feat: { title: '✨ Features | 新功能' },
    perf: { title: '⚡ Performance Improvements | 性能优化' },
    fix: { title: '🐛 Bug Fixes | Bug 修复' },
    refactor: { title: '♻ Code Refactoring | 代码重构' },
    docs: { title: '📝 Documentation | 文档' },
    chore: { title: '🎫 Chores | 变更构建流程或辅助工具' },
    build: { title: '👷‍ Build System | 构建' },
    test: { title: '✅ Tests | 测试' },
    types: { title: '🌊 Types | 类型' },
    style: { title: '💄 Styles | 风格' },
    reverts: { title: '⏪ Reverts | 回退' },
    deps: { title: '🥦 Dependencies | 升级依赖' },
    ci: { title: '🔧 Continuous Integration | CI 配置' },
    other: { title: '👏 Other | 其他更新' },
  },
  showContributors: false,
  showNotMatchComiit: true,
};

支持主题

defalut 主题

defalut 主题

simple 主题

defalut 主题

Thanks changelogen !!!

License

MIT License © 2021 阿乐去买菜(alqmc)

Readme

Keywords

none

Package Sidebar

Install

npm i changeloger

Weekly Downloads

0

Version

0.1.3

License

MIT

Unpacked Size

85.3 kB

Total Files

6

Last publish

Collaborators

  • alqmc