npmpackage.info

Gathering detailed insights and metrics for minimist

Other packages similar to minimist

@types/minimist

1.2.5

TypeScript definitions for minimist

minimist-options

4.1.0

Pretty options for minimist

commist

3.2.0

Build your commands on minimist!

minimisted

2.0.1

Handy wrapper of `minimist`

Gathering detailed insights and metrics for minimist

minimist

parse argument options

1.2.8

551

MIT

JavaScript

1.33 kB

15,091,827,582 5.9

Installations

npm install minimist

Score

99.8

Supply Chain

100

Quality

79.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

23

Closed

7

Merged

14

Issues

Open

9

Total

48

Closed

39

Releases

Unable to fetch releases

Contributors

View all 18 contributors

Developer

minimistjs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

19.6.0

NPM Version

9.4.0 Statistics

551 Stars

164 Commits

30 Forks

5 Watching

2 Branches

18 Contributors

Updated on 22 Nov 2024

Bundle Size

3.29 kB

Minified

1.33 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

15,091,827,582

Last day

-8.1%

13,295,943

Compared to previous day

Last week

3.2%

82,641,520

Compared to previous week

Last month

28.8%

316,283,684

Compared to previous month

Last year

1.6%

2,866,328,528

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@ljharb/eslint-config aud auto-changelog eslint in-publish npmignore nyc safe-publish-latest tape

Versions

minimist

parse argument options

This module is the guts of optimist's argument parser without all the fanciful decoration.

example

Example files: example/parse.js (CJS) / example/parse.mjs (ESM)

1// for CJS
2const argv = require('minimist')(process.argv.slice(2));
3
4// for ESM
5// import minimist from 'minimist';
6// const argv = minimist(process.argv.slice(2));
7console.log(argv);

$ node example/parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }

$ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop --no-ding foo bar baz
{
	_: ['foo', 'bar', 'baz'],
	x: 3,
	y: 4,
	n: 5,
	a: true,
	b: true,
	c: true,
	beep: 'boop',
	ding: false
}

methods

1const parseArgs = require('minimist');

const argv = parseArgs(args, opts={})

Return an argument object argv populated with the array arguments from args.

argv._ contains all the arguments that didn't have an option associated with them.

Numeric-looking arguments will be returned as numbers unless opts.string or opts.boolean contains that argument name. To disable numeric conversion for non-option arguments, add '_' to opts.string.

A negated argument of the form --no-foo returns false for option foo.

Any arguments after '--' will not be parsed and will end up in argv._.

options can be:

opts.string - a string or array of strings argument names to always treat as strings
opts.boolean - a boolean, string or array of strings to always treat as booleans. if true will treat all double hyphenated arguments without equal signs as boolean (e.g. affects --foo, not -f or --foo=bar)
opts.alias - an object mapping string names to strings or arrays of string argument names to use as aliases
opts.default - an object mapping string argument names to default values
opts.stopEarly - when true, populate argv._ with everything after the first non-option
opts['--'] - when true, populate argv._ with everything before the -- and argv['--'] with everything after the --. Here's an example:
```
> require('./')('one two three -- four five --six'.split(' '), { '--': true })
{
  _: ['one', 'two', 'three'],
  '--': ['four', 'five', '--six']
}
```
Note that with opts['--'] set, parsing for arguments still stops after the --.
opts.unknown - a function which is invoked with a command line parameter not defined in the opts configuration object. If the function returns false, the unknown option is not added to argv.

install

With npm do:

npm install minimist

license

MIT

Stable Version

The latest stable version of the package.

Stable Version

1.2.8

CRITICAL

9.8/10

Summary

Prototype Pollution in minimist

Affected Versions

< 0.2.4

Patched Versions

0.2.4

CRITICAL

9.8/10

Summary

Prototype Pollution in minimist

Affected Versions

>= 1.0.0, < 1.2.6

Patched Versions

1.2.6

MODERATE

5.6/10

Summary

Prototype Pollution in minimist

Affected Versions

>= 1.0.0, < 1.2.3

Patched Versions

1.2.3

MODERATE

5.6/10

Summary

Prototype Pollution in minimist

Affected Versions

< 0.2.1

Patched Versions

0.2.1

MODERATE

0/10

Summary

Withdrawn: ESLint dependencies are vulnerable (ReDoS and Prototype Pollution)

Affected Versions

< 1.2.2

Patched Versions

1.2.2

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More