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

@hrueger/changelogjs

v1.0.1

Published

A small customizable changelog generator

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

hruegerhrueger

Keywords

changeloggeneratorcustomizablecli

Readme

ChangelogJS

npm Greenkeeper badge License GitHub last commit Maintenance

This is a small customizable changelog generator.

It generates the changelog based on commit messages, not on release notes.

The following modes are avalible: | HTML | MD | JSON | | ---- | -- | ---- | | html-gh | md | json | | Example HTML output | Example Markdown output | Example JSON output |

Installation

Type npm install @hrueger/changelogjs --global into your terminal.

Usage

changelogjs without any options. If a changelogjs.json file is found in the current folder or above, this is used as the configuration instead of the default values (see below).

Configuration

Create a changelogjs.json file ans specify the options below:

| Option | Description | Default | | ------ | ----------- | ------- | | title | The title of the Markdown and HTML page. | Changelog for your App | | logoUrl | The url of a Logo image to be displayed at the top of the HTML page. | Some placeholder image. | | logoAlt | The alternative text for the logo. | Logo | | sort | A boolean value whether the commit messages of one day should be sorted after their type or not. | true | | ignoreAuthors | An array of string values with authors which should be ignored. | ["greenkeeper[bot]"] | | headerLinks | An array of {url: "someUrl", text: "text to be displayed", active: false|true} objects to be displayed as links in the header of the HTML page. | [{url: "/", text: "Docs"}, {url: "#", text: "Changelog", active: true}] | | footerLinks | An array of {url: "someUrl", text: "text to be displayed"} objects to be displayed as links in the footer of the HTML page. | [{url: "#", text: "View on GitHub"}, {url: "https://github.com/hrueger/changelogjs", text: "Generated by ChangelogJS"}] | | modes | An array of {mode: "md"|"json"|"html-gh", file: "someFileName.ext"} objects defining which output files with which modes should be generated. See above for the avalible modes. | [{mode: "md", file: "CHANGELOG.md"}, {mode: "json", file: "CHANGELOG.json"}, {mode: "html-gh", file: "CHANGELOG.html"}] |

Contribute

Feel free to report any issues on GitHub or add new modes / features and create a pull request!

License

MIT