@qui-cli/core 5.0.0 → 5.0.1

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [5.0.1](https://github.com/battis/qui-cli/compare/core/5.0.0...core/5.0.1) (2025-12-19)
+
+
+### Bug Fixes
+
+* update documentation to reflect current core plugin model ([dbb3f26](https://github.com/battis/qui-cli/commit/dbb3f269d3dc3996c1d7050eb3a1acfdd08ab640))
+
 ## [5.0.0](https://github.com/battis/qui-cli/compare/core/4.1.0...core/5.0.0) (2025-11-07)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -44,19 +44,29 @@ See [examples](https://github.com/battis/qui-cli/tree/main/examples#readme) for
 
 Three core plugins are registered automatically to provide consistent functionality.
 
-### `jackspeak`
+### `JackSpeak`
 
-Manages any custom [jackspeak](https://www.npmjs.com/package/jackspeak#user-content-jackoptions-jackoptions----jack) options. As with any other plugin, it can be configured via `Core.configure()`:
+Manages any custom [jackspeak](https://www.npmjs.com/package/jackspeak#user-content-jackoptions-jackoptions----jack) options. As with any other plugin, it can be configured via `configure()`:
 
 ```ts
-await Core.configure({
-  jackspeak: {
-    envPrefix: 'MY_APP'
+import { Core, JackSpeak } from '@qui-cli/core';
+
+await JackSpeak.configure({
+  envPrefix: 'MY_APP'
+});
+
+await Core.init({
+  foo: {
+    description: 'bar'
   }
 });
+
+await Core.run();
+
+console.log(process.env.MY_APP_FOO);
 ```
 
-### `positionals`
+### `Positionals`
 
 Provides per-plugin positonal argument management and documentation. Individual plugins can require named positional arguments, which are collected and documented by `usage()` and accessible throgh the `Positionals` plugin.
 
@@ -97,7 +107,7 @@ Positionals.setMinArg(6);
 Positionals.setMaxArg(4);
 ```
 
-### `help`
+### `Help`
 
 Provides consistent `--help` (`-h`) flag for all commands that displays usage. No confiuration.
 

package/dist/Core.d.ts

@@ -3,9 +3,9 @@ import * as JackSpeak from './JackSpeak.js';
 export { Options } from '@qui-cli/plugin';
 export * from './Usage.js';
 export type Configuration = Plugin.Registrar.Configuration & {
-    /** @deprecated Use `jackspeak` property */
+    /** @deprecated Use {@link JackSpeak} core plugin */
     core?: JackSpeak.Configuration & {
-        /** @deprecated Use `Positional` plugin */
+        /** @deprecated Use {@link Positionals} core plugin */
         requirePositionals?: boolean | number;
     };
 };

package/dist/Help.d.ts

@@ -1,5 +1,6 @@
 import * as Plugin from '@qui-cli/plugin';
 export type Configuration = Plugin.Configuration & {
+    /** Get usage information */
     help?: boolean;
 };
 export declare const name = "core.help";

package/dist/Positionals.d.ts

@@ -1,12 +1,17 @@
 import * as Plugin from '@qui-cli/plugin';
 type PositionalConfig = {
+    /** Description of the purpose of the positional argument */
     description?: string;
+    /** Hint about the value of the positional argument */
     hint?: string;
+    /** Must return true for the argument to be accepted */
     validate?: (v?: string) => boolean | string;
 };
 type PositionalConfigSet = Record<string, PositionalConfig>;
 export type Configuration = Plugin.Configuration & {
+    /** Minimum number of accepted positional arguments */
     min?: number;
+    /** Maximum number of accepted positional arguments */
     max?: number;
 };
 export declare const name = "positionals";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qui-cli/core",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Core features of @qui-cli/qui-cli",
   "homepage": "https://github.com/battis/qui-cli/tree/main/packages/core#readme",
   "repository": {
@@ -19,7 +19,7 @@
   "dependencies": {
     "jackspeak": "^4.1.1",
     "wrap-ansi": "^9.0.2",
-    "@qui-cli/colors": "3.1.0"
+    "@qui-cli/colors": "3.1.1"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.6",