Skip to content

feat: Add strict mode to parser - #74

Merged
shadowspawn merged 40 commits into
pkgjs:mainfrom
aaronccasanova:feat/strict-mode
Apr 13, 2022
Merged

feat: Add strict mode to parser#74
shadowspawn merged 40 commits into
pkgjs:mainfrom
aaronccasanova:feat/strict-mode

Conversation

@aaronccasanova

@aaronccasanova aaronccasanova commented Mar 3, 2022

Copy link
Copy Markdown
Collaborator

This PR introduces a strict mode parser config that is enabled by default.

Errors on:

  • Unknown option encountered
  • Option of type:'string' used like a boolean option e.g. lone --string
  • Option of type:'boolean' used like a string option e.g. --boolean=foo

Examples:

// node unknown-option.js --foo --bar
parseArgs({
  strict: true,
  options: { foo: { type: 'boolean' } },
});
// [Error]: Unknown option '--bar'
// node invalid-string-option.js --foo
parseArgs({
  strict: true,
  options: { foo: { short: 'f', type: 'string' } },
})
// [Error]: Option '-f, --foo <value>' argument missing
// node invalid-boolean-option.js --foo=bar
parseArgs({
  strict: true,
  options: { foo: { type: 'boolean' } },
})
// [Error]: Option '--foo' does not take an argument

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants