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

@mlaursen/changelog-preset

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mlaursen/changelog-preset

This is a custom standard-changelog preset that is based off of the angular preset that logs a bit more in the changelog.

  • 1.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

@mlaursen/changelog-preset

This is a custom standard-changelog preset that is based off of the angular preset that logs a bit more in the changelog.

The default behavior of this template will:

  • convert each commit type of:
    • feat -> Features
    • fix -> Bug Fixes
    • perf -> Performance Improvements
    • docs -> Documentation
    • revert -> Reverts (or if commit message has revert)
    • everything else -> Other Internal Changes
  • sort the commit types by:
    1. Bug Fixes
    2. Features
    3. Documentation
    4. Reverts
    5. Performance Improvements
    6. Other Internal Changes
    7. If none match, alpha-numeric sort by title.

Examples

Configuration

The behavior can be configured by creating a changelog.config.js at the root of your git repo.

Check out the configuration interface for documentation about how the config works.

Simple Configuration Example

const {
  createConfig,
  defaultCommitGroupsSort,
  defaultGetCommitType,
  defaultGetCommitScope,
} = require("@mlaursen/changelog-preset/createConfig");

// the `createConfig` is just used to add intellisense for the config
module.exports = createConfig({
  // these are _basically_ the defaults
  // tokens: [],
  // tokenizer: (subject) => subject,
  // ignoreDeps: true,
  // getCommitType: defaultGetCommitType,
  // getCommitScope: defaultGetCommitScope,
  // commitGroupsSort: defaultCommitGroupsSort,
});

FAQs

Package last updated on 28 Feb 2021

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