@stephansama/auto-readme 0.2.2 → 0.2.4
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/README.md +19 -61
- package/config/schema.cjs +32 -36
- package/config/schema.d.cts +49 -91
- package/config/schema.d.ts +49 -91
- package/config/schema.js +22 -23
- package/config/schema.json +1 -1
- package/dist/index.cjs +48 -49
- package/dist/index.d.cts +1 -2
- package/dist/index.d.ts +1 -2
- package/dist/index.js +38 -39
- package/package.json +11 -12
- package/config/schema.cjs.map +0 -1
- package/config/schema.js.map +0 -1
- package/config/schema.yaml +0 -193
- package/dist/index.cjs.map +0 -1
- package/dist/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -180,25 +180,25 @@ _Enum, one of the following possible values:_
|
|
|
180
180
|
|
|
181
181
|
_Object containing the following properties:_
|
|
182
182
|
|
|
183
|
-
| Property | Description | Type
|
|
184
|
-
| :------------------------ | :---------------------------------------------------------- |
|
|
185
|
-
| `affectedRegexes` | | `Array<string>`
|
|
186
|
-
| `collapseHeadings` | | `Array<string>`
|
|
187
|
-
| `defaultLanguage` | Default language to infer projects from | [Language](#language)
|
|
188
|
-
| `disableEmojis` | Whether or not to use emojis in markdown table headings | `boolean`
|
|
189
|
-
| `disableMarkdownHeadings` | Whether or not to display markdown headings | `boolean`
|
|
190
|
-
| `enablePrettier` | Whether or not to use prettier to format the files | `boolean`
|
|
191
|
-
| `enableToc` | generate table of contents for readmes | `boolean`
|
|
192
|
-
| `enableUsage` | Whether or not to enable usage plugin | `boolean`
|
|
193
|
-
| `headings` | List of headings for different table outputs | _Object with dynamic keys of type_ [Actions](#actions) _and values of type_
|
|
194
|
-
| `onlyReadmes` | Whether or not to only traverse readmes | `boolean`
|
|
195
|
-
| `onlyShowPublicPackages` | Only show public packages in workspaces | `boolean`
|
|
196
|
-
| `removeScope` | Remove common workspace scope | `string`
|
|
197
|
-
| `templates` | Handlebars templates used to fuel list and table generation | _Object with properties:_<ul><li>`downloadImage`: `string`</li><li>`emojis`:
|
|
198
|
-
| `tocHeading` | Markdown heading used to generate table of contents | `string`
|
|
199
|
-
| `usageFile` | Workspace level usage file | `string`
|
|
200
|
-
| `usageHeading` | Markdown heading used to generate usage example | `string`
|
|
201
|
-
| `verbose` | whether or not to display verbose logging | `boolean`
|
|
183
|
+
| Property | Description | Type | Default |
|
|
184
|
+
| :------------------------ | :---------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
185
|
+
| `affectedRegexes` | | `Array<string>` | `[]` |
|
|
186
|
+
| `collapseHeadings` | | `Array<string>` | `[]` |
|
|
187
|
+
| `defaultLanguage` | Default language to infer projects from | [Language](#language) | |
|
|
188
|
+
| `disableEmojis` | Whether or not to use emojis in markdown table headings | `boolean` | `false` |
|
|
189
|
+
| `disableMarkdownHeadings` | Whether or not to display markdown headings | `boolean` | `false` |
|
|
190
|
+
| `enablePrettier` | Whether or not to use prettier to format the files | `boolean` | `true` |
|
|
191
|
+
| `enableToc` | generate table of contents for readmes | `boolean` | `false` |
|
|
192
|
+
| `enableUsage` | Whether or not to enable usage plugin | `boolean` | `false` |
|
|
193
|
+
| `headings` | List of headings for different table outputs | _Object with dynamic keys of type_ [Actions](#actions) _and values of type_ `Array<'default' \| 'description' \| 'devDependency' \| 'downloads' \| 'name' \| 'private' \| 'required' \| 'version'>` (_optional_) | `{"ACTION":["name","required","default","description"],"PKG":["name","version","devDependency"],"USAGE":[],"WORKSPACE":["name","version","downloads","description"],"ZOD":[]}` |
|
|
194
|
+
| `onlyReadmes` | Whether or not to only traverse readmes | `boolean` | `true` |
|
|
195
|
+
| `onlyShowPublicPackages` | Only show public packages in workspaces | `boolean` | `false` |
|
|
196
|
+
| `removeScope` | Remove common workspace scope | `string` | `''` |
|
|
197
|
+
| `templates` | Handlebars templates used to fuel list and table generation | _Object with properties:_<ul><li>`downloadImage`: `string`</li><li>`emojis`: `Record<'default' \| 'description' \| 'devDependency' \| 'downloads' \| 'name' \| 'private' \| 'required' \| 'version', string>` - Table heading emojis used when enabled</li><li>`registryUrl`: `string`</li><li>`versionImage`: `string`</li></ul> | `{"downloadImage":"https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F","emojis":{"default":"⚙️","description":"📝","devDependency":"💻","downloads":"📥","name":"🏷️","private":"🔒","required":"","version":""},"registryUrl":"https://www.npmjs.com/package/{{name}}","versionImage":"https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F"}` |
|
|
198
|
+
| `tocHeading` | Markdown heading used to generate table of contents | `string` | `'Table of contents'` |
|
|
199
|
+
| `usageFile` | Workspace level usage file | `string` | `''` |
|
|
200
|
+
| `usageHeading` | Markdown heading used to generate usage example | `string` | `'Usage'` |
|
|
201
|
+
| `verbose` | whether or not to display verbose logging | `boolean` | `false` |
|
|
202
202
|
|
|
203
203
|
_All properties are optional._ (_optional_)
|
|
204
204
|
|
|
@@ -208,58 +208,16 @@ _Enum, one of the following possible values:_
|
|
|
208
208
|
|
|
209
209
|
- `'LIST'`
|
|
210
210
|
- `'TABLE'`
|
|
211
|
-
(_optional_)
|
|
212
211
|
|
|
213
212
|
_Default value:_ `'TABLE'`
|
|
214
213
|
|
|
215
|
-
## Headings
|
|
216
|
-
|
|
217
|
-
Table heading options
|
|
218
|
-
|
|
219
|
-
_Enum, one of the following possible values:_
|
|
220
|
-
|
|
221
|
-
- `'default'`
|
|
222
|
-
- `'description'`
|
|
223
|
-
- `'devDependency'`
|
|
224
|
-
- `'downloads'`
|
|
225
|
-
- `'name'`
|
|
226
|
-
- `'private'`
|
|
227
|
-
- `'required'`
|
|
228
|
-
- `'version'`
|
|
229
|
-
|
|
230
214
|
## Language
|
|
231
215
|
|
|
232
216
|
_Enum, one of the following possible values:_
|
|
233
217
|
|
|
234
218
|
- `'JS'`
|
|
235
219
|
- `'RS'`
|
|
236
|
-
(_optional_)
|
|
237
220
|
|
|
238
221
|
_Default value:_ `'JS'`
|
|
239
222
|
|
|
240
|
-
## TableHeadings
|
|
241
|
-
|
|
242
|
-
Table heading action configuration
|
|
243
|
-
|
|
244
|
-
_Object record with dynamic keys:_
|
|
245
|
-
|
|
246
|
-
- _keys of type_ [Actions](#actions)
|
|
247
|
-
- _values of type_ _Array of [Headings](#headings) items_ (_optional_)
|
|
248
|
-
(_optional_)
|
|
249
|
-
|
|
250
|
-
_Default value:_ `{"ACTION":["name","required","default","description"],"PKG":["name","version","devDependency"],"WORKSPACE":["name","version","downloads","description"],"ZOD":[]}`
|
|
251
|
-
|
|
252
|
-
## Templates
|
|
253
|
-
|
|
254
|
-
_Object containing the following properties:_
|
|
255
|
-
|
|
256
|
-
| Property | Description | Type | Default |
|
|
257
|
-
| :-------------- | :------------------------------------- | :------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
|
|
258
|
-
| `downloadImage` | | `string` | `'https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F'` |
|
|
259
|
-
| `emojis` | Table heading emojis used when enabled | _Object with dynamic keys of type_ [Headings](#headings) _and values of type_ `string` | `{"default":"⚙️","description":"📝","devDependency":"💻","downloads":"📥","name":"🏷️","private":"🔒","required":"","version":""}` |
|
|
260
|
-
| `registryUrl` | | `string` | `'https://www.npmjs.com/package/{{name}}'` |
|
|
261
|
-
| `versionImage` | | `string` | `'https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F'` |
|
|
262
|
-
|
|
263
|
-
_All properties are optional._
|
|
264
|
-
|
|
265
223
|
<!-- ZOD end -->
|
package/config/schema.cjs
CHANGED
|
@@ -24,17 +24,17 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
24
24
|
let zod = require("zod");
|
|
25
25
|
zod = __toESM(zod);
|
|
26
26
|
|
|
27
|
-
//#region src/schema.
|
|
28
|
-
const actionsSchema = zod.
|
|
27
|
+
//#region src/schema.ts
|
|
28
|
+
const actionsSchema = zod.enum([
|
|
29
29
|
"ACTION",
|
|
30
30
|
"PKG",
|
|
31
31
|
"USAGE",
|
|
32
32
|
"WORKSPACE",
|
|
33
33
|
"ZOD"
|
|
34
|
-
]).
|
|
35
|
-
const formatsSchema = zod.
|
|
36
|
-
const languageSchema = zod.
|
|
37
|
-
const headingsSchema = zod.
|
|
34
|
+
]).meta({ description: "Comment action options" });
|
|
35
|
+
const formatsSchema = zod.enum(["LIST", "TABLE"]).default("TABLE");
|
|
36
|
+
const languageSchema = zod.enum(["JS", "RS"]).default("JS");
|
|
37
|
+
const headingsSchema = zod.enum([
|
|
38
38
|
"default",
|
|
39
39
|
"description",
|
|
40
40
|
"devDependency",
|
|
@@ -43,8 +43,8 @@ const headingsSchema = zod.z.enum([
|
|
|
43
43
|
"private",
|
|
44
44
|
"required",
|
|
45
45
|
"version"
|
|
46
|
-
]).
|
|
47
|
-
const tableHeadingsSchema = zod.
|
|
46
|
+
]).meta({ description: "Table heading options" });
|
|
47
|
+
const tableHeadingsSchema = zod.record(actionsSchema, headingsSchema.array().optional()).default({
|
|
48
48
|
ACTION: [
|
|
49
49
|
"name",
|
|
50
50
|
"required",
|
|
@@ -56,6 +56,7 @@ const tableHeadingsSchema = zod.z.record(actionsSchema, headingsSchema.array().o
|
|
|
56
56
|
"version",
|
|
57
57
|
"devDependency"
|
|
58
58
|
],
|
|
59
|
+
USAGE: [],
|
|
59
60
|
WORKSPACE: [
|
|
60
61
|
"name",
|
|
61
62
|
"version",
|
|
@@ -63,10 +64,10 @@ const tableHeadingsSchema = zod.z.record(actionsSchema, headingsSchema.array().o
|
|
|
63
64
|
"description"
|
|
64
65
|
],
|
|
65
66
|
ZOD: []
|
|
66
|
-
});
|
|
67
|
-
const templatesSchema = zod.
|
|
68
|
-
downloadImage: zod.
|
|
69
|
-
emojis: zod.
|
|
67
|
+
}).meta({ description: "Table heading action configuration" });
|
|
68
|
+
const templatesSchema = zod.object({
|
|
69
|
+
downloadImage: zod.string().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
|
|
70
|
+
emojis: zod.record(headingsSchema, zod.string()).default({
|
|
70
71
|
default: "⚙️",
|
|
71
72
|
description: "📝",
|
|
72
73
|
devDependency: "💻",
|
|
@@ -75,51 +76,50 @@ const templatesSchema = zod.z.object({
|
|
|
75
76
|
private: "🔒",
|
|
76
77
|
required: "",
|
|
77
78
|
version: ""
|
|
78
|
-
}),
|
|
79
|
-
registryUrl: zod.
|
|
80
|
-
versionImage: zod.
|
|
79
|
+
}).meta({ description: "Table heading emojis used when enabled" }),
|
|
80
|
+
registryUrl: zod.string().default("https://www.npmjs.com/package/{{name}}"),
|
|
81
|
+
versionImage: zod.string().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
|
|
81
82
|
});
|
|
82
83
|
const defaultTemplates = templatesSchema.parse({});
|
|
83
84
|
const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
|
|
84
|
-
const _configSchema = zod.
|
|
85
|
-
affectedRegexes: zod.
|
|
86
|
-
collapseHeadings: zod.
|
|
85
|
+
const _configSchema = zod.object({
|
|
86
|
+
affectedRegexes: zod.string().array().default([]),
|
|
87
|
+
collapseHeadings: zod.string().array().default([]),
|
|
87
88
|
defaultLanguage: languageSchema.meta({
|
|
88
89
|
alias: "l",
|
|
89
90
|
description: "Default language to infer projects from"
|
|
90
91
|
}),
|
|
91
|
-
disableEmojis: zod.
|
|
92
|
+
disableEmojis: zod.boolean().default(false).meta({
|
|
92
93
|
alias: "e",
|
|
93
94
|
description: "Whether or not to use emojis in markdown table headings"
|
|
94
95
|
}),
|
|
95
|
-
disableMarkdownHeadings: zod.
|
|
96
|
-
enablePrettier: zod.
|
|
97
|
-
enableToc: zod.
|
|
96
|
+
disableMarkdownHeadings: zod.boolean().default(false).meta({ description: "Whether or not to display markdown headings" }),
|
|
97
|
+
enablePrettier: zod.boolean().default(true).meta({ description: "Whether or not to use prettier to format the files" }),
|
|
98
|
+
enableToc: zod.boolean().default(false).meta({
|
|
98
99
|
alias: "t",
|
|
99
100
|
description: "generate table of contents for readmes"
|
|
100
101
|
}),
|
|
101
|
-
enableUsage: zod.
|
|
102
|
+
enableUsage: zod.boolean().default(false).meta({ description: "Whether or not to enable usage plugin" }),
|
|
102
103
|
headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
|
|
103
|
-
onlyReadmes: zod.
|
|
104
|
+
onlyReadmes: zod.boolean().default(true).meta({
|
|
104
105
|
alias: "r",
|
|
105
106
|
description: "Whether or not to only traverse readmes"
|
|
106
107
|
}),
|
|
107
|
-
onlyShowPublicPackages: zod.
|
|
108
|
+
onlyShowPublicPackages: zod.boolean().default(false).meta({
|
|
108
109
|
alias: "p",
|
|
109
110
|
description: "Only show public packages in workspaces"
|
|
110
111
|
}),
|
|
111
|
-
removeScope: zod.
|
|
112
|
+
removeScope: zod.string().default("").meta({ description: "Remove common workspace scope" }),
|
|
112
113
|
templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
|
|
113
|
-
tocHeading: zod.
|
|
114
|
-
usageFile: zod.
|
|
115
|
-
usageHeading: zod.
|
|
116
|
-
verbose: zod.
|
|
114
|
+
tocHeading: zod.string().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
|
|
115
|
+
usageFile: zod.string().default("").meta({ description: "Workspace level usage file" }),
|
|
116
|
+
usageHeading: zod.string().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
|
|
117
|
+
verbose: zod.boolean().default(false).meta({
|
|
117
118
|
alias: "v",
|
|
118
119
|
description: "whether or not to display verbose logging"
|
|
119
120
|
})
|
|
120
121
|
});
|
|
121
122
|
const configSchema = _configSchema.optional();
|
|
122
|
-
/** @typedef {Partial<z.infer<typeof _configSchema>>} Config */
|
|
123
123
|
|
|
124
124
|
//#endregion
|
|
125
125
|
exports.actionsSchema = actionsSchema;
|
|
@@ -127,8 +127,4 @@ exports.configSchema = configSchema;
|
|
|
127
127
|
exports.defaultTableHeadings = defaultTableHeadings;
|
|
128
128
|
exports.defaultTemplates = defaultTemplates;
|
|
129
129
|
exports.formatsSchema = formatsSchema;
|
|
130
|
-
exports.
|
|
131
|
-
exports.languageSchema = languageSchema;
|
|
132
|
-
exports.tableHeadingsSchema = tableHeadingsSchema;
|
|
133
|
-
exports.templatesSchema = templatesSchema;
|
|
134
|
-
//# sourceMappingURL=schema.cjs.map
|
|
130
|
+
exports.languageSchema = languageSchema;
|
package/config/schema.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import * as z from "zod";
|
|
2
2
|
|
|
3
3
|
//#region src/schema.d.ts
|
|
4
4
|
declare const actionsSchema: z.ZodEnum<{
|
|
@@ -8,165 +8,123 @@ declare const actionsSchema: z.ZodEnum<{
|
|
|
8
8
|
WORKSPACE: "WORKSPACE";
|
|
9
9
|
ZOD: "ZOD";
|
|
10
10
|
}>;
|
|
11
|
-
declare const formatsSchema: z.
|
|
11
|
+
declare const formatsSchema: z.ZodDefault<z.ZodEnum<{
|
|
12
12
|
LIST: "LIST";
|
|
13
13
|
TABLE: "TABLE";
|
|
14
|
-
}
|
|
15
|
-
declare const languageSchema: z.ZodDefault<z.
|
|
14
|
+
}>>;
|
|
15
|
+
declare const languageSchema: z.ZodDefault<z.ZodEnum<{
|
|
16
16
|
JS: "JS";
|
|
17
17
|
RS: "RS";
|
|
18
|
-
}
|
|
19
|
-
declare const headingsSchema: z.ZodEnum<{
|
|
20
|
-
default: "default";
|
|
21
|
-
description: "description";
|
|
22
|
-
devDependency: "devDependency";
|
|
23
|
-
downloads: "downloads";
|
|
24
|
-
name: "name";
|
|
25
|
-
private: "private";
|
|
26
|
-
required: "required";
|
|
27
|
-
version: "version";
|
|
28
|
-
}>;
|
|
29
|
-
declare const tableHeadingsSchema: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
30
|
-
ACTION: "ACTION";
|
|
31
|
-
PKG: "PKG";
|
|
32
|
-
USAGE: "USAGE";
|
|
33
|
-
WORKSPACE: "WORKSPACE";
|
|
34
|
-
ZOD: "ZOD";
|
|
35
|
-
}>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
36
|
-
default: "default";
|
|
37
|
-
description: "description";
|
|
38
|
-
devDependency: "devDependency";
|
|
39
|
-
downloads: "downloads";
|
|
40
|
-
name: "name";
|
|
41
|
-
private: "private";
|
|
42
|
-
required: "required";
|
|
43
|
-
version: "version";
|
|
44
|
-
}>>>>>>;
|
|
45
|
-
declare const templatesSchema: z.ZodObject<{
|
|
46
|
-
downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
47
|
-
emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
48
|
-
default: "default";
|
|
49
|
-
description: "description";
|
|
50
|
-
devDependency: "devDependency";
|
|
51
|
-
downloads: "downloads";
|
|
52
|
-
name: "name";
|
|
53
|
-
private: "private";
|
|
54
|
-
required: "required";
|
|
55
|
-
version: "version";
|
|
56
|
-
}>, z.ZodString>>>;
|
|
57
|
-
registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
58
|
-
versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
59
|
-
}, z.core.$strip>;
|
|
18
|
+
}>>;
|
|
60
19
|
declare const defaultTemplates: {
|
|
61
20
|
downloadImage: string;
|
|
62
|
-
emojis: Record<"
|
|
21
|
+
emojis: Record<"description" | "default" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>;
|
|
63
22
|
registryUrl: string;
|
|
64
23
|
versionImage: string;
|
|
65
24
|
};
|
|
66
|
-
declare const defaultTableHeadings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD", ("
|
|
67
|
-
declare const
|
|
68
|
-
affectedRegexes: z.ZodDefault<z.
|
|
69
|
-
collapseHeadings: z.ZodDefault<z.
|
|
70
|
-
defaultLanguage: z.ZodDefault<z.
|
|
25
|
+
declare const defaultTableHeadings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD", ("description" | "default" | "devDependency" | "downloads" | "name" | "private" | "required" | "version")[] | undefined>;
|
|
26
|
+
declare const _configSchema: z.ZodObject<{
|
|
27
|
+
affectedRegexes: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
28
|
+
collapseHeadings: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
29
|
+
defaultLanguage: z.ZodDefault<z.ZodEnum<{
|
|
71
30
|
JS: "JS";
|
|
72
31
|
RS: "RS";
|
|
73
|
-
}
|
|
32
|
+
}>>;
|
|
74
33
|
disableEmojis: z.ZodDefault<z.ZodBoolean>;
|
|
75
34
|
disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
|
|
76
35
|
enablePrettier: z.ZodDefault<z.ZodBoolean>;
|
|
77
36
|
enableToc: z.ZodDefault<z.ZodBoolean>;
|
|
78
|
-
enableUsage: z.ZodDefault<z.
|
|
79
|
-
headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.
|
|
37
|
+
enableUsage: z.ZodDefault<z.ZodBoolean>;
|
|
38
|
+
headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodRecord<z.ZodEnum<{
|
|
80
39
|
ACTION: "ACTION";
|
|
81
40
|
PKG: "PKG";
|
|
82
41
|
USAGE: "USAGE";
|
|
83
42
|
WORKSPACE: "WORKSPACE";
|
|
84
43
|
ZOD: "ZOD";
|
|
85
44
|
}>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
86
|
-
default: "default";
|
|
87
45
|
description: "description";
|
|
46
|
+
default: "default";
|
|
88
47
|
devDependency: "devDependency";
|
|
89
48
|
downloads: "downloads";
|
|
90
49
|
name: "name";
|
|
91
50
|
private: "private";
|
|
92
51
|
required: "required";
|
|
93
52
|
version: "version";
|
|
94
|
-
}
|
|
53
|
+
}>>>>>>>;
|
|
95
54
|
onlyReadmes: z.ZodDefault<z.ZodBoolean>;
|
|
96
55
|
onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
|
|
97
|
-
removeScope: z.ZodDefault<z.
|
|
56
|
+
removeScope: z.ZodDefault<z.ZodString>;
|
|
98
57
|
templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
|
|
99
|
-
downloadImage: z.ZodDefault<z.
|
|
100
|
-
emojis: z.ZodDefault<z.
|
|
101
|
-
default: "default";
|
|
58
|
+
downloadImage: z.ZodDefault<z.ZodString>;
|
|
59
|
+
emojis: z.ZodDefault<z.ZodRecord<z.ZodEnum<{
|
|
102
60
|
description: "description";
|
|
61
|
+
default: "default";
|
|
103
62
|
devDependency: "devDependency";
|
|
104
63
|
downloads: "downloads";
|
|
105
64
|
name: "name";
|
|
106
65
|
private: "private";
|
|
107
66
|
required: "required";
|
|
108
67
|
version: "version";
|
|
109
|
-
}>, z.ZodString
|
|
110
|
-
registryUrl: z.ZodDefault<z.
|
|
111
|
-
versionImage: z.ZodDefault<z.
|
|
68
|
+
}>, z.ZodString>>;
|
|
69
|
+
registryUrl: z.ZodDefault<z.ZodString>;
|
|
70
|
+
versionImage: z.ZodDefault<z.ZodString>;
|
|
112
71
|
}, z.core.$strip>>>;
|
|
113
|
-
tocHeading: z.ZodDefault<z.
|
|
114
|
-
usageFile: z.ZodDefault<z.
|
|
115
|
-
usageHeading: z.ZodDefault<z.
|
|
72
|
+
tocHeading: z.ZodDefault<z.ZodString>;
|
|
73
|
+
usageFile: z.ZodDefault<z.ZodString>;
|
|
74
|
+
usageHeading: z.ZodDefault<z.ZodString>;
|
|
116
75
|
verbose: z.ZodDefault<z.ZodBoolean>;
|
|
117
|
-
}, z.core.$strip
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
76
|
+
}, z.core.$strip>;
|
|
77
|
+
declare const configSchema: z.ZodOptional<z.ZodObject<{
|
|
78
|
+
affectedRegexes: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
79
|
+
collapseHeadings: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
80
|
+
defaultLanguage: z.ZodDefault<z.ZodEnum<{
|
|
123
81
|
JS: "JS";
|
|
124
82
|
RS: "RS";
|
|
125
|
-
}
|
|
83
|
+
}>>;
|
|
126
84
|
disableEmojis: z.ZodDefault<z.ZodBoolean>;
|
|
127
85
|
disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
|
|
128
86
|
enablePrettier: z.ZodDefault<z.ZodBoolean>;
|
|
129
87
|
enableToc: z.ZodDefault<z.ZodBoolean>;
|
|
130
|
-
enableUsage: z.ZodDefault<z.
|
|
131
|
-
headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.
|
|
88
|
+
enableUsage: z.ZodDefault<z.ZodBoolean>;
|
|
89
|
+
headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodRecord<z.ZodEnum<{
|
|
132
90
|
ACTION: "ACTION";
|
|
133
91
|
PKG: "PKG";
|
|
134
92
|
USAGE: "USAGE";
|
|
135
93
|
WORKSPACE: "WORKSPACE";
|
|
136
94
|
ZOD: "ZOD";
|
|
137
95
|
}>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
138
|
-
default: "default";
|
|
139
96
|
description: "description";
|
|
97
|
+
default: "default";
|
|
140
98
|
devDependency: "devDependency";
|
|
141
99
|
downloads: "downloads";
|
|
142
100
|
name: "name";
|
|
143
101
|
private: "private";
|
|
144
102
|
required: "required";
|
|
145
103
|
version: "version";
|
|
146
|
-
}
|
|
104
|
+
}>>>>>>>;
|
|
147
105
|
onlyReadmes: z.ZodDefault<z.ZodBoolean>;
|
|
148
106
|
onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
|
|
149
|
-
removeScope: z.ZodDefault<z.
|
|
107
|
+
removeScope: z.ZodDefault<z.ZodString>;
|
|
150
108
|
templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
|
|
151
|
-
downloadImage: z.ZodDefault<z.
|
|
152
|
-
emojis: z.ZodDefault<z.
|
|
153
|
-
default: "default";
|
|
109
|
+
downloadImage: z.ZodDefault<z.ZodString>;
|
|
110
|
+
emojis: z.ZodDefault<z.ZodRecord<z.ZodEnum<{
|
|
154
111
|
description: "description";
|
|
112
|
+
default: "default";
|
|
155
113
|
devDependency: "devDependency";
|
|
156
114
|
downloads: "downloads";
|
|
157
115
|
name: "name";
|
|
158
116
|
private: "private";
|
|
159
117
|
required: "required";
|
|
160
118
|
version: "version";
|
|
161
|
-
}>, z.ZodString
|
|
162
|
-
registryUrl: z.ZodDefault<z.
|
|
163
|
-
versionImage: z.ZodDefault<z.
|
|
119
|
+
}>, z.ZodString>>;
|
|
120
|
+
registryUrl: z.ZodDefault<z.ZodString>;
|
|
121
|
+
versionImage: z.ZodDefault<z.ZodString>;
|
|
164
122
|
}, z.core.$strip>>>;
|
|
165
|
-
tocHeading: z.ZodDefault<z.
|
|
166
|
-
usageFile: z.ZodDefault<z.
|
|
167
|
-
usageHeading: z.ZodDefault<z.
|
|
123
|
+
tocHeading: z.ZodDefault<z.ZodString>;
|
|
124
|
+
usageFile: z.ZodDefault<z.ZodString>;
|
|
125
|
+
usageHeading: z.ZodDefault<z.ZodString>;
|
|
168
126
|
verbose: z.ZodDefault<z.ZodBoolean>;
|
|
169
|
-
}, z.core.$strip
|
|
127
|
+
}, z.core.$strip>>;
|
|
128
|
+
type Config = Partial<z.infer<typeof _configSchema>>;
|
|
170
129
|
//#endregion
|
|
171
|
-
export { Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema,
|
|
172
|
-
//# sourceMappingURL=schema.d.cts.map
|
|
130
|
+
export { Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };
|