Package Exports

changelog-skimmer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (changelog-skimmer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

changelog-skimmer

📝 Given a common changelog layout, generate a summarised alternative.

I'm aspiring to make open-source my full-time work. If you like the work that I do, please consider supporting me.

Install

npm i changelog-skimmer

Usage

Given a generic format changelog file, compact it into a short or 'skimmed' list. The output will contain the version entry and first comment for said entry.

Module

const { GenerateChangelogSkim } = require( 'changelog-skimmer' );

let changelog = `;
  ## 15.5.1

  ### Security
  - Resolved issue in react-scripts
  - Added XSS to page headers

  ## 15.5.0

  ### UI
  - Shrunk icon size
  - Added footer link

  ### Other
  - Bumped package dependencies
  - Added files key to package.json
`

(async () => {
  let output = await GenerateChangelogSkim( changelog );
  
  console.log( output );
})();

Output

## 15.5.1

- Resolved issue in react-scripts

## 15.5.0

- Shrunk icon size
- Bumped package dependencies

Test

npm test

Contribute

Don't be scared raise an issue or a pull request! Any contributions, no matter how big or small will land your picture here.