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

@citycide/changelog

v2.0.0

Published

Generate a changelog from git metadata using a tweaked Angular convention.

Downloads

23

Readme

@citycide/changelog · Version License JavaScript Standard Style

standard-changelog customized with a few personal tweaks.

See convention. The commit conventions are the same as the original Angular version, but their appearance in the changelog has been updated.

installation

npm i @citycide/changelog

overview

TL;DR: init with changelog -f, commit, update package.json:version, run changelog

If this is your first time running changelog or to start a fresh file, use the --first-release or -f flag:

# defaults to the filename `changelog.md`
changelog -f

# uses the given filename
changelog -f -i RELEASE_HISTORY.md

Once you have a file started, you just need to follow these steps:

  1. commit your changes using Angular commit conventions
  2. increment your project's version in package.json as necessary
  3. run changelog to add the latest version's changes
  4. create a GitHub release / tag for the latest update
changelog

# for other filenames
changelog -i RELEASE_HISTORY.md

# read in one file, output to another
changelog -i CHANGES.MD -o RELEASE_HISTORY.md

usage

Usage:

  changelog [options]

Options:
  -i, --in-file          Read the changelog from this file (default: changelog.md)
  -f, --first-release    Generate the changelog for the first time
  -o, --out-file         Write the changelog to this file (default: changelog.md)
  -s, --same-file        Overwrite the input file (default: true)
  -k, --pkg              Path to a specific package.json (default: nearest package.json)
  -a, --append           Whether the generated block should be appended
  -r, --release-count    Number of releases to be generated from the latest
  -v, --verbose          Whether to output more logs
  -c, --context          Path to a JSON file that is used to define template variables
  -l, --lerna-package    Generate a changelog for a specific lerna package (:[email protected])
  --commit-path          Generate a changelog scoped to a specific directory

output example

## [`2.0.0`](https://github.com/citycide/changelog/compare/v1.4.2...v2.0.0) (2017-12-12)


###### BUG FIXES

* `b` constant name ([9c486be](https://github.com/citycide/changelog/commit/9c486be))

###### FEATURES

* add `a` constant ([04c471c](https://github.com/citycide/changelog/commit/04c471c))
* add `b` constant ([63fcb1f](https://github.com/citycide/changelog/commit/63fcb1f))
* drop `a` constant ([e19e3ce](https://github.com/citycide/changelog/commit/e19e3ce))

###### PERFORMANCE

* declare `b` as a string directly ([5d9fbee](https://github.com/citycide/changelog/commit/5d9fbee))

###### BREAKING CHANGES

* The `a` constant is removed. Use `b` instead.

Which displays as:

2.0.0 (2017-12-12)

BUG FIXES
FEATURES
PERFORMANCE
  • declare b as a string directly (5d9fbee)
BREAKING CHANGES
  • The a constant is removed. Use b instead.

license

MIT © Bo Lingen / citycide

Original project MIT © Steve Mao & Conventional Changelog