Skip to content

feat: add default option parameter #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Eomm merged 12 commits into from
Oct 8, 2022
Merged

feat: add default option parameter #142

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4313c8a
feat: add defaultValue option parameter
Eomm Aug 13, 2022
8a7a813
fix: removed default values from tokens
Eomm Aug 14, 2022
d94289a
chore: moved utility function
Eomm Aug 16, 2022
df855e0
feat: manage defaultValue array
Eomm Aug 16, 2022
d5759a0
docs: fix option type
Eomm Aug 16, 2022
15d988a
fix: multiple option value instead of presence
Eomm Aug 16, 2022
50f2b25
docs: add example
Eomm Aug 17, 2022
ea92d4e
fix: restore multiple boolean check when needed
Eomm Aug 17, 2022
f9e72da
fix: feedback
Eomm Aug 20, 2022
dd078a7
chore: rename defaultValue option to default
Eomm Aug 20, 2022
7f68c46
fix: test description
Eomm Sep 2, 2022
b2f6a44
chore: update after merge into node.js core
Eomm Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add example
  • Loading branch information
@Eomm
Eomm committed Oct 7, 2022
commit 50f2b25f2a66ef95655f5e5afa84565559028d11
25 changes: 25 additions & 0 deletions examples/is-default-value.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
'use strict';

// This example shows how to understand if a default value is used or not.

// 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', defaultValue: 'FOO' },
};

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

const isFileDefault = !tokens.some((token) => token.kind === 'option' &&
token.name === 'file'
);

console.log(values);
console.log(`Is the file option [${values.file}] the default value? ${isFileDefault}`);

// Try the following:
// node is-default-value.js
// node is-default-value.js -f FILE
// node is-default-value.js --file FILE