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

@cox-automotive/yaml-changelog

v0.1.9

Published

A simple cli tool for creating and adding to a project's yaml formatted changelog

Downloads

72

Readme

yaml-changelog

A simple cli tool for creating and adding to a project's yaml formatted changelog

oclif Version Downloads/week License

Usage

$ npm install -g @cox-automotive/yaml-changelog
$ yaml-changelog COMMAND
running command...
$ yaml-changelog (-v|--version|version)
@cox-automotive/yaml-changelog/0.1.8 darwin-x64 node-v10.15.3
$ yaml-changelog --help [COMMAND]
USAGE
  $ yaml-changelog COMMAND
...

Commands

yaml-changelog add

Adds a document to changelog.yaml containing a username, story number (optional) and description of changes.

USAGE
  $ yaml-changelog add

OPTIONS
  -h, --help  show CLI help

See code: src/commands/add.ts

yaml-changelog diff

Compares the changelog against the previous revision, HEAD of a given branch, or given commit hash

USAGE
  $ yaml-changelog diff

OPTIONS
  -b, --branch=branch      branch to compare against
  -c, --count              only output the number of changes difference between revs
  -h, --help               show CLI help
  -r, --revision=revision  commit hash to compare against

See code: src/commands/diff.ts

yaml-changelog filter [DATE]

Dislays all entries in the changelog after the provided date

USAGE
  $ yaml-changelog filter [DATE]

ARGUMENTS
  DATE  A date in ISO 8601 format

OPTIONS
  -h, --help  show CLI help

See code: src/commands/filter.ts

yaml-changelog help [COMMAND]

display help for yaml-changelog

USAGE
  $ yaml-changelog help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

yaml-changelog init [PROJECT]

Create an empty changelog.yaml

USAGE
  $ yaml-changelog init [PROJECT]

ARGUMENTS
  PROJECT  Name of the project the changelog is being created in

OPTIONS
  -h, --help  show CLI help

See code: src/commands/init.ts

yaml-changelog release [DATE]

Regenerates releases.yaml with changes from changelog.yaml

USAGE
  $ yaml-changelog release [DATE]

ARGUMENTS
  DATE  A date in ISO 8601 format

OPTIONS
  -h, --help  show CLI help

See code: src/commands/release.ts

yaml-changelog render [FILE]

Renders a given changelog to markdown

USAGE
  $ yaml-changelog render [FILE]

ARGUMENTS
  FILE  Changelog file to render

OPTIONS
  -h, --help  show CLI help

See code: src/commands/render.ts

yaml-changelog render-release [FILE]...

Given a list of releases.yaml files, generates a single RELEASE_NOTES.md

USAGE
  $ yaml-changelog render-release [FILE]...

ARGUMENTS
  FILE  releases.yaml to render

OPTIONS
  -h, --help  show CLI help

See code: src/commands/render-release.ts

Contributing

Prereqs