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

zd-search-cli

v2.0.0

Published

## Getting Started

Downloads

4

Readme

zd-search-cli

Getting Started

git clone [email protected]:vorks/zd-search-cli.git
cd zd-search-cli
npm install
node ./src/index.js

It is also hosted on npm:

npm i -g zd-search-cli

However, I was unable to get my machine to recognize the command "zd-search-cli". I think this is because in my attempts to install a local copy globally, I have messed up npm that I would have to spend some time rectifying. So others may enjoy better luck. Give it a go and let me know how it goes!

Run Test Suite

npm install
npm test

The system tests ((.*-search|welcome).test.js) may fail as they rely on a timeout to ensure user input is received correctly. I have set a timeout that works for my machine, but it may not work for yours. If these tests fail for you, increase the timeout found in cmd.js.

Test Coverage

Test Coverage

Performance Test

19066 users queried in 7 seconds

Recording

Dependencies

Inquirer.js

Inquirer.js provides all the heavy lifting in printing questions and parsing answers. The critical reasons for use were the smooth implementation of hierarchical prompts, error handling out of the box, and improved UX. Typing in answers for selection is not a pleasant experience; navigation through directions keys is far more natural.

Potential improvements

  • Intelligent search
  • Take data source as environment variables
  • Cross-functionality between json, csv, SQL, and NoSQL
  • Improved output formatting
  • Multiple search parameters at once
  • Allow searching within ranges
  • Allow multiple date formats to still match with differently formatted date values
  • Configurable output style to allow integrations and useful copy+paste
  • Configurable output fields
  • Improved system tests implementation
  • Implement in TypeScript
  • Implement a GUI

Task

Task 1/6 Task 2/6 Task 3/6 Task 4/6 Task 5/6 Task 6/6