cli-nano 1.0.2 → 1.1.0

package/README.md

@@ -5,6 +5,7 @@
 [![npm](https://img.shields.io/npm/v/cli-nano.svg)](https://www.npmjs.com/package/cli-nano)
 [![npm](https://img.shields.io/npm/dy/cli-nano)](https://www.npmjs.com/package/cli-nano)
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/cli-nano?color=success&label=gzip)](https://bundlephobia.com/result?p=cli-nano)
+<a href="https://nodejs.org/en/about/previous-releases"><img src="https://img.shields.io/node/v/cli-nano.svg" alt="Node" /></a>
 
 ## cli-nano
 
@@ -87,10 +88,13 @@ const config: Config = {
     display: {
       alias: 'D',
       required: true,
+      type: 'boolean',
       description: 'a required display option',
     }
   },
   version: '0.1.6',
+  helpOptLength: 18,  // option name length shown in help (defaults to 20)
+  helpDescLength: 60, // description length shown in help (defaults to 65)
 };
 
 const args = parseArgs(config);
@@ -100,6 +104,31 @@ console.log(args);
 // startServer(args);
 ```
 
+### Usage with Type Inference
+
+For full TypeScript auto-inference and IntelliSense of parsed arguments, define your config as a `const` and use `as const`:
+
+```ts
+const config = {
+  ... // your config object as shown above
+} as const;
+
+const args = parseArgs<typeof config>(config);
+
+// TypeScript will infer the correct types:
+args.input;   // [string, ...string[]] (required, variadic)
+args.port;    // number   (optional, has default)
+args.verbose; // boolean  (optional)
+args.display; // boolean (required)
+```
+
+> **Tip:**  
+> Using `as const` preserves literal types and tuple information, so TypeScript can infer required/optional fields and argument types automatically.  
+> If you use `const config: Config = { ... }`, you get type checking but not full IntelliSense for parsed arguments.
+
+> [!NOTE]
+> For required+variadic positionals, the type is `[string, ...string[]]` (at least one value required). For optional variadic, it's string[]. For non-variadic, it's string.
+
 #### Example CLI Calls
 
 ```sh
@@ -146,4 +175,32 @@ See [examples/](examples/) for more usage patterns.
 `cli-nano` is currently used in these other projects of mine (feel free to edit this list):
 
 - [native-copyfiles](https://github.com/ghiscoding/native-copyfiles)
-- [remove-glob](https://github.com/ghiscoding/remove-glob)
+- [remove-glob](https://github.com/ghiscoding/remove-glob)
+
+## Help Example
+
+You can see below an example of a CLI help (which is the result of calling `--help` with the config shown avove). 
+
+Please note:
+
+- `<option>` → required
+- `[option]` → optional
+
+```
+Usage:
+  serve <input..> [port] [options]  Start a server with the given options
+
+Arguments:
+  input             serving files or directory                                   <string..>
+  port              port to bind on                                              [number]
+
+Options:
+  -d, --dryRun      Show what would be done, but do not actually start the se... [boolean]
+  -e, --exclude     pattern or glob to exclude (may be passed multiple times)    [array]
+  -r, --rainbow     Enable rainbow mode                                          [boolean]
+  -V, --verbose     print more information to console                            [boolean]
+      --up          slice a path off the bottom of the paths                     [number]
+  -D, --display     a required display option                                    <boolean>
+  -h, --help        Show help                                                    [boolean]
+  -v, --version     Show version number                                          [boolean]
+```

package/dist/__tests__/parse-args.spec.d.ts

@@ -0,0 +1 @@
+export { };