npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

changelog-to-react-component

v0.6.3

Published

CLI to convert a CHANGELOG.md following the http://keepachangelog.com convention to a react functional component with permalinks and a GitHub look and feel

Downloads

11

Readme

Goal

This package provides a CLI for converting a CHANGELOG.md file that follows the Keep a Changelog convention into a react functional component with permalinks and a GitHub look and feel.

Permalinks

This package generates permanent links for each section.

Let's take a changelog example:

## [0.3.0] - 2003-03-03

### Added

- A bullet.

## [0.2.0] - 2002-02-02

### Added

- Another bullet.

## [0.1.0] - 2001-01-01

### Added

- Last bullet.

GitHub will generates these URLs:

  • 030---2003-03-03
    • added
  • 020---2002-02-02
    • added-1
  • 010---2001-01-01
    • added-2

This makes the added anchors ephemeral. Indeed, when you release another version of your package, all the existing anchors will change because GitHub will increment their trailing number:

  • 040---2004-04-04
    • added
  • 030---2003-03-03
    • added-1 (used to be added)
  • 020---2002-02-02
    • added-2 (used to be added-1)
  • 010---2001-01-01
    • added-3 (used to be added-2)

On the other hand, this package will generate these anchors:

  • 0.3.0
    • 0.3.0-added
  • 0.2.0
    • 0.2.0-added
  • 0.1.0
    • 0.1.0-added

By prefixing the type of changes section anchor with the release name, we guarantee that the link will be permanent.

Usage

  1. Add this package to your dependencies: npm install --save-dev changelog-to-html
  2. Add "changelog-to-html": "changelog-to-html" to your package.json scripts.

You can get the command help by running npm run changelog-to-html -- --help.

Acknowledgements

This is a modified version of https://github.com/activeviam/changelog-to-html - I wanted a react component not necessarily a stand alone static site.