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

shelljs-plugin-authors

v2.0.162

Published

A ShellJS plugin for generating a nicely formatted list of authors.

Downloads

2,984

Readme

shelljs-plugin-authors

npm version build status coverage status npm downloads shelljs-plugin

A ShellJS plugin for generating a nicely formatted list of authors.

Usage

Let's assume that we're inside a git repo, and the output of git shortlog -se gives us something like:

    24  Andrew Powlowski <[email protected]>
    39  Gregorio Heaney <[email protected]>
    55  Miller Reichel <[email protected]>
    70  Mervin Graham <[email protected]>
    99  Hallie Paucek <[email protected]>

We want to generate a nicely formatted list of authors sorted alphabetically by author name. There are two ways to do that with this module, first you can use it as a ShellJS plugin:

const shell = require('shelljs')
require('shelljs-plugin-authors')
const authors = shell.authors()
shell.echo(authors.stdout)
/*
Andrew Powlowski <[email protected]>
Gregorio Heaney <[email protected]>
Miller Reichel <[email protected]>
Mervin Graham <[email protected]>
Hallie Paucek <[email protected]>
*/

Or you can use it via the CLI:

$ shelljs-authors
Andrew Powlowski <[email protected]>
Gregorio Heaney <[email protected]>
Miller Reichel <[email protected]>
Mervin Graham <[email protected]>
Hallie Paucek <[email protected]>

If you'd prefer the list be sorted by number of commits per author, pass the -n option:

const shell = require('shelljs')
require('shelljs-plugin-authors')
const authors = shell.authors('-n')
shell.echo(authors.stdout)
/*
Hallie Paucek <[email protected]>
Mervin Graham <[email protected]>
Miller Reichel <[email protected]>
Gregorio Heaney <[email protected]>
Andrew Powlowski <[email protected]>
*/
$ shelljs-authors -n
Hallie Paucek <[email protected]>
Mervin Graham <[email protected]>
Miller Reichel <[email protected]>
Gregorio Heaney <[email protected]>
Andrew Powlowski <[email protected]>

API

Plugin

Options

  • -n - Optional Sort the list by number of commits per author.

Example

shell.authors('-n')

CLI

$ shelljs-authors -h

  Usage: shelljs-authors [options]

  Generate a nicely formatted list of authors

  Options:

    -V, --version   output the version number
    -n, --numbered  Sort by number of commits per author
    -h, --help      output usage information

  Examples:

    $ shelljs-authors
    $ shelljs-authors -n

Installation

Plugin

$ npm i -D shelljs shelljs-plugin-authors

CLI

$ npm i -g shelljs shelljs-plugin-authors

License

MIT