Sha256: 92d07fcfe098ec3e8545ddc388871c54f167933ce34b3f25f1f3525c027c5c29

Contents?: true

Size: 1.05 KB

Versions: 33

Compression:

Stored size: 1.05 KB

Contents

'use strict';

// This is an example of using tokens to add a custom behaviour.
//
// Require the use of `=` for long options and values by blocking
// the use of space separated values.
// So allow `--foo=bar`, and not allow `--foo bar`.
//
// Note: this is not a common behaviour, most CLIs allow both forms.

// 1. const { parseArgs } = require('node:util'); // from node
// 2. const { parseArgs } = require('@pkgjs/parseargs'); // from package
const { parseArgs } = require('..'); // in repo

const options = {
  file: { short: 'f', type: 'string' },
  log: { type: 'string' },
};

const { values, tokens } = parseArgs({ options, tokens: true });

const badToken = tokens.find((token) => token.kind === 'option' &&
  token.value != null &&
  token.rawName.startsWith('--') &&
  !token.inlineValue
);
if (badToken) {
  throw new Error(`Option value for '${badToken.rawName}' must be inline, like '${badToken.rawName}=VALUE'`);
}

console.log(values);

// Try the following:
//    node limit-long-syntax.js -f FILE --log=LOG
//    node limit-long-syntax.js --file FILE

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.59 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.58 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.57 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.56 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.55 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.54 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.53 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.52 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.51 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.50 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.49 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.48 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.47 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.46 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.45 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.44 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.43 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.42 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js
immosquare-cleaner-0.1.41 node_modules/@pkgjs/parseargs/examples/limit-long-syntax.js