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

cli-gen

v1.1.0

Published

Dependency-free, opinionated node.js CLI skeleton generator.

Downloads

3

Readme

Dependencies Build Status

cli-gen

Dependency-free, opinionated node.js CLI skeleton generator that is structured to allow automatic rolling upgrades of framework code.

Opinionated choices:

  • CLI framework: commander
  • Logging: winston
  • Tests: jest
  • Promise flow control: async
  • Console colors: chalk

All packages are installed at the latest release on new project creation using npm install.

Install

Install the global cli-gen executable:

npm install -g cli-gen

Or use without installing by using npx (not npm):

npx cli-gen

Usage

  • Initial use: in a blank directory, run cli-gen --apply to create a new CLI project skeleton. The project name is used to generate a new package.json file. Follow the development guidelines below to ensure that any skeleton code can be automatically updated in future releases.

  • Upgrade boilerplate: run cli-gen --apply in an existing project directory. This requires that the development guidelines below are adhered to.

  • Dry run: run cli-gen without arguments to see what cli-gen would have done.

  • Link command globally: npm link .

Development Guidelines

A single CLI command corressponding to your project name will be specfied in package.json under the bin entry. This command will perform git-style subcommands using the commander module, while setting up the CLI environment (logging, global helpers, etc.).

CLI subcommands follow a directory-based structure in the following root folder: lib/cli/verbs. A bare-bones "about" verb is created in the about folder.

Following the development guidelines below, user code and framework/skeleton code will be isolated for independent upgrades.

Guideline 1

  • Interface with the framework as independent commander subcommands.

New features should start with a subcommand folder in lib/cli/verbs with its specified set of options.

Guideline 2

  • Additive source changes are fine.

Files and directories can be added anywhere, as long as files do not include the following text on its own line:

/* cli-gen: auto-generated, do not edit. */