feat: unknown flag values to be passed in explicitly (#13)

BREAKING CHANGE: values must be explicitly passed into unknown flags
privatenumber · Oct 27, 2022 · d4b921d · d4b921d
1 parent 2c5bcfd
commit d4b921d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -178,10 +178,10 @@ $ node ./cli --someString hello --some-string world
 ```
 
 ### Unknown flags
-When unrecognized flags are passed in, they are either interpreted as a string or boolean depending on usage. Unknown flags are not converted to camelCase to allow for accurate error handling.
+When unrecognized flags are passed in, they are interpreted as a boolean, or a string if explicitly passed in. Unknown flags are not converted to camelCase to allow for accurate error handling.
 
 ```sh
-$ node ./cli --unknown-flag --unknown-flag 2
+$ node ./cli --unknown-flag --unknown-flag=2
 ```
 
 This outputs the following:

diff --git a/src/type-flag.ts b/src/type-flag.ts
@@ -93,14 +93,11 @@ export function typeFlag<Schemas extends Flags>(
  parsed.unknownFlags[flagName] = [];
  }
 
- if (flagValue !== undefined) {
- parsed.unknownFlags[flagName].push(flagValue);
- } else {
- setValueOnPreviousFlag = (value = true) => {
- parsed.unknownFlags[flagName].push(value);
- setValueOnPreviousFlag = undefined;
- };
+ if (flagValue === undefined) {
+ flagValue = true;
  }
+
+ parsed.unknownFlags[flagName].push(flagValue);
  };
 
  for (let i = 0; i < argv.length; i += 1) {

diff --git a/tests/index.ts b/tests/index.ts
@@ -293,19 +293,17 @@ describe('Parsing', ({ describe, test }) => {
  const parsed = typeFlag(
  {},
  [
+ '--unknownFlag',
+ 'arg1',
  '--unknownFlag=false',
  '--unknownFlag=',
- 'a',
- '--unknownFlag',
+ 'arg2',
  '-u',
- '4',
- '-u=a',
- '--unknownString',
- 'hello',
- '--unknownString',
+ 'arg3',
+ '-u=value',
  '-3',
  '-sdf',
- '4',
+ 'arg4',
  '-ff=a',
  '--kebab-case',
  ],
@@ -320,18 +318,17 @@ describe('Parsing', ({ describe, test }) => {
  };
 
  expect<UnknownFlags>(parsed.unknownFlags).toStrictEqual({
- unknownFlag: ['false', '', true],
- u: ['4', 'a'],
+ unknownFlag: [true, 'false', ''],
+ u: [true, 'value'],
  3: [true],
  s: [true],
  d: [true],
- f: ['4', true, 'a'],
- unknownString: ['hello', true],
+ f: [true, true, 'a'],
  'kebab-case': [true],
  });
  expect<string[]>(parsed._).toStrictEqual(
  Object.assign(
- ['a'],
+ ['arg1', 'arg2', 'arg3', 'arg4'],
  { '--': [] },
  ),
  );