diff --git a/.eslintrc b/.eslintrc index bd1a5e0..09e4713 100644 --- a/.eslintrc +++ b/.eslintrc @@ -25,5 +25,9 @@ "camelcase": 0, }, }, - ] + { + "files": "example/**", + "extends": "@ljharb/eslint-config/node/latest", + }, + ], } diff --git a/README.md b/README.md index 314b501..891abf0 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,15 @@ fanciful decoration. # example +Example files: [example/parse.js](./example/parse.js) (CJS) / [example/parse.mjs](./example/parse.mjs) (ESM) + ``` js -var argv = require('minimist')(process.argv.slice(2)); +// for CJS +const argv = require('minimist')(process.argv.slice(2)); + +// for ESM +// import minimist from 'minimist'; +// const argv = minimist(process.argv.slice(2)); console.log(argv); ``` @@ -42,10 +49,11 @@ $ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop --no-ding foo bar baz # methods ``` js -var parseArgs = require('minimist') +const parseArgs = require('minimist'); ``` -## var argv = parseArgs(args, opts={}) + +## const argv = parseArgs(args, opts={}) Return an argument object `argv` populated with the array arguments from `args`. diff --git a/example/parse.js b/example/parse.js index 9d90ffb..39ed4c7 100644 --- a/example/parse.js +++ b/example/parse.js @@ -1,4 +1,4 @@ 'use strict'; -var argv = require('../')(process.argv.slice(2)); +const argv = require('minimist')(process.argv.slice(2)); console.log(argv); diff --git a/example/parse.mjs b/example/parse.mjs new file mode 100644 index 0000000..dbe26bd --- /dev/null +++ b/example/parse.mjs @@ -0,0 +1,4 @@ +import minimist from 'minimist'; + +const argv = minimist(process.argv.slice(2)); +console.log(argv);