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

vardict

v3.0.0

Published

Get a dictionary consisting of CLI arguments

Downloads

7

Readme

vardict

Get a dictionary consisting of CLI arguments, parsed and statically typed.

npm version Node.js bundle size Types FLOSS NPM Downloads Codeclimate maintainability percentage

What does it do?

Sometimes, a Node.js program needs to receive arguments from the CLI, like this:

node index.js usa hamburger react

If there is a large number of arguments, they can be annotated in a getopt-ish fashion, like this:

node index.js -country usa -food hamburger -library react

vardict parses the arguments passed on to CLI and makes a dictionary/map object that can be used elsewhere in the program. For the previous example, it would work like this:

{ country: 'usa', food: 'hamburger', library: 'react' }

Rules of parsing

As mentioniod above, the rule of parsing is "getopt-ish", meaning that this package does not work in the exact same way as getopt does.

  • Annotations with double hyphens or quotation marks are treated as single entities.
    • node index.js -name Noyan --home Narayanganj will produce { name: 'Noyan', home: 'Narayanganj' }
  • Whitespaces and equal signs ('=') are treated as a separator between the annotation and the value.
    • node index.js --state NSW --capital=Sydney will generate { state: 'NSW', capital: 'Sydney' }
  • Static typing is enforced on the values, based on the literal inputs. For example, true/false is boolean, and numeric values are number.
    • node index.js -country BD -popDensPerSqKM 1116 -overPop true will yield { country: 'BD', popDensPerSqKM: 1116, overPop: true }
  • If there is no value provided after an annotation, it is considered a boolean value and set to true.
    • node index.js -country NZ -covidFree -pop 4886000 -neighbour will output { country: 'NZ', covidFree: true, pop: 4886000, neighbour: true }.
  • If the same key is supplied twice, they are merged into an array.
    • node index.js -country Australia -easternStates QLD -easternStates NSW -easternStates VIC -easternStates TAS will give { country: 'Australia', easternStates: ['QLD', 'NSW', 'VIC', 'TAS'] }.
    • node index.js -asl 28 -asl false -asl Sydney will generate { asl: [28, false, 'Sydney'] }.
  • If a key is followed by multiple properties, they are merged into an array.
    • node index.js -asl 28 false Sydney will produce { asl: [28, false, 'Sydney'] }, the same as the previous example.

Installation

Add the package via command line.

| NPM | Yarn | PNPM | Bun | | --- | --- | --- | --- | | npm i vardict | yarn add vardict | pnpm add vardict | bun add vardict |

How to use

Just import and use the object:

// script.js
import vardict from 'vardict' // ES6
const { default: vardict } = require('vardict') // CommonJS

console.log(vardict)

Here are the input and the output of the code.

node script.js                    \
  --'full name' 'Anirudha Paul'   \
  --age 25                        \
  --single                        \
  -c 'Samsung R&D'                \
  --home Mymensingh               \
  --coolWithLadies false          \
  -wantsToGoTo=USA                \
  --IELTS=7.5                     \
  --favoriteFood kachchi          \
  -nick-name Prasun
{
  'full name': 'Anirudha Paul',
  age: 25,
  single: true,
  c: 'Samsung R&D',
  home: 'Mymensingh',
  coolWithLadies: false,
  wantsToGoTo: 'USA',
  IELTS: 7.5,
  favoriteFood: 'kachchi',
  'nick-name': 'Prasun'
}

PRs welcome GitHub follow X Follow