icore 1.0.10 → 1.0.12

package/dist/options.d.ts

@@ -35,9 +35,12 @@ export type StringOption<TChoices extends readonly string[] = readonly string[]>
 /**
  * Declarative boolean flag contract.
  *
- * Boolean options accept flag form and explicit `true` / `false` values.
+ * Boolean options accept flag form and explicit `true` / `false` values unless
+ * flag syntax is enforced.
  */
-export type BooleanOption = OptionBase<'boolean', boolean>;
+export type BooleanOption = OptionBase<'boolean', boolean> & {
+    syntax?: 'flag';
+};
 /**
  * Declarative number option contract.
  *

package/dist/options.js

@@ -71,7 +71,7 @@ function parseOptionValue(name, definition, value) {
         return parseStringOption(name, definition, value);
     }
     if (definition.type === 'boolean') {
-        return parseBooleanOption(name, value);
+        return parseBooleanOption(name, definition, value);
     }
     return parseNumberOption(name, definition, value);
 }
@@ -103,7 +103,13 @@ function parseStringOption(name, definition, value) {
     assertChoice(name, definition.choices, value);
     return value;
 }
-function parseBooleanOption(name, value) {
+function parseBooleanOption(name, definition, value) {
+    if (definition.syntax === 'flag') {
+        if (value === true) {
+            return true;
+        }
+        throw new Error(`Expected '--${name}' as boolean flag`);
+    }
     if (value === true || value === 'true') {
         return true;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "icore",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Declarative command line interface mechanics for Node.js",
   "keywords": [
     "command-line",

package/readme.md

@@ -10,7 +10,7 @@ Small dependency-free command line interface mechanics for [Node.js®](https://n
 Supports a practical GNU-style option syntax:
 
 - long options: `--name value`, `--name=value`;
-- boolean flags: `--flag`, `--flag=true`, `--flag=false`, `--no-flag`;
+- boolean flags: `--flag`, `--flag=true`, `--flag=false`, `--no-flag` by default;
 - short aliases: `-f`, `-n value`;
 - option terminator: `--`.
 
@@ -74,8 +74,8 @@ Result:
 }
 ```
 
-When an option schema is provided, boolean options are parsed as flag-only
-options without consuming the following positional argument:
+When an option schema is provided, boolean options are parsed as flags without
+consuming the following positional argument:
 
 ```ts
 const argv = parseArgv([
@@ -455,6 +455,21 @@ Invalid explicit values are rejected:
 `--uppercase false` keeps `--uppercase` as `true` and leaves `false` as a positional
 argument.
 
+Use `syntax: 'flag'` when a boolean option should accept only flag form:
+
+```ts
+const schema = {
+  uppercase: {
+    type: 'boolean',
+    default: false,
+    syntax: 'flag'
+  }
+} as const;
+```
+
+With `syntax: 'flag'`, `--uppercase` is accepted, while `--uppercase=true`,
+`--uppercase=false`, and `--no-uppercase` are rejected.
+
 ### `type: 'number'`
 
 ```ts
@@ -552,8 +567,9 @@ Attached short values such as `-nvalue` and grouped short booleans such as
 compatibility.
 
 Negated syntax such as `--no-cache` is interpreted as `cache: false` when
-`cache` is a known boolean option. Unknown negated options and negation for
-string or number options are rejected.
+`cache` is a known boolean option without `syntax: 'flag'`. Unknown negated
+options, negation for string or number options, and negation for flag-only
+boolean options are rejected.
 
 ## Error Messages