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

gracey

v1.0.1

Published

Creates a CLI using a declarative approach (What you see is what you get)

Downloads

1

Readme

GRACEY

A declarative CLI building tool that just makes sense. Named after my sweetheart.

Features

Motivation

There are many CLI tools out there, but they all have restrictions, be some or many.

I want an API that is easy to use, easy to understand and easy to read.

No more guessing what all the commands do. Let's go through it together.

API

The concept of this package is that 'what you write is what you get'. The sequence of your commands matters and you know how your users will interact with the CLI.

All commands that return this are chainable, which is a nice feeling.

Our examples will build the @angular/cli tool with the following commands:

ng generate component --flat folder/componentname
// or
ng g c -f folder/componentname

ng init --flat

class Program or class Alias

The class to your program. Instanciate this once and start the chain of commands.

There is no constructor, so chain away!

const Program = new Gracey()

In this class, the abstraction is multiples and singles. You can change each into eachother. Action is the last thing that happens before the command node is reset.

  1. command()
  2. option()
  3. action()
  4. commands()
  5. options()
  6. actions()
  7. parse()
  8. options?: {}

Gracey().command(name: string)

// want a command?
const Program = new Gracey()
.command('generate', 'g')

// want a sub command?
const Program = new Gracey()
.command('generate', 'g')
.command('component', 'c')

Gracey().option()

// declaring 1 space in the process.argv per option
const Program = new Gracey()
.command('generate', 'g')
.command('component', 'c')
.option('-f', '--flat','Flattens the folder', { default: false })

// declaring 1 space in the process.argv per options (allows -fcd)
const Program = new Gracey()
.command('generate', 'g')
.command('component', 'c')
.options('flags', (option) => {
    // create each option. It will be added into options array
    option('-f', '--flat','Flattens the folder', { default: false })
    option('-s', '--sass','Use SASS as default', { default: false })    
})

Gracey().action()

const Program = new Gracey()
.command('generate', 'g')
.command('component', 'c')
.options('flags', (option) => {
    option('-f', '--flat','Flattens the folder', { default: false })
    option('-s', '--sass','Use SASS as default', { default: false })    
})
// access all the things in Program
.actions((action, program) => {
    // action handler for troubleshooting and you know what ya doing
    action('run component', componentGenerator(program.options))
})

TODO:

Have typescript intellisense all the stuff you've already put in and available in the program.options output, for example.