@gesslar/bedoc 1.11.0 → 2.1.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/LICENSE.txt +12 -0
- package/README.md +15 -3
- package/dist/schema/bedoc.action.json +42 -0
- package/dist/types/Action.d.ts +3 -0
- package/dist/types/Action.d.ts.map +1 -0
- package/dist/types/BeDoc.d.ts +208 -0
- package/dist/types/BeDoc.d.ts.map +1 -0
- package/dist/types/Configuration.d.ts +11 -0
- package/dist/types/Configuration.d.ts.map +1 -0
- package/dist/types/ConfigurationParameters.d.ts +3 -0
- package/dist/types/ConfigurationParameters.d.ts.map +1 -0
- package/dist/types/Conveyor.d.ts +27 -0
- package/dist/types/Conveyor.d.ts.map +1 -0
- package/dist/types/Discovery.d.ts +215 -0
- package/dist/types/Discovery.d.ts.map +1 -0
- package/dist/types/Environment.d.ts +3 -0
- package/dist/types/Environment.d.ts.map +1 -0
- package/dist/types/Logger.d.ts +47 -0
- package/dist/types/Logger.d.ts.map +1 -0
- package/dist/types/Schema.d.ts +3 -0
- package/dist/types/Schema.d.ts.map +1 -0
- package/dist/types/cli.d.ts +2 -2
- package/dist/types/cli.d.ts.map +1 -10
- package/package.json +24 -23
- package/src/Action.js +9 -0
- package/src/BeDoc.js +304 -0
- package/src/CLIOutput.js +198 -0
- package/src/{core/Configuration.js → Configuration.js} +73 -58
- package/src/{core/ConfigurationParameters.js → ConfigurationParameters.js} +35 -27
- package/src/Conveyor.js +256 -0
- package/src/Discovery.js +442 -0
- package/src/Environment.js +8 -0
- package/src/{core/Logger.js → Logger.js} +30 -18
- package/src/Schema.js +6 -0
- package/src/cli.js +86 -38
- package/tsconfig.types.json +42 -0
- package/LICENSE +0 -24
- package/dist/types/core/ActionManager.d.ts +0 -58
- package/dist/types/core/ActionManager.d.ts.map +0 -10
- package/dist/types/core/Configuration.d.ts +0 -27
- package/dist/types/core/Configuration.d.ts.map +0 -10
- package/dist/types/core/ConfigurationParameters.d.ts +0 -38
- package/dist/types/core/ConfigurationParameters.d.ts.map +0 -10
- package/dist/types/core/Conveyor.d.ts +0 -49
- package/dist/types/core/Conveyor.d.ts.map +0 -10
- package/dist/types/core/Core.d.ts +0 -48
- package/dist/types/core/Core.d.ts.map +0 -10
- package/dist/types/core/Discovery.d.ts +0 -73
- package/dist/types/core/Discovery.d.ts.map +0 -10
- package/dist/types/core/HookManager.d.ts +0 -60
- package/dist/types/core/HookManager.d.ts.map +0 -10
- package/dist/types/core/Logger.d.ts +0 -63
- package/dist/types/core/Logger.d.ts.map +0 -10
- package/dist/types/core/action/ParseManager.d.ts +0 -8
- package/dist/types/core/action/ParseManager.d.ts.map +0 -10
- package/dist/types/core/action/PrintManager.d.ts +0 -8
- package/dist/types/core/action/PrintManager.d.ts.map +0 -10
- package/dist/types/core/util/ActionUtil.d.ts +0 -35
- package/dist/types/core/util/ActionUtil.d.ts.map +0 -10
- package/dist/types/core/util/DataUtil.d.ts +0 -52
- package/dist/types/core/util/DataUtil.d.ts.map +0 -10
- package/dist/types/core/util/FDUtil.d.ts +0 -171
- package/dist/types/core/util/FDUtil.d.ts.map +0 -10
- package/dist/types/core/util/ModuleUtil.d.ts +0 -27
- package/dist/types/core/util/ModuleUtil.d.ts.map +0 -10
- package/dist/types/core/util/StringUtil.d.ts +0 -5
- package/dist/types/core/util/StringUtil.d.ts.map +0 -10
- package/dist/types/core/util/TypeSpec.d.ts +0 -42
- package/dist/types/core/util/TypeSpec.d.ts.map +0 -10
- package/dist/types/core/util/ValidUtil.d.ts +0 -29
- package/dist/types/core/util/ValidUtil.d.ts.map +0 -10
- package/src/core/ActionManager.js +0 -147
- package/src/core/ContractManager.js +0 -112
- package/src/core/Conveyor.js +0 -185
- package/src/core/Core.js +0 -166
- package/src/core/Discovery.js +0 -403
- package/src/core/HookManager.js +0 -143
- package/src/core/action/ParseManager.js +0 -7
- package/src/core/action/PrintManager.js +0 -7
- package/src/core/contract/ParseContract.js +0 -7
- package/src/core/contract/PrintContract.js +0 -7
- package/src/core/util/ActionUtil.js +0 -62
- package/src/core/util/ContractUtil.js +0 -63
- package/src/core/util/DataUtil.js +0 -540
- package/src/core/util/FDUtil.js +0 -388
- package/src/core/util/StringUtil.js +0 -11
- package/src/core/util/TypeSpec.js +0 -114
- package/src/core/util/ValidUtil.js +0 -50
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
Copyright (C) 2026 by Brian M. Workman bmw@gesslar.dev
|
|
2
|
+
|
|
3
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
|
4
|
+
purpose with or without fee is hereby granted.
|
|
5
|
+
|
|
6
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
|
7
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
8
|
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
9
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
10
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
11
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
12
|
+
PERFORMANCE OF THIS SOFTWARE.
|
package/README.md
CHANGED
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
|
|
8
8
|
**BeDoc** is a powerful, pluggable documentation generator designed to handle
|
|
9
9
|
any programming language and output format. With its extensible framework, you
|
|
10
|
-
can easily create custom parsers and
|
|
10
|
+
can easily create custom parsers and formatters to generate structured
|
|
11
11
|
documentation for your projects.
|
|
12
12
|
|
|
13
13
|
---
|
|
14
14
|
|
|
15
15
|
## Key Features
|
|
16
16
|
|
|
17
|
-
- **Pluggable Design**: BeDoc works seamlessly with custom parsers and
|
|
17
|
+
- **Pluggable Design**: BeDoc works seamlessly with custom parsers and formatters
|
|
18
18
|
to fit your unique needs. BeDoc also supports async operations, allowing for
|
|
19
19
|
efficient handling of large projects.
|
|
20
20
|
- **Customizable Input**: Accommodate any text input, whether it’s a well-known
|
|
@@ -85,7 +85,19 @@ Contributions are welcome! Feel free to open an issue or submit a pull request.
|
|
|
85
85
|
|
|
86
86
|
## License
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
`@gesslar/bedoc` is released into the public domain under the [Unlicense](LICENSE.txt).
|
|
89
|
+
|
|
90
|
+
This package includes or depends on third-party components under their own
|
|
91
|
+
licenses:
|
|
92
|
+
|
|
93
|
+
| Dependency | License |
|
|
94
|
+
| --- | --- |
|
|
95
|
+
| [@gesslar/actioneer](https://github.com/gesslar/actioneer) | 0BSD |
|
|
96
|
+
| [@gesslar/colours](https://github.com/gesslar/colours) | 0BSD |
|
|
97
|
+
| [@gesslar/negotiator](https://github.com/gesslar/Negotiator) | 0BSD |
|
|
98
|
+
| [@gesslar/toolkit](https://github.com/gesslar/toolkit) | 0BSD |
|
|
99
|
+
| [commander](https://github.com/tj/commander.js) | MIT |
|
|
100
|
+
| [error-stack-parser](https://github.com/stacktracejs/error-stack-parser) | MIT |
|
|
89
101
|
|
|
90
102
|
---
|
|
91
103
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "https://schema.gesslar.dev/v1/bedoc-action.json",
|
|
4
|
+
"title": "BeDoc Action Schema",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"accepts": {
|
|
8
|
+
"type": "object",
|
|
9
|
+
"properties": {
|
|
10
|
+
"type": {
|
|
11
|
+
"const": "object"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"required": [
|
|
15
|
+
"type"
|
|
16
|
+
]
|
|
17
|
+
},
|
|
18
|
+
"provides": {
|
|
19
|
+
"type": "object",
|
|
20
|
+
"properties": {
|
|
21
|
+
"type": {
|
|
22
|
+
"const": "object"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"required": [
|
|
26
|
+
"type"
|
|
27
|
+
]
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"oneOf": [
|
|
31
|
+
{
|
|
32
|
+
"required": [
|
|
33
|
+
"accepts"
|
|
34
|
+
]
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"required": [
|
|
38
|
+
"provides"
|
|
39
|
+
]
|
|
40
|
+
}
|
|
41
|
+
]
|
|
42
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Action.d.ts","sourceRoot":"","sources":["../../src/Action.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @import {Glog} from "@gesslar/toolkit"
|
|
3
|
+
*/
|
|
4
|
+
export default class BeDoc {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new instance of Core.
|
|
7
|
+
*
|
|
8
|
+
* @param {object} args
|
|
9
|
+
* @param {object} args.options - The options passed into BeDoc
|
|
10
|
+
* @param {string} args.source - The environment BeDoc is running in
|
|
11
|
+
* @param {Glog} args.glog - The Glog logger instance
|
|
12
|
+
* @returns {Promise<BeDoc>} A new instance of Core
|
|
13
|
+
*/
|
|
14
|
+
static "new"({ options, source, glog, validateBeDocSchema }: {
|
|
15
|
+
options: object;
|
|
16
|
+
source: string;
|
|
17
|
+
glog: {
|
|
18
|
+
new (options?: {
|
|
19
|
+
name?: string;
|
|
20
|
+
debugLevel?: number;
|
|
21
|
+
logLevel?: number;
|
|
22
|
+
prefix?: string;
|
|
23
|
+
colours?: object;
|
|
24
|
+
symbols?: object;
|
|
25
|
+
stackTrace?: boolean;
|
|
26
|
+
tagsAsStrings?: boolean;
|
|
27
|
+
displayName?: boolean;
|
|
28
|
+
env?: string;
|
|
29
|
+
}): {
|
|
30
|
+
setOptions(options: {
|
|
31
|
+
name?: string;
|
|
32
|
+
debugLevel?: number;
|
|
33
|
+
logLevel?: number;
|
|
34
|
+
prefix?: string;
|
|
35
|
+
colours?: object;
|
|
36
|
+
symbols?: object;
|
|
37
|
+
stackTrace?: boolean;
|
|
38
|
+
tagsAsStrings?: boolean;
|
|
39
|
+
displayName?: boolean;
|
|
40
|
+
}): /*elided*/ any;
|
|
41
|
+
withName(name: string): /*elided*/ any;
|
|
42
|
+
withLogLevel(level: number): /*elided*/ any;
|
|
43
|
+
withPrefix(prefix: string): /*elided*/ any;
|
|
44
|
+
withColours(colours?: object): /*elided*/ any;
|
|
45
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
46
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
47
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
48
|
+
noDisplayName(): /*elided*/ any;
|
|
49
|
+
use(prefix: string): object;
|
|
50
|
+
get name(): string;
|
|
51
|
+
get debugLevel(): number;
|
|
52
|
+
get options(): object;
|
|
53
|
+
newDebug(tag: string): Function;
|
|
54
|
+
debug(message: string, level?: number, ...arg: unknown[]): void;
|
|
55
|
+
info(message: string, ...arg: unknown[]): void;
|
|
56
|
+
warn(message: string, ...arg: unknown[]): void;
|
|
57
|
+
error(message: string, ...arg: unknown[]): void;
|
|
58
|
+
execute(...args: unknown[]): void;
|
|
59
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
60
|
+
success(message: string, ...args: unknown[]): void;
|
|
61
|
+
group(...args: unknown[]): void;
|
|
62
|
+
groupEnd(): void;
|
|
63
|
+
groupDebug(message: string, level?: number): void;
|
|
64
|
+
groupInfo(message: string): void;
|
|
65
|
+
groupSuccess(message: string): void;
|
|
66
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
67
|
+
properties?: Array<string>;
|
|
68
|
+
showHeader?: boolean;
|
|
69
|
+
quotedStrings?: boolean;
|
|
70
|
+
}): void;
|
|
71
|
+
get colours(): any;
|
|
72
|
+
get raw(): object;
|
|
73
|
+
"__#private@#private": any;
|
|
74
|
+
};
|
|
75
|
+
logLevel: number;
|
|
76
|
+
logPrefix: string;
|
|
77
|
+
colours: any;
|
|
78
|
+
stackTrace: boolean;
|
|
79
|
+
name: string;
|
|
80
|
+
tagsAsStrings: boolean;
|
|
81
|
+
symbols: any;
|
|
82
|
+
setLogPrefix(prefix: string): /*elided*/ any;
|
|
83
|
+
setLogLevel(level: number): /*elided*/ any;
|
|
84
|
+
withName(name: string): /*elided*/ any;
|
|
85
|
+
withColours(colours?: object): /*elided*/ any;
|
|
86
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
87
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
88
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
89
|
+
use(prefix: string): object;
|
|
90
|
+
create(options?: object): {
|
|
91
|
+
setOptions(options: {
|
|
92
|
+
name?: string;
|
|
93
|
+
debugLevel?: number;
|
|
94
|
+
logLevel?: number;
|
|
95
|
+
prefix?: string;
|
|
96
|
+
colours?: object;
|
|
97
|
+
symbols?: object;
|
|
98
|
+
stackTrace?: boolean;
|
|
99
|
+
tagsAsStrings?: boolean;
|
|
100
|
+
displayName?: boolean;
|
|
101
|
+
}): /*elided*/ any;
|
|
102
|
+
withName(name: string): /*elided*/ any;
|
|
103
|
+
withLogLevel(level: number): /*elided*/ any;
|
|
104
|
+
withPrefix(prefix: string): /*elided*/ any;
|
|
105
|
+
withColours(colours?: object): /*elided*/ any;
|
|
106
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
107
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
108
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
109
|
+
noDisplayName(): /*elided*/ any;
|
|
110
|
+
use(prefix: string): object;
|
|
111
|
+
get name(): string;
|
|
112
|
+
get debugLevel(): number;
|
|
113
|
+
get options(): object;
|
|
114
|
+
newDebug(tag: string): Function;
|
|
115
|
+
debug(message: string, level?: number, ...arg: unknown[]): void;
|
|
116
|
+
info(message: string, ...arg: unknown[]): void;
|
|
117
|
+
warn(message: string, ...arg: unknown[]): void;
|
|
118
|
+
error(message: string, ...arg: unknown[]): void;
|
|
119
|
+
execute(...args: unknown[]): void;
|
|
120
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
121
|
+
success(message: string, ...args: unknown[]): void;
|
|
122
|
+
group(...args: unknown[]): void;
|
|
123
|
+
groupEnd(): void;
|
|
124
|
+
groupDebug(message: string, level?: number): void;
|
|
125
|
+
groupInfo(message: string): void;
|
|
126
|
+
groupSuccess(message: string): void;
|
|
127
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
128
|
+
properties?: Array<string>;
|
|
129
|
+
showHeader?: boolean;
|
|
130
|
+
quotedStrings?: boolean;
|
|
131
|
+
}): void;
|
|
132
|
+
get colours(): any;
|
|
133
|
+
get raw(): object;
|
|
134
|
+
"__#private@#private": any;
|
|
135
|
+
};
|
|
136
|
+
execute(...args: unknown[]): void;
|
|
137
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
138
|
+
success(message: string, ...args: unknown[]): void;
|
|
139
|
+
group(...args: unknown[]): void;
|
|
140
|
+
groupEnd(): void;
|
|
141
|
+
groupDebug(message: string, level?: number): void;
|
|
142
|
+
groupInfo(message: string): void;
|
|
143
|
+
groupSuccess(message: string): void;
|
|
144
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
145
|
+
properties?: Array<string>;
|
|
146
|
+
showHeader?: boolean;
|
|
147
|
+
quotedStrings?: boolean;
|
|
148
|
+
}): void;
|
|
149
|
+
setAlias(alias: string, colourCode: string): {
|
|
150
|
+
setOptions(options: {
|
|
151
|
+
name?: string;
|
|
152
|
+
debugLevel?: number;
|
|
153
|
+
logLevel?: number;
|
|
154
|
+
prefix?: string;
|
|
155
|
+
colours?: object;
|
|
156
|
+
symbols?: object;
|
|
157
|
+
stackTrace?: boolean;
|
|
158
|
+
tagsAsStrings?: boolean;
|
|
159
|
+
displayName?: boolean;
|
|
160
|
+
}): /*elided*/ any;
|
|
161
|
+
withName(name: string): /*elided*/ any;
|
|
162
|
+
withLogLevel(level: number): /*elided*/ any;
|
|
163
|
+
withPrefix(prefix: string): /*elided*/ any;
|
|
164
|
+
withColours(colours?: object): /*elided*/ any;
|
|
165
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
166
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
167
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
168
|
+
noDisplayName(): /*elided*/ any;
|
|
169
|
+
use(prefix: string): object;
|
|
170
|
+
get name(): string;
|
|
171
|
+
get debugLevel(): number;
|
|
172
|
+
get options(): object;
|
|
173
|
+
newDebug(tag: string): Function;
|
|
174
|
+
debug(message: string, level?: number, ...arg: unknown[]): void;
|
|
175
|
+
info(message: string, ...arg: unknown[]): void;
|
|
176
|
+
warn(message: string, ...arg: unknown[]): void;
|
|
177
|
+
error(message: string, ...arg: unknown[]): void;
|
|
178
|
+
execute(...args: unknown[]): void;
|
|
179
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
180
|
+
success(message: string, ...args: unknown[]): void;
|
|
181
|
+
group(...args: unknown[]): void;
|
|
182
|
+
groupEnd(): void;
|
|
183
|
+
groupDebug(message: string, level?: number): void;
|
|
184
|
+
groupInfo(message: string): void;
|
|
185
|
+
groupSuccess(message: string): void;
|
|
186
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
187
|
+
properties?: Array<string>;
|
|
188
|
+
showHeader?: boolean;
|
|
189
|
+
quotedStrings?: boolean;
|
|
190
|
+
}): void;
|
|
191
|
+
get colours(): any;
|
|
192
|
+
get raw(): object;
|
|
193
|
+
"__#private@#private": any;
|
|
194
|
+
};
|
|
195
|
+
get raw(): object;
|
|
196
|
+
};
|
|
197
|
+
}): Promise<BeDoc>;
|
|
198
|
+
constructor(glog: any);
|
|
199
|
+
processFiles(): Promise<{
|
|
200
|
+
totalFiles: any;
|
|
201
|
+
succeeded: any;
|
|
202
|
+
warned: any;
|
|
203
|
+
errored: any;
|
|
204
|
+
duration: string;
|
|
205
|
+
}>;
|
|
206
|
+
#private;
|
|
207
|
+
}
|
|
208
|
+
//# sourceMappingURL=BeDoc.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BeDoc.d.ts","sourceRoot":"","sources":["../../src/BeDoc.js"],"names":[],"mappings":"AAQA;;GAEG;AAEH;IAcE;;;;;;;;OAQG;IACH,6DALG;QAAqB,OAAO,EAApB,MAAM;QACO,MAAM,EAAnB,MAAM;QACK,IAAI;;oBAsLk/G,CAAC;0BAA4B,CAAC;wBAA0B,CAAC;sBAAwB,CAAC;uBAAyB,CAAC;uBAAyB,CAAC;0BAA4B,CAAC;6BAAgC,CAAC;2BAA8B,CAAC;mBAAsB,CAAC;;;wBAAg+B,CAAC;8BAA4B,CAAC;4BAA0B,CAAC;0BAAwB,CAAC;2BAAyB,CAAC;2BAAyB,CAAC;8BAA4B,CAAC;iCAAgC,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAA+0O,CAAC;8BAAmC,CAAC;iCAAgC,CAAC;;;;;;;;;;;;;;;;;;;;;;;wBAAxnP,CAAC;8BAA4B,CAAC;4BAA0B,CAAC;0BAAwB,CAAC;2BAAyB,CAAC;2BAAyB,CAAC;8BAA4B,CAAC;iCAAgC,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAA+0O,CAAC;8BAAmC,CAAC;iCAAgC,CAAC;;;;;;;;;;;;;;;0BAAxgW,CAAC;0BAAmC,CAAC;6BAAgC,CAAC;;;;wBAA00G,CAAC;8BAA4B,CAAC;4BAA0B,CAAC;0BAAwB,CAAC;2BAAyB,CAAC;2BAAyB,CAAC;8BAA4B,CAAC;iCAAgC,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAA+0O,CAAC;8BAAmC,CAAC;iCAAgC,CAAC;;;;;;;;KArL31Y,GAAU,OAAO,CAAC,KAAK,CAAC,CAoB1B;IA/BD,uBAEC;IAyJD;;;;;;OAmCC;;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Configuration.d.ts","sourceRoot":"","sources":["../../src/Configuration.js"],"names":[],"mappings":"AAUA;IACE;;;;;;OAwIC;;CAgPF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ConfigurationParameters.d.ts","sourceRoot":"","sources":["../../src/ConfigurationParameters.js"],"names":[],"mappings":"AAEA,6CA6IE;AAEF,+CAA6E"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export default class Conveyor {
|
|
2
|
+
constructor({ parse, print, glog, contract, output }: {
|
|
3
|
+
parse: any;
|
|
4
|
+
print: any;
|
|
5
|
+
glog: any;
|
|
6
|
+
contract: any;
|
|
7
|
+
output: any;
|
|
8
|
+
});
|
|
9
|
+
/**
|
|
10
|
+
* Defines the per-file processing pipeline.
|
|
11
|
+
*
|
|
12
|
+
* @param {ActionBuilder} builder - The Actioneer builder instance.
|
|
13
|
+
*/
|
|
14
|
+
setup(builder: ActionBuilder): void;
|
|
15
|
+
/**
|
|
16
|
+
* Processes files through the parse→print pipeline with concurrency.
|
|
17
|
+
*
|
|
18
|
+
* @param {Array<FileObject>} files - List of files to process.
|
|
19
|
+
* @param {number} maxConcurrent - Maximum number of concurrent tasks.
|
|
20
|
+
* @returns {Promise<object>} - Resolves with {succeeded, errored, warned}.
|
|
21
|
+
*/
|
|
22
|
+
convey(files: Array<FileObject>, maxConcurrent?: number): Promise<object>;
|
|
23
|
+
#private;
|
|
24
|
+
}
|
|
25
|
+
import { ActionBuilder } from "@gesslar/actioneer";
|
|
26
|
+
import { FileObject } from "@gesslar/toolkit";
|
|
27
|
+
//# sourceMappingURL=Conveyor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Conveyor.d.ts","sourceRoot":"","sources":["../../src/Conveyor.js"],"names":[],"mappings":"AAKA;IAOE;;;;;;OAMC;IAED;;;;OAIG;IACH,eAFW,aAAa,QASvB;IAED;;;;;;OAMG;IACH,cAJW,KAAK,CAAC,UAAU,CAAC,kBACjB,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAS3B;;CAsGF;8BAtJmD,oBAAoB;2BACzC,kBAAkB"}
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @import {Glog} from "@gesslar/toolkit"
|
|
3
|
+
*/
|
|
4
|
+
export default class Discovery {
|
|
5
|
+
/**
|
|
6
|
+
* Constructor for Discovery.
|
|
7
|
+
*
|
|
8
|
+
* @param {object} arg - Constructor argument
|
|
9
|
+
* @param {object} arg.options - BeDoc options
|
|
10
|
+
* @param {Glog} arg.glog - Glog instance
|
|
11
|
+
*/
|
|
12
|
+
constructor({ options, glog }: {
|
|
13
|
+
options: object;
|
|
14
|
+
glog: {
|
|
15
|
+
new (options?: {
|
|
16
|
+
name?: string;
|
|
17
|
+
debugLevel?: number;
|
|
18
|
+
logLevel?: number;
|
|
19
|
+
prefix?: string;
|
|
20
|
+
colours?: object;
|
|
21
|
+
symbols?: object;
|
|
22
|
+
stackTrace?: boolean;
|
|
23
|
+
tagsAsStrings?: boolean;
|
|
24
|
+
displayName?: boolean;
|
|
25
|
+
env?: string;
|
|
26
|
+
}): {
|
|
27
|
+
setOptions(options: {
|
|
28
|
+
name?: string;
|
|
29
|
+
debugLevel?: number;
|
|
30
|
+
logLevel?: number;
|
|
31
|
+
prefix?: string;
|
|
32
|
+
colours?: object;
|
|
33
|
+
symbols?: object;
|
|
34
|
+
stackTrace?: boolean;
|
|
35
|
+
tagsAsStrings?: boolean;
|
|
36
|
+
displayName?: boolean;
|
|
37
|
+
}): /*elided*/ any;
|
|
38
|
+
withName(name: string): /*elided*/ any;
|
|
39
|
+
withLogLevel(level: number): /*elided*/ any;
|
|
40
|
+
withPrefix(prefix: string): /*elided*/ any;
|
|
41
|
+
withColours(colours?: object): /*elided*/ any;
|
|
42
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
43
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
44
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
45
|
+
noDisplayName(): /*elided*/ any;
|
|
46
|
+
use(prefix: string): object;
|
|
47
|
+
get name(): string;
|
|
48
|
+
get debugLevel(): number;
|
|
49
|
+
get options(): object;
|
|
50
|
+
newDebug(tag: string): Function;
|
|
51
|
+
debug(message: string, level?: number, ...arg: unknown[]): void;
|
|
52
|
+
info(message: string, ...arg: unknown[]): void;
|
|
53
|
+
warn(message: string, ...arg: unknown[]): void;
|
|
54
|
+
error(message: string, ...arg: unknown[]): void;
|
|
55
|
+
execute(...args: unknown[]): void;
|
|
56
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
57
|
+
success(message: string, ...args: unknown[]): void;
|
|
58
|
+
group(...args: unknown[]): void;
|
|
59
|
+
groupEnd(): void;
|
|
60
|
+
groupDebug(message: string, level?: number): void;
|
|
61
|
+
groupInfo(message: string): void;
|
|
62
|
+
groupSuccess(message: string): void;
|
|
63
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
64
|
+
properties?: Array<string>;
|
|
65
|
+
showHeader?: boolean;
|
|
66
|
+
quotedStrings?: boolean;
|
|
67
|
+
}): void;
|
|
68
|
+
get colours(): any;
|
|
69
|
+
get raw(): object;
|
|
70
|
+
"__#private@#private": any;
|
|
71
|
+
};
|
|
72
|
+
logLevel: number;
|
|
73
|
+
logPrefix: string;
|
|
74
|
+
colours: any;
|
|
75
|
+
stackTrace: boolean;
|
|
76
|
+
name: string;
|
|
77
|
+
tagsAsStrings: boolean;
|
|
78
|
+
symbols: any;
|
|
79
|
+
setLogPrefix(prefix: string): /*elided*/ any;
|
|
80
|
+
setLogLevel(level: number): /*elided*/ any;
|
|
81
|
+
withName(name: string): /*elided*/ any;
|
|
82
|
+
withColours(colours?: object): /*elided*/ any;
|
|
83
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
84
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
85
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
86
|
+
use(prefix: string): object;
|
|
87
|
+
create(options?: object): {
|
|
88
|
+
setOptions(options: {
|
|
89
|
+
name?: string;
|
|
90
|
+
debugLevel?: number;
|
|
91
|
+
logLevel?: number;
|
|
92
|
+
prefix?: string;
|
|
93
|
+
colours?: object;
|
|
94
|
+
symbols?: object;
|
|
95
|
+
stackTrace?: boolean;
|
|
96
|
+
tagsAsStrings?: boolean;
|
|
97
|
+
displayName?: boolean;
|
|
98
|
+
}): /*elided*/ any;
|
|
99
|
+
withName(name: string): /*elided*/ any;
|
|
100
|
+
withLogLevel(level: number): /*elided*/ any;
|
|
101
|
+
withPrefix(prefix: string): /*elided*/ any;
|
|
102
|
+
withColours(colours?: object): /*elided*/ any;
|
|
103
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
104
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
105
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
106
|
+
noDisplayName(): /*elided*/ any;
|
|
107
|
+
use(prefix: string): object;
|
|
108
|
+
get name(): string;
|
|
109
|
+
get debugLevel(): number;
|
|
110
|
+
get options(): object;
|
|
111
|
+
newDebug(tag: string): Function;
|
|
112
|
+
debug(message: string, level?: number, ...arg: unknown[]): void;
|
|
113
|
+
info(message: string, ...arg: unknown[]): void;
|
|
114
|
+
warn(message: string, ...arg: unknown[]): void;
|
|
115
|
+
error(message: string, ...arg: unknown[]): void;
|
|
116
|
+
execute(...args: unknown[]): void;
|
|
117
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
118
|
+
success(message: string, ...args: unknown[]): void;
|
|
119
|
+
group(...args: unknown[]): void;
|
|
120
|
+
groupEnd(): void;
|
|
121
|
+
groupDebug(message: string, level?: number): void;
|
|
122
|
+
groupInfo(message: string): void;
|
|
123
|
+
groupSuccess(message: string): void;
|
|
124
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
125
|
+
properties?: Array<string>;
|
|
126
|
+
showHeader?: boolean;
|
|
127
|
+
quotedStrings?: boolean;
|
|
128
|
+
}): void;
|
|
129
|
+
get colours(): any;
|
|
130
|
+
get raw(): object;
|
|
131
|
+
"__#private@#private": any;
|
|
132
|
+
};
|
|
133
|
+
execute(...args: unknown[]): void;
|
|
134
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
135
|
+
success(message: string, ...args: unknown[]): void;
|
|
136
|
+
group(...args: unknown[]): void;
|
|
137
|
+
groupEnd(): void;
|
|
138
|
+
groupDebug(message: string, level?: number): void;
|
|
139
|
+
groupInfo(message: string): void;
|
|
140
|
+
groupSuccess(message: string): void;
|
|
141
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
142
|
+
properties?: Array<string>;
|
|
143
|
+
showHeader?: boolean;
|
|
144
|
+
quotedStrings?: boolean;
|
|
145
|
+
}): void;
|
|
146
|
+
setAlias(alias: string, colourCode: string): {
|
|
147
|
+
setOptions(options: {
|
|
148
|
+
name?: string;
|
|
149
|
+
debugLevel?: number;
|
|
150
|
+
logLevel?: number;
|
|
151
|
+
prefix?: string;
|
|
152
|
+
colours?: object;
|
|
153
|
+
symbols?: object;
|
|
154
|
+
stackTrace?: boolean;
|
|
155
|
+
tagsAsStrings?: boolean;
|
|
156
|
+
displayName?: boolean;
|
|
157
|
+
}): /*elided*/ any;
|
|
158
|
+
withName(name: string): /*elided*/ any;
|
|
159
|
+
withLogLevel(level: number): /*elided*/ any;
|
|
160
|
+
withPrefix(prefix: string): /*elided*/ any;
|
|
161
|
+
withColours(colours?: object): /*elided*/ any;
|
|
162
|
+
withStackTrace(enabled?: boolean): /*elided*/ any;
|
|
163
|
+
withTagsAsStrings(enabled?: boolean): /*elided*/ any;
|
|
164
|
+
withSymbols(symbols?: object): /*elided*/ any;
|
|
165
|
+
noDisplayName(): /*elided*/ any;
|
|
166
|
+
use(prefix: string): object;
|
|
167
|
+
get name(): string;
|
|
168
|
+
get debugLevel(): number;
|
|
169
|
+
get options(): object;
|
|
170
|
+
newDebug(tag: string): Function;
|
|
171
|
+
debug(message: string, level?: number, ...arg: unknown[]): void;
|
|
172
|
+
info(message: string, ...arg: unknown[]): void;
|
|
173
|
+
warn(message: string, ...arg: unknown[]): void;
|
|
174
|
+
error(message: string, ...arg: unknown[]): void;
|
|
175
|
+
execute(...args: unknown[]): void;
|
|
176
|
+
colourize(strings: Array<string>, ...values: unknown[]): void;
|
|
177
|
+
success(message: string, ...args: unknown[]): void;
|
|
178
|
+
group(...args: unknown[]): void;
|
|
179
|
+
groupEnd(): void;
|
|
180
|
+
groupDebug(message: string, level?: number): void;
|
|
181
|
+
groupInfo(message: string): void;
|
|
182
|
+
groupSuccess(message: string): void;
|
|
183
|
+
table(data: object | any[], labelOrOptions?: string | object, options?: {
|
|
184
|
+
properties?: Array<string>;
|
|
185
|
+
showHeader?: boolean;
|
|
186
|
+
quotedStrings?: boolean;
|
|
187
|
+
}): void;
|
|
188
|
+
get colours(): any;
|
|
189
|
+
get raw(): object;
|
|
190
|
+
"__#private@#private": any;
|
|
191
|
+
};
|
|
192
|
+
get raw(): object;
|
|
193
|
+
};
|
|
194
|
+
});
|
|
195
|
+
/**
|
|
196
|
+
* Discover actions from local or global node_modules
|
|
197
|
+
*
|
|
198
|
+
* @param {object} [specific] Configuration options for action discovery
|
|
199
|
+
* @param {FileObject} [specific.print] Print-related configuration options
|
|
200
|
+
* @param {FileObject} [specific.parse] Parse-related configuration options
|
|
201
|
+
* @param {Function} validateBeDocSchema - The validator function for BeDoc's action schema
|
|
202
|
+
* @returns {Promise<object>} A map of discovered modules
|
|
203
|
+
*/
|
|
204
|
+
discoverActions(specific?: {
|
|
205
|
+
print?: FileObject;
|
|
206
|
+
parse?: FileObject;
|
|
207
|
+
}, validateBeDocSchema: Function): Promise<object>;
|
|
208
|
+
satisfyCriteria(actions: any, validatedConfig: any): {
|
|
209
|
+
parse: any[];
|
|
210
|
+
print: any[];
|
|
211
|
+
};
|
|
212
|
+
#private;
|
|
213
|
+
}
|
|
214
|
+
import { FileObject } from "@gesslar/toolkit";
|
|
215
|
+
//# sourceMappingURL=Discovery.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Discovery.d.ts","sourceRoot":"","sources":["../../src/Discovery.js"],"names":[],"mappings":"AAOA;;GAEG;AAEH;IAME;;;;;;OAMG;IACH,+BAHG;QAAoB,OAAO,EAAnB,MAAM;QACI,IAAI;;oBAiQb,CAAC;0BACX,CAAA;wBAA0B,CAAC;sBACrB,CAAC;uBAAyB,CAAC;uBAC/B,CAAA;0BAA4B,CAAC;6BAG7B,CAAD;2BAA8B,CAAC;mBAE3B,CAAC;;;wBAuCN,CAAF;8BAEE,CAAF;4BAA0B,CAAC;0BAAwB,CAAC;2BAEpC,CAAC;2BACf,CAAJ;8BACM,CAAC;iCAAgC,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BA6FizI,CAAC;8BAAmC,CAAC;iCAAgC,CAAC;;;;;;;;;;;;;;;;;;;;;;;wBAnG17I,CAAF;8BAEE,CAAF;4BAA0B,CAAC;0BAAwB,CAAC;2BAEpC,CAAC;2BACf,CAAJ;8BACM,CAAC;iCAAgC,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BA6FizI,CAAC;8BAAmC,CAAC;iCAAgC,CAAC;;;;;;;;;;;;;;;0BA/Nl5I,CAAC;0BACjB,CAAC;6BAInB,CAAA;;;;wBAuHN,CAAF;8BAEE,CAAF;4BAA0B,CAAC;0BAAwB,CAAC;2BAEpC,CAAC;2BACf,CAAJ;8BACM,CAAC;iCAAgC,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BA6FizI,CAAC;8BAAmC,CAAC;iCAAgC,CAAC;;;;;;;;KAlZ37I,EAIA;IAED;;;;;;;;OAQG;IACH,2BALG;QAA8B,KAAK,GAA3B,UAAU;QACY,KAAK,GAA3B,UAAU;KAClB,kCACU,OAAO,CAAC,MAAM,CAAC,CA4I3B;IAqJD;;;MAsDC;;CA6CF;2BAva2E,kBAAkB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Environment.d.ts","sourceRoot":"","sources":["../../src/Environment.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
export namespace loggerColours {
|
|
2
|
+
let debug: string[];
|
|
3
|
+
let info: string;
|
|
4
|
+
let warn: string;
|
|
5
|
+
let error: string;
|
|
6
|
+
let reset: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Logger class
|
|
10
|
+
*
|
|
11
|
+
* Log levels:
|
|
12
|
+
* - debug: Debugging information
|
|
13
|
+
* - Debug levels
|
|
14
|
+
* - 0: No/critical debug information, not error level, but, should be
|
|
15
|
+
* logged
|
|
16
|
+
* - 1: Basic debug information, startup, shutdown, etc
|
|
17
|
+
* - 2: Intermediate debug information, discovery, starting to get more
|
|
18
|
+
* detailed
|
|
19
|
+
* - 3: Detailed debug information, parsing, processing, etc
|
|
20
|
+
* - 4: Very detailed debug information, nerd mode!
|
|
21
|
+
* - warn: Warning information
|
|
22
|
+
* - info: Informational information
|
|
23
|
+
* - error: Error information
|
|
24
|
+
*/
|
|
25
|
+
export default class Logger {
|
|
26
|
+
constructor(options: any);
|
|
27
|
+
vscodeError: any;
|
|
28
|
+
vscodeWarn: any;
|
|
29
|
+
vscodeInfo: any;
|
|
30
|
+
get name(): any;
|
|
31
|
+
get debugLevel(): number;
|
|
32
|
+
get options(): {
|
|
33
|
+
name: any;
|
|
34
|
+
debugLevel: number;
|
|
35
|
+
};
|
|
36
|
+
setOptions(options: any): void;
|
|
37
|
+
lastStackLine(error?: Error, stepsRemoved?: number): ErrorStackParser.StackFrame;
|
|
38
|
+
extractFileFunction(level?: number): string;
|
|
39
|
+
newDebug(tag: any): any;
|
|
40
|
+
debug(message: any, level?: number, ...arg: any[]): void;
|
|
41
|
+
warn(message: any, ...arg: any[]): void;
|
|
42
|
+
info(message: any, ...arg: any[]): void;
|
|
43
|
+
error(message: any, ...arg: any[]): void;
|
|
44
|
+
#private;
|
|
45
|
+
}
|
|
46
|
+
import ErrorStackParser from "error-stack-parser";
|
|
47
|
+
//# sourceMappingURL=Logger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.js"],"names":[],"mappings":";;;;;;;AA4CA;;;;;;;;;;;;;;;;GAgBG;AAEH;IAIE,0BAYC;IALK,iBAAiD;IACjD,gBAAkD;IAClD,gBAAsD;IAK5D,gBAEC;IAED,yBAEC;IAED;;;MAKC;IAED,+BAGC;IAWD,iFAIC;IAED,4CAsCC;IAED,wBAKC;IAED,yDAGC;IAED,wCAGC;IAED,wCAGC;IAED,yCAGC;;CACF;6BA5J4B,oBAAoB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.js"],"names":[],"mappings":""}
|
package/dist/types/cli.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
export {}
|
|
3
|
-
//# sourceMappingURL=cli.d.ts.map
|
|
2
|
+
export {};
|
|
3
|
+
//# sourceMappingURL=cli.d.ts.map
|