@stephansama/auto-readme 0.2.7 → 0.2.9
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/cli.mjs +2 -3
- package/config/schema.cjs +16 -19
- package/config/{schema.js → schema.mjs} +13 -16
- package/dist/index.cjs +130 -164
- package/dist/{index.js → index.mjs} +107 -128
- package/package.json +21 -24
- /package/config/{schema.d.ts → schema.d.mts} +0 -0
- /package/dist/{index.d.ts → index.d.mts} +0 -0
package/cli.mjs
CHANGED
package/config/schema.cjs
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
//#region \0rolldown/runtime.js
|
|
2
3
|
var __create = Object.create;
|
|
3
4
|
var __defProp = Object.defineProperty;
|
|
4
5
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
@@ -19,11 +20,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
19
20
|
value: mod,
|
|
20
21
|
enumerable: true
|
|
21
22
|
}) : target, mod));
|
|
22
|
-
|
|
23
23
|
//#endregion
|
|
24
24
|
let zod = require("zod");
|
|
25
|
-
zod = __toESM(zod);
|
|
26
|
-
|
|
25
|
+
zod = __toESM(zod, 1);
|
|
27
26
|
//#region src/schema.ts
|
|
28
27
|
const actionsSchema = zod.enum([
|
|
29
28
|
"ACTION",
|
|
@@ -66,8 +65,8 @@ const tableHeadingsSchema = zod.record(actionsSchema, headingsSchema.array().opt
|
|
|
66
65
|
ZOD: []
|
|
67
66
|
}).meta({ description: "Table heading action configuration" });
|
|
68
67
|
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({
|
|
68
|
+
downloadImage: zod.string().trim().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
|
|
69
|
+
emojis: zod.record(headingsSchema, zod.string().trim()).default({
|
|
71
70
|
default: "⚙️",
|
|
72
71
|
description: "📝",
|
|
73
72
|
devDependency: "💻",
|
|
@@ -77,14 +76,14 @@ const templatesSchema = zod.object({
|
|
|
77
76
|
required: "",
|
|
78
77
|
version: ""
|
|
79
78
|
}).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")
|
|
79
|
+
registryUrl: zod.string().trim().default("https://www.npmjs.com/package/{{name}}"),
|
|
80
|
+
versionImage: zod.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
|
|
82
81
|
});
|
|
83
82
|
const defaultTemplates = templatesSchema.parse({});
|
|
84
83
|
const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
|
|
85
|
-
const
|
|
86
|
-
affectedRegexes: zod.array(zod.string()),
|
|
87
|
-
collapseHeadings: zod.array(zod.string()),
|
|
84
|
+
const configSchema = zod.object({
|
|
85
|
+
affectedRegexes: zod.array(zod.string().trim()),
|
|
86
|
+
collapseHeadings: zod.array(zod.string().trim()),
|
|
88
87
|
defaultLanguage: languageSchema.meta({
|
|
89
88
|
alias: "l",
|
|
90
89
|
description: "Default language to infer projects from"
|
|
@@ -109,22 +108,20 @@ const _configSchema = zod.object({
|
|
|
109
108
|
alias: "p",
|
|
110
109
|
description: "Only show public packages in workspaces"
|
|
111
110
|
}),
|
|
112
|
-
removeScope: zod.string().default("").meta({ description: "Remove common workspace scope" }),
|
|
111
|
+
removeScope: zod.string().trim().default("").meta({ description: "Remove common workspace scope" }),
|
|
113
112
|
templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
|
|
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" }),
|
|
113
|
+
tocHeading: zod.string().trim().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
|
|
114
|
+
usageFile: zod.string().trim().default("").meta({ description: "Workspace level usage file" }),
|
|
115
|
+
usageHeading: zod.string().trim().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
|
|
117
116
|
verbose: zod.boolean().default(false).meta({
|
|
118
117
|
alias: "v",
|
|
119
118
|
description: "whether or not to display verbose logging"
|
|
120
119
|
})
|
|
121
|
-
});
|
|
122
|
-
const configSchema = _configSchema.optional();
|
|
123
|
-
|
|
120
|
+
}).optional();
|
|
124
121
|
//#endregion
|
|
125
122
|
exports.actionsSchema = actionsSchema;
|
|
126
123
|
exports.configSchema = configSchema;
|
|
127
124
|
exports.defaultTableHeadings = defaultTableHeadings;
|
|
128
125
|
exports.defaultTemplates = defaultTemplates;
|
|
129
126
|
exports.formatsSchema = formatsSchema;
|
|
130
|
-
exports.languageSchema = languageSchema;
|
|
127
|
+
exports.languageSchema = languageSchema;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
|
-
|
|
3
2
|
//#region src/schema.ts
|
|
4
3
|
const actionsSchema = z.enum([
|
|
5
4
|
"ACTION",
|
|
@@ -42,8 +41,8 @@ const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optio
|
|
|
42
41
|
ZOD: []
|
|
43
42
|
}).meta({ description: "Table heading action configuration" });
|
|
44
43
|
const templatesSchema = z.object({
|
|
45
|
-
downloadImage: z.string().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
|
|
46
|
-
emojis: z.record(headingsSchema, z.string()).default({
|
|
44
|
+
downloadImage: z.string().trim().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
|
|
45
|
+
emojis: z.record(headingsSchema, z.string().trim()).default({
|
|
47
46
|
default: "⚙️",
|
|
48
47
|
description: "📝",
|
|
49
48
|
devDependency: "💻",
|
|
@@ -53,14 +52,14 @@ const templatesSchema = z.object({
|
|
|
53
52
|
required: "",
|
|
54
53
|
version: ""
|
|
55
54
|
}).meta({ description: "Table heading emojis used when enabled" }),
|
|
56
|
-
registryUrl: z.string().default("https://www.npmjs.com/package/{{name}}"),
|
|
57
|
-
versionImage: z.string().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
|
|
55
|
+
registryUrl: z.string().trim().default("https://www.npmjs.com/package/{{name}}"),
|
|
56
|
+
versionImage: z.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
|
|
58
57
|
});
|
|
59
58
|
const defaultTemplates = templatesSchema.parse({});
|
|
60
59
|
const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
|
|
61
|
-
const
|
|
62
|
-
affectedRegexes: z.array(z.string()),
|
|
63
|
-
collapseHeadings: z.array(z.string()),
|
|
60
|
+
const configSchema = z.object({
|
|
61
|
+
affectedRegexes: z.array(z.string().trim()),
|
|
62
|
+
collapseHeadings: z.array(z.string().trim()),
|
|
64
63
|
defaultLanguage: languageSchema.meta({
|
|
65
64
|
alias: "l",
|
|
66
65
|
description: "Default language to infer projects from"
|
|
@@ -85,17 +84,15 @@ const _configSchema = z.object({
|
|
|
85
84
|
alias: "p",
|
|
86
85
|
description: "Only show public packages in workspaces"
|
|
87
86
|
}),
|
|
88
|
-
removeScope: z.string().default("").meta({ description: "Remove common workspace scope" }),
|
|
87
|
+
removeScope: z.string().trim().default("").meta({ description: "Remove common workspace scope" }),
|
|
89
88
|
templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
|
|
90
|
-
tocHeading: z.string().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
|
|
91
|
-
usageFile: z.string().default("").meta({ description: "Workspace level usage file" }),
|
|
92
|
-
usageHeading: z.string().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
|
|
89
|
+
tocHeading: z.string().trim().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
|
|
90
|
+
usageFile: z.string().trim().default("").meta({ description: "Workspace level usage file" }),
|
|
91
|
+
usageHeading: z.string().trim().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
|
|
93
92
|
verbose: z.boolean().default(false).meta({
|
|
94
93
|
alias: "v",
|
|
95
94
|
description: "whether or not to display verbose logging"
|
|
96
95
|
})
|
|
97
|
-
});
|
|
98
|
-
const configSchema = _configSchema.optional();
|
|
99
|
-
|
|
96
|
+
}).optional();
|
|
100
97
|
//#endregion
|
|
101
|
-
export { actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };
|
|
98
|
+
export { actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };
|