Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

conventional-changelog-writer

Package Overview
Dependencies
Maintainers
5
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

conventional-changelog-writer

Write logs based on conventional commits and templates

  • 2.0.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.5M
decreased by-61.37%
Maintainers
5
Weekly downloads
 
Created

What is conventional-changelog-writer?

The conventional-changelog-writer npm package is a utility for generating changelogs based on commit messages that follow the Conventional Commits specification. It formats a changelog stream from parsed commit objects and allows customization of the output format.

What are conventional-changelog-writer's main functionalities?

Generate changelog

This code demonstrates how to use conventional-changelog-writer to generate a changelog from an array of commit objects. Each commit is written to the changelog stream, which formats them according to the specified context and options.

const writer = require('conventional-changelog-writer');
const commits = [
  {hash: '123', type: 'feat', subject: 'add new feature'},
  {hash: '456', type: 'fix', subject: 'fix bug'}
];
const context = {version: '1.0.0'};
const options = {};

const changelogStream = writer(context, options);
commits.forEach(commit => changelogStream.write(commit));
changelogStream.end();

Other packages similar to conventional-changelog-writer

Keywords

FAQs

Package last updated on 08 Dec 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc