Skip to content

refactor!: rework results to remove redundant flags property and store value true for boolean options #83

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
bcoe merged 16 commits into from
Apr 11, 2022
Merged

refactor!: rework results to remove redundant flags property and store value true for boolean options #83

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d414a7b
Rename flags to foundOptions in code
shadowspawn Mar 12, 2022
f53e230
Store true in values for boolean options
shadowspawn Mar 12, 2022
877b0ce
Update README example results and property descriptions
shadowspawn Mar 12, 2022
e355fd5
Tweak wording for multiple value
shadowspawn Mar 12, 2022
d12e027
Rename foundOptions to parsedOptions
shadowspawn Mar 16, 2022
e9bfed4
Remove parsedOptions
shadowspawn Mar 19, 2022
79bfb5c
Remove README examples file from tests as not a test as such
shadowspawn Mar 19, 2022
167f9e7
Expand description
shadowspawn Mar 19, 2022
9defcc3
Improve --foo=true description
shadowspawn Mar 19, 2022
2b56411
Merge branch 'feature/refactor-results-leaner-meaner-cleaner' of gith…
shadowspawn Mar 19, 2022
92ae729
Merge branch 'main' into feature/refactor-results-leaner-meaner-cleaner
shadowspawn Mar 27, 2022
a34fca9
Merge branch 'main' into feature/refactor-results-leaner-meaner-cleaner
shadowspawn Apr 10, 2022
7488e61
Merge branch 'main' into feature/refactor-results-leaner-meaner-cleaner
Apr 10, 2022
554ed54
Remove flags from merged test
shadowspawn Apr 10, 2022
0660d1d
Merge branch 'main' into feature/refactor-results-leaner-meaner-cleaner
Apr 11, 2022
52b2913
Known options are no longer boolean by default
shadowspawn Apr 11, 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
Known options are no longer boolean by default
  • Loading branch information
@shadowspawn
shadowspawn committed Apr 11, 2022
commit 52b2913e91518592726cc160003f12309d919dae
4 changes: 2 additions & 2 deletions test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ test('when short option `type: "string"` used with value then stored as value',

test('when short option listed in short used as flag then long option stored as flag', (t) => {
const passedArgs = ['-f'];
const passedOptions = { foo: { short: 'f' } };
const passedOptions = { foo: { short: 'f', type: 'boolean' } };
const expected = { values: { foo: true }, positionals: [] };
const args = parseArgs({ args: passedArgs, options: passedOptions });

Expand Down Expand Up @@ -114,7 +114,7 @@ test('handles short-option groups in conjunction with long-options', (t) => {

test('handles short-option groups with "short" alias configured', (t) => {
const passedArgs = ['-rf'];
const passedOptions = { remove: { short: 'r' } };
const passedOptions = { remove: { short: 'r', type: 'boolean' } };
const expected = { values: { remove: true, f: true }, positionals: [] };
const args = parseArgs({ args: passedArgs, options: passedOptions });
t.deepEqual(args, expected);
Expand Down
2 changes: 1 addition & 1 deletion test/short-option-combined-with-value.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ test('when combine string short with value like negative number then parsed as v

test('when combine string short with value which matches configured flag then parsed as value', (t) => {
const passedArgs = ['-af'];
const passedOptions = { alpha: { short: 'a', type: 'string' }, file: { short: 'f' } };
const passedOptions = { alpha: { short: 'a', type: 'string' }, file: { short: 'f', type: 'boolean' } };
const expected = { values: { alpha: 'f' }, positionals: [] };
const result = parseArgs({ args: passedArgs, options: passedOptions });

Expand Down
10 changes: 0 additions & 10 deletions test/short-option-groups.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,6 @@ test('when pass zero-config group of booleans then parsed as booleans', (t) => {
t.end();
});

test('when pass low-config group of booleans then parsed as booleans', (t) => {
const passedArgs = ['-rf', 'p'];
const passedOptions = { r: {}, f: {} };
const expected = { values: { r: true, f: true }, positionals: ['p'] };
const result = parseArgs({ args: passedArgs, options: passedOptions });

t.deepEqual(result, expected);
t.end();
});

test('when pass full-config group of booleans then parsed as booleans', (t) => {
const passedArgs = ['-rf', 'p'];
const passedOptions = { r: { type: 'boolean' }, f: { type: 'boolean' } };
Expand Down