feat: add ignoreArgv option (upgrade type-flag) (#18)

privatenumber · Nov 10, 2022 · 460a935 · 460a935
1 parent b698ba4
commit 460a935
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -539,6 +539,18 @@ Type: `Command[]`
 
 Array of [commands](#commandoptions-callback) to register.
 
+##### ignoreArgv
+
+Type:
+```ts
+type IgnoreArgvCallback = (
+    type: 'known-flag' | 'unknown-flag' | 'argument',
+    flagOrArgv: string,
+    value: string | undefined,
+) => boolean | void
+```
+
+A callback to ignore argv tokens from being parsed.
 
 #### callback(parsed)
 

diff --git a/package.json b/package.json
@@ -54,7 +54,7 @@
 	},
 	"dependencies": {
 		"terminal-columns": "^1.4.1",
-		"type-flag": "^2.1.0"
+		"type-flag": "^3.0.0"
 	},
 	"devDependencies": {
 		"@pvtnbr/eslint-config": "^0.33.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,4 +1,4 @@
-import typeFlag from 'type-flag';
+import { typeFlag } from 'type-flag';
 import type {
 	CallbackFunction,
 	HasHelpOrVersion,
@@ -155,7 +155,13 @@ function cliBase<
 		};
 	}
 
-	const parsed = typeFlag(flags as HasHelpOrVersion<Options>, argv);
+	const parsed = typeFlag(
+		flags as HasHelpOrVersion<Options>,
+		argv,
+		{
+			ignore: options.ignoreArgv,
+		},
+	);
 
 	const showVersion = () => {
 		console.log(options.version);

diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,8 @@
-import type { TypeFlag, Flags as BaseFlags } from 'type-flag';
+import type {
+	TypeFlag,
+	TypeFlagOptions,
+	Flags as BaseFlags,
+} from 'type-flag';
 import { Command } from './command';
 import type { Renderers } from './render-help/renderers';
 
@@ -123,6 +127,11 @@ export type CliOptions<
 	Options to configure the help documentation. Pass in `false` to disable handling `--help, -h`.
 	*/
 	help?: false | HelpOptions;
+
+	/**
+	 * Which argv elements to ignore from parsing
+	 */
+	ignoreArgv?: TypeFlagOptions['ignore'];
 };
 
 export type CliOptionsInternal<

diff --git a/tests/cleye.test-d.ts b/tests/cleye.test-d.ts
@@ -1,5 +1,5 @@
 import { expectType } from 'tsd';
-import { cli, command } from '..';
+import { cli, command } from '#cleye';
 
 type Arguments = string[] & { '--': string[] };
 

diff --git a/tests/tsconfig.json b/tests/tsconfig.json
@@ -1,8 +1,4 @@
 {
 	"extends": "../tsconfig.json",
-	"compilerOptions": {
-		"moduleResolution": "Node16",
-		"module": "Node16",
-	},
 	"include": ["."]
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -2,11 +2,8 @@
 	"compilerOptions": {
 		"strict": true,
 		"isolatedModules": true,
-		"moduleResolution": "node",
 		"esModuleInterop": true,
-
-		"module": "esnext",
-		"target": "esnext"
+		"module": "Node16"
 	},
 	"include": [
 		"src",