@clerc/core 1.2.1 → 1.3.0-beta.1
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/dist/index.d.mts +14 -14
- package/package.json +4 -6
package/dist/index.d.mts
CHANGED
|
@@ -91,17 +91,17 @@ interface CommandOptions<Parameters extends readonly ParameterDefinitionValue[]
|
|
|
91
91
|
parameters?: Parameters;
|
|
92
92
|
flags?: Flags;
|
|
93
93
|
/**
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
94
|
+
* A callback function to conditionally stop parsing. When it returns true,
|
|
95
|
+
* parsing stops and remaining arguments are preserved in ignored.
|
|
96
|
+
*/
|
|
97
97
|
ignore?: IgnoreFunction;
|
|
98
98
|
}
|
|
99
|
-
interface Command<Name
|
|
100
|
-
name: Name
|
|
99
|
+
interface Command<Name extends string = string, Parameters extends readonly ParameterDefinitionValue[] = readonly ParameterDefinitionValue[], Flags extends ClercFlagsDefinition = ClercFlagsDefinition> extends CommandOptions<Parameters, Flags> {
|
|
100
|
+
name: Name;
|
|
101
101
|
description?: string;
|
|
102
102
|
}
|
|
103
|
-
type CommandWithHandler<Name
|
|
104
|
-
handler?: CommandHandler<Command<Name
|
|
103
|
+
type CommandWithHandler<Name extends string = string, Parameters extends readonly ParameterDefinitionValue[] = readonly ParameterDefinitionValue[], Flags extends ClercFlagsDefinition = ClercFlagsDefinition> = Command<Name, Parameters, Flags> & {
|
|
104
|
+
handler?: CommandHandler<Command<Name, Parameters, Flags>>;
|
|
105
105
|
};
|
|
106
106
|
type CommandsRecord = Record<string, Command>;
|
|
107
107
|
type CommandsMap = Map<string, Command>;
|
|
@@ -158,13 +158,13 @@ declare class Clerc<Commands extends CommandsRecord = {}, GlobalFlags extends Cl
|
|
|
158
158
|
use(plugin: Plugin): this;
|
|
159
159
|
errorHandler(handler: ErrorHandler): this;
|
|
160
160
|
command(commands: readonly CommandWithHandler<any, any, any>[]): this;
|
|
161
|
-
command<Name
|
|
162
|
-
command<Name
|
|
163
|
-
command<Name
|
|
164
|
-
globalFlag<Name
|
|
165
|
-
globalFlag<Name
|
|
161
|
+
command<Name extends string, const Parameters extends readonly ParameterDefinitionValue[], Flags extends ClercFlagsDefinition>(command: CommandWithHandler<Name, Parameters, Flags>): Clerc<Commands & Record<string, CommandWithHandler<Name, Parameters, Flags>>, GlobalFlags>;
|
|
162
|
+
command<Name extends string, const Parameters extends readonly ParameterDefinitionValue[], Flags extends ClercFlagsDefinition>(name: Name extends keyof Commands ? ["COMMAND ALREADY EXISTS"] : Name, options?: CommandOptions<Parameters, Flags>): Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>;
|
|
163
|
+
command<Name extends string, const Parameters extends readonly ParameterDefinitionValue[], Flags extends ClercFlagsDefinition>(name: Name extends keyof Commands ? ["COMMAND ALREADY EXISTS"] : Name, description: string, options?: CommandOptions<Parameters, Flags>): Clerc<Commands & Record<Name, Command<Name, Parameters, Flags>>, GlobalFlags>;
|
|
164
|
+
globalFlag<Name extends string, Flag extends ClercFlagDefinitionValue>(name: Name, description: string, options: Flag): Clerc<Commands, GlobalFlags & Record<Name, Flag>>;
|
|
165
|
+
globalFlag<Name extends string, Flag extends ClercFlagDefinitionValue>(name: Name, options: Flag): Clerc<Commands, GlobalFlags & Record<Name, Flag>>;
|
|
166
166
|
interceptor(interceptor: Interceptor<Command, GlobalFlags>): this;
|
|
167
|
-
on<Name
|
|
167
|
+
on<Name extends LiteralUnion<keyof Commands, string>>(name: Name, handler: CommandHandler<Commands[Name], GlobalFlags>): this;
|
|
168
168
|
run(): Promise<void>;
|
|
169
169
|
parse<Run extends boolean = true>(argvOrOptions?: string[] | ParseOptions<Run>): Run extends true ? Promise<void> : this;
|
|
170
170
|
}
|
|
@@ -190,7 +190,7 @@ declare class MissingRequiredFlagError extends Error {
|
|
|
190
190
|
}
|
|
191
191
|
//#endregion
|
|
192
192
|
//#region src/helpers.d.ts
|
|
193
|
-
declare const defineCommand: <Name
|
|
193
|
+
declare const defineCommand: <Name extends string, const Parameters extends readonly ParameterDefinitionValue[], Flags extends ClercFlagsDefinition>(command: Command<Name, Parameters, Flags>, handler?: NoInfer<CommandHandler<Command<Name, Parameters, Flags>>>) => CommandWithHandler<Name, Parameters, Flags>;
|
|
194
194
|
//#endregion
|
|
195
195
|
//#region src/ignore.d.ts
|
|
196
196
|
declare function createStopAtFirstParameter(): IgnoreFunction;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clerc/core",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0-beta.1",
|
|
4
4
|
"author": "Ray <i@mk1.io> (https://github.com/so1ve)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "Clerc core",
|
|
@@ -27,8 +27,6 @@
|
|
|
27
27
|
".": "./dist/index.mjs",
|
|
28
28
|
"./package.json": "./package.json"
|
|
29
29
|
},
|
|
30
|
-
"main": "./dist/index.mjs",
|
|
31
|
-
"module": "./dist/index.mjs",
|
|
32
30
|
"types": "./dist/index.d.mts",
|
|
33
31
|
"files": [
|
|
34
32
|
"dist"
|
|
@@ -38,11 +36,11 @@
|
|
|
38
36
|
},
|
|
39
37
|
"dependencies": {
|
|
40
38
|
"lite-emit": "^4.0.0",
|
|
41
|
-
"@clerc/
|
|
42
|
-
"@clerc/
|
|
39
|
+
"@clerc/utils": "1.3.0-beta.1",
|
|
40
|
+
"@clerc/parser": "1.3.0-beta.1"
|
|
43
41
|
},
|
|
44
42
|
"devDependencies": {
|
|
45
43
|
"is-platform": "^1.0.0",
|
|
46
|
-
"@clerc/advanced-types": "1.
|
|
44
|
+
"@clerc/advanced-types": "1.3.0-beta.1"
|
|
47
45
|
}
|
|
48
46
|
}
|