@qui-cli/core 4.1.0 → 5.0.0
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/CHANGELOG.md +23 -11
- package/dist/Core.d.ts +0 -1
- package/dist/Core.js +1 -9
- package/dist/JackSpeak.d.ts +13 -0
- package/dist/JackSpeak.js +3 -0
- package/package.json +6 -7
package/CHANGELOG.md
CHANGED
|
@@ -2,35 +2,47 @@
|
|
|
2
2
|
|
|
3
3
|
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.
|
|
4
4
|
|
|
5
|
-
## [
|
|
5
|
+
## [5.0.0](https://github.com/battis/qui-cli/compare/core/4.1.0...core/5.0.0) (2025-11-07)
|
|
6
|
+
|
|
7
|
+
### ⚠ BREAKING CHANGES
|
|
8
|
+
|
|
9
|
+
- group arguments by plugin in usage
|
|
10
|
+
- **plugin@4.0.0** auto-document default arg values
|
|
6
11
|
|
|
12
|
+
### revert
|
|
13
|
+
|
|
14
|
+
- group arguments by plugin in usage ([ec3d4bf](https://github.com/battis/qui-cli/commit/ec3d4bf6ef9c59a6da3ede8603554d2dcd2581ad))
|
|
15
|
+
- **plugin@4.0.0** auto-document default arg values ([e01e157](https://github.com/battis/qui-cli/commit/e01e157f06a3a801628ca79366e3f0060be2322e))
|
|
16
|
+
|
|
17
|
+
### Bug Fixes
|
|
18
|
+
|
|
19
|
+
- merge plugin option in Plugin.Registrar, not in Core ([9a7464f](https://github.com/battis/qui-cli/commit/9a7464fab863c7a9005ade54703726cc9679c8c4))
|
|
20
|
+
|
|
21
|
+
## [4.1.0](https://github.com/battis/qui-cli/compare/core/4.0.1...core/4.1.0) (2025-11-04)
|
|
7
22
|
|
|
8
23
|
### Features
|
|
9
24
|
|
|
10
|
-
|
|
25
|
+
- support scripting markdown documentation for commands ([03ee6d5](https://github.com/battis/qui-cli/commit/03ee6d55f86f6d7b45bd205896cb0fb6a21523b5))
|
|
11
26
|
|
|
12
27
|
## [4.0.1](https://github.com/battis/qui-cli/compare/core/4.0.0...core/4.0.1) (2025-08-04)
|
|
13
28
|
|
|
14
|
-
|
|
15
29
|
### Bug Fixes
|
|
16
30
|
|
|
17
|
-
|
|
31
|
+
- update lagging peer dependency specs ([30c0c27](https://github.com/battis/qui-cli/commit/30c0c279d4247a69a30efef8a7426442752cd9c0))
|
|
18
32
|
|
|
19
33
|
## [4.0.0](https://github.com/battis/qui-cli/compare/core/3.1.0...core/4.0.0) (2025-08-02)
|
|
20
34
|
|
|
21
|
-
|
|
22
35
|
### ⚠ BREAKING CHANGES
|
|
23
36
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
* rename @battis/qui-cli.core --> @qui-cli/core ([43367e9](https://github.com/battis/qui-cli/commit/43367e9d4316aa22fb28078e9436e6de35564f1f))
|
|
37
|
+
- rename @battis/qui-cli.core --> @qui-cli/core
|
|
27
38
|
|
|
39
|
+
- rename @battis/qui-cli.core --> @qui-cli/core ([43367e9](https://github.com/battis/qui-cli/commit/43367e9d4316aa22fb28078e9436e6de35564f1f))
|
|
28
40
|
|
|
29
41
|
### Bug Fixes
|
|
30
42
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
43
|
+
- update dependencies to renamed @qui-cli/colors ([ff80e86](https://github.com/battis/qui-cli/commit/ff80e8625ef98834afdf04e57bfedb1906834e2b))
|
|
44
|
+
- update dependencies to renamed @qui-cli/log ([1c8f0fb](https://github.com/battis/qui-cli/commit/1c8f0fbd5561b4274032382c5d10d33912956e7f))
|
|
45
|
+
- update dependencies to renamed @qui-cli/plugin ([117ea85](https://github.com/battis/qui-cli/commit/117ea85256ec69c807c5b56293546d9c350fd43f))
|
|
34
46
|
|
|
35
47
|
## [3.1.0](https://github.com/battis/qui-cli/compare/core/3.0.0...core/3.1.0) (2025-08-01)
|
|
36
48
|
|
package/dist/Core.d.ts
CHANGED
|
@@ -10,6 +10,5 @@ export type Configuration = Plugin.Registrar.Configuration & {
|
|
|
10
10
|
};
|
|
11
11
|
};
|
|
12
12
|
export declare function configure(config?: Configuration): Promise<void>;
|
|
13
|
-
export declare function options(externalOptions?: Plugin.Options): Promise<Plugin.Options>;
|
|
14
13
|
export declare function init(externalOptions?: Plugin.Options): Promise<Plugin.Arguments<Plugin.Options>>;
|
|
15
14
|
export declare function run(externalOptions?: Plugin.Options): Promise<Plugin.AccumulatedResults | undefined>;
|
package/dist/Core.js
CHANGED
|
@@ -18,14 +18,6 @@ export async function configure(config = {}) {
|
|
|
18
18
|
}
|
|
19
19
|
await Plugin.Registrar.configure({ positionals, jackspeak });
|
|
20
20
|
}
|
|
21
|
-
export async function options(externalOptions = {}) {
|
|
22
|
-
/*
|
|
23
|
-
* TODO automate default value documentation
|
|
24
|
-
Issue URL: https://github.com/battis/qui-cli/issues/38
|
|
25
|
-
* Including parsing `env` (#34) and `secret` (#33) fields
|
|
26
|
-
*/
|
|
27
|
-
return Plugin.mergeOptions(await Plugin.Registrar.options(), externalOptions);
|
|
28
|
-
}
|
|
29
21
|
export async function init(externalOptions) {
|
|
30
22
|
if (initialized) {
|
|
31
23
|
throw new Error(`Already initialized with user-provided command line arguments.`);
|
|
@@ -36,7 +28,7 @@ export async function init(externalOptions) {
|
|
|
36
28
|
}
|
|
37
29
|
}
|
|
38
30
|
if (externalOptions) {
|
|
39
|
-
JackSpeak.args(externalOptions);
|
|
31
|
+
JackSpeak.args(Plugin.documentDefaults(externalOptions));
|
|
40
32
|
}
|
|
41
33
|
const args = JackSpeak.parse();
|
|
42
34
|
await Plugin.Registrar.init(args);
|
package/dist/JackSpeak.d.ts
CHANGED
|
@@ -6,5 +6,18 @@ export declare function jack(): Jack<{}>;
|
|
|
6
6
|
export declare function configure(config?: Configuration): void;
|
|
7
7
|
export declare function args(options: Plugin.Options): void;
|
|
8
8
|
export declare function parse(): import("jackspeak").Parsed<{}>;
|
|
9
|
+
export declare function toJSON(): {
|
|
10
|
+
[k: string]: {
|
|
11
|
+
hint?: string | undefined;
|
|
12
|
+
default?: import("jackspeak").ConfigValue | undefined;
|
|
13
|
+
validOptions?: readonly number[] | readonly string[] | undefined;
|
|
14
|
+
validate?: ((v: unknown) => boolean) | ((v: unknown) => v is import("jackspeak").ValidValue<import("jackspeak").ConfigType, boolean>) | undefined;
|
|
15
|
+
description?: string | undefined;
|
|
16
|
+
short?: string | undefined;
|
|
17
|
+
delim?: string | undefined;
|
|
18
|
+
multiple?: boolean | undefined;
|
|
19
|
+
type: import("jackspeak").ConfigType;
|
|
20
|
+
};
|
|
21
|
+
};
|
|
9
22
|
export declare function usage(): string;
|
|
10
23
|
export declare function usageMarkdown(): string;
|
package/dist/JackSpeak.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@qui-cli/core",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"description": "Core features of @qui-cli/qui-cli",
|
|
5
5
|
"homepage": "https://github.com/battis/qui-cli/tree/main/packages/core#readme",
|
|
6
6
|
"repository": {
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
"types": "./dist/index.d.ts",
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"jackspeak": "^4.1.1",
|
|
21
|
-
"wrap-ansi": "^9.0.2"
|
|
21
|
+
"wrap-ansi": "^9.0.2",
|
|
22
|
+
"@qui-cli/colors": "3.1.0"
|
|
22
23
|
},
|
|
23
24
|
"devDependencies": {
|
|
24
25
|
"@tsconfig/node20": "^20.1.6",
|
|
@@ -26,13 +27,11 @@
|
|
|
26
27
|
"commit-and-tag-version": "^12.6.0",
|
|
27
28
|
"del-cli": "^6.0.0",
|
|
28
29
|
"npm-run-all": "^4.1.5",
|
|
29
|
-
"typescript": "
|
|
30
|
-
"@qui-cli/plugin": "
|
|
31
|
-
"@qui-cli/colors": "3.0.1"
|
|
30
|
+
"typescript": "^5.9.3",
|
|
31
|
+
"@qui-cli/plugin": "4.0.0"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
|
-
"@qui-cli/
|
|
35
|
-
"@qui-cli/plugin": "3.x"
|
|
34
|
+
"@qui-cli/plugin": "4.x"
|
|
36
35
|
},
|
|
37
36
|
"target": "node",
|
|
38
37
|
"scripts": {
|