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

niji

v1.3.0

Published

Generate release logs in markdown using the Niji Commit Format and the Github Comparison API.

Downloads

6

Readme

Changelog Generator

version License Downloads Dependencies

Generate changelog using your git commit messages into a digestible change-log / release-log in markdown using the Github Comparison API, and some extremely gnarly logic.

Rules

  1. Commit messages must adhere to the Niji Commit Format, also supports Angular Commit Message Convention.
  2. Comparisons must be made using tags (v2.10.4) or branches (release/v2.10.4) to take advantage of version numbers.

Install

$ npm install niji -g

Usage

  Usage: niji [options]

  Options:

    -h, --help               output usage information
    -V, --version            output the version number
    -o, --out [directory]    Location of the directory to output changelog
    -r, --repo [name]        Repository name
    -u, --user [name]        Repository username
    -h, --head [name]        Commit head
    -b, --base [name]        Commit base
    -f, --format [option]    Changelog Format Type (table (default), node)
    -s, --sort [option]      Sorting option (time (default), type, scope, author)
    -t, --token [token]      Github Token
    -c, --configure [token]  Configure github token for future reference

Configuring Github Token

$ niji -c <GITHUB_TOKEN>

You can grab your Github Token here.

Note

You can specify -t <GITHUB_TOKEN> to override a configured github token or to avoid saving your github token.

Formats

  • Default: Table view
  • Node: Commit list view

Example

After installing, run the command with your desired arguments, here is an example:

$ niji \
    -r <GITHUB_PROJECT_NAME> \
    -u <GITHUB_USERNAME> \
    -h <GITHUB_HEAD_TAG_OR_BRANCH_OR_SHA> \
    -b <GITHUB_BASE_TAG_OR_BRANCH_OR_SHA>

The script will output markdown like so, which you then are free to copy / paste anywhere:

## [2beff77] | 2016-06-17
*branch:[`2beff77`](https://github.com/niji-commit/generator/tree/2beff77)*

Type | Scope | Link | Description | References | Author
--- | --- | --- | --- | --- | ---
Documentation | readme | [`2beff77a01`](https://github.com/niji-commit/generator/commit/2beff77a01d3a9f5d1f38fd3ff41cf50815dc26c) |  Fix david dependency badge |  | Nijiko Yonskai

[2beff77]: https://github.com/niji-commit/generator/compare/3bcddd9...2beff77

Here is the above markdown as a preview:


2beff77 | 2016-06-17

branch:2beff77

Type | Scope | Link | Description | References | Author --- | --- | --- | --- | --- | --- Documentation | readme | 2beff77a01 | Fix david dependency badge | | Nijiko Yonskai


License

Licensed under The MIT License.