@optique/core 1.3.0-dev.2569 → 1.3.0-dev.2576

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/core",
3
- "version": "1.3.0-dev.2569",
3
+ "version": "1.3.0-dev.2576",
4
4
  "description": "Type-safe combinatorial command-line interface parser",
5
5
  "keywords": [
6
6
  "CLI",
@@ -237,7 +237,7 @@
237
237
  },
238
238
  "sideEffects": false,
239
239
  "devDependencies": {
240
- "@optique/env": "1.3.0-dev.2569+45d1f199",
240
+ "@optique/env": "1.3.0-dev.2576+87e23289",
241
241
  "@types/node": "^24.0.0",
242
242
  "fast-check": "^4.7.0",
243
243
  "tsdown": "^0.13.0",
@@ -49,9 +49,8 @@ Core rules
49
49
  `@optique/run/valueparser` for file-system paths. Write a custom
50
50
  `{ mode, metavar, parse, format }` value parser only when the catalog does
51
51
  not cover the domain.
52
- - Async value parsers make the containing parser async. If you use packages
53
- such as *@optique/git*, remember to `await run(...)`, `await parse(...)`, or
54
- `await runParser(...)` as appropriate.
52
+ - Async value parsers like *@optique/git* make containing parsers async.
53
+ Await `run()`/`parse()`/`runParser()` or, for `bindKeyring()`, `runAsync()`.
55
54
  - Use `dependency()` when one value parser controls another's valid values.
56
55
  For a multi-level chain, wrap the middle derivation too:
57
56
  `dependency(source.deriveSync(...))`. Optique resolves such chains by
@@ -248,8 +247,8 @@ Common mistakes checklist
248
247
  parsers compete by priority; use `seq()` only for truly ordered grammars.
249
248
  - Do not concatenate plain strings for errors or descriptions. Use structured
250
249
  `message` values.
251
- - Do not forget to register source contexts when using `bindEnv()`,
252
- `bindConfig()`, or `bindDerivedDefault()`.
250
+ - Register contexts for `bindEnv()`, `bindConfig()`, `bindDerivedDefault()`,
251
+ and `bindKeyring()` in the runner's `contexts` option.
253
252
  - Do not flatten a multi-level dependency graph into duplicated one-level
254
253
  factories. Wrap each derived value that becomes a later source with
255
254
  `dependency()` and derive the next parser from it.
@@ -283,6 +282,7 @@ Integration packages
283
282
  | Package | Use for | Docs |
284
283
  | --------------------------- | ------------------------------------------- | ----------------------------------------------------- |
285
284
  | `@optique/env` | Environment variable fallbacks | <https://optique.dev/integrations/env.md> |
285
+ | `@optique/keyring` | Async OS credential-store password fallback | <https://optique.dev/integrations/keyring.md> |
286
286
  | `@optique/config` | Configuration file fallbacks | <https://optique.dev/integrations/config.md> |
287
287
  | `@optique/derived-defaults` | Defaults computed from first-pass results | <https://optique.dev/concepts/derived-defaults.md> |
288
288
  | `@optique/prompt` | Generic prompt adapter foundation | <https://optique.dev/integrations/prompt.md> |