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

@chainsafe/ts-cli

v0.0.6

Published

This is a TypeScript CLI generator!

Downloads

9

Readme

TypeScript CLI Template Generator

The template that is used was a port of the Lodestar CLI, and thus heavily inspired by the design patters of Lodestar.

Available Commands

Commands:
  generate  Generates the CLI from a template.
  config    Creates an empty configuration file.

Options:
  -h, --help     Show help
  -v, --version  Show version number

Using the generator

The generator requires a configuration file, config.example.json is provided as guidance. It can be run as followed:

npx @chainsafe/ts-cli generate --config ./<local_file> -o ./my-cli

Configuration File

The configuration file follows the following interface pattern:

interface Config {
    name: string;               // Name of the CLI
    globalOptions: IOption[];   // Options available at the global scope
    commands: ICommand[];       // List of commands
}

interface IOption {             
    name: string;               // Name of the option, eg: --<name>
    description: string;        // Provides a description when --help is used
    type: string;               // Valid TypeScript type in strings, eg: number
    default: string;            // The default value
}

interface ICommand {
    name: string;               // Name of the command
    description: string;        // Provides a description when --help is used
    options: IOption[];         // Options available at the command level
    subCommands: ICommand[];    // Optional sub-commands
}

Modifications

Although there is a lot that can be changed, the bulk of the setup has been done for you. The main things that need updating can be searched for by looking up // TODO: change this!. After that, the world is your oyster.

Roadmap

  • [x] Cli generator
  • [ ] ?