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

getoptie

v1.0.2

Published

Smart getopt

Downloads

6

Readme

node-getoptie Build Status

Installation

npm install getoptie

Usage

var getoptie = require('getoptie');

var argv = getoptie('ab:m:*[v*]');

console.log(argv);

Run it

# node test.js -a -barg -vvv -m hello -mworld list of arguments
{ options:
   { a: true,
     b: 'arg',
     v: [ true, true, true ],
     m: [ 'hello', 'world' ]
  },
  args: [ 'list', 'of', 'arguments' ] }

Что это?

Небольшая библиотечка, которая берёт на себя чёрную работу по валидации параметров запуска консольных утилит. В целом, базовый синтаксис похож на POSIX getopt(3), но он расширен и изменено поведение по умолчанию.

Что умеет обрабатывать и проверять:

  • обязательные аргументы (все аргументы по умолчанию обязательные)
  • необязательные аргументы (чтобы сделать аргумент необязательным, его нужно взять в квадратные скобки [])
  • аргументы, заданные несколько раз (включается только усли указать суффикс * в описании)
  • конфликтующие аргументу (см. слудующий пункт)
  • комбинации аргументов, например: "bc|d" позволяет задавать либо -b и -c. либо только -d. Любые другие комбинации вызовут ошибку. Можно задвать более сложные варианты, например:
    • ab(cd|ef:)
    • a|(b|(c|(d|f)))
  • аргументы, требующие параметра. Указываются суффиксом :, например: "ab:c" - тут -b требует параметр, остальные опции без параметра

Example

Напишем небольшой тестовый скрипт, чтобы было проще проверять работу getoptie. Скрипт принимает первым параметром описание опций (optstring), а следующие аргументы уже трактуются как аргументы, которые нужно проверять.

var getoptie = require('getoptie');

try {
	var options = getoptie(
		process.argv[2],
		process.argv.slice(3)
	);

	console.log(options);
} catch(e) {
	console.error(e.message);
	process.exit(255);
}

Проверяем

Несколько одинаковых опций и список параметров

% node test.js 'hv*a:*' -ahello -a world -vvv -h list of args
{ options: { a: [ 'hello', 'world' ], v: [ true, true, true ], h: true },
args: [ 'list', 'of', 'args' ] }

Проверка обязательных опций

% node test.js 'abc|ad' -a
Mandatory option(s) is not specified: -b, -c or -d

Тоже проверка обязательных опций, но больше вариантов

% node test.js 'a(b|c)|ad' -a
Mandatory option(s) is not specified: -b or -c or -d

Конфликтующие опции

% node test.js 'abc|ad' -adc
Option -c is not allowed here

Всё хорошо

% node test.js 'a[bc]|ad' -ab
{ options: { a: true, b: true }, args: [] }