@stephansama/auto-readme 0.2.6 → 0.2.8
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 +4 -2
- package/cli.mjs +2 -3
- package/config/schema.cjs +17 -20
- package/config/schema.json +1 -1
- package/config/{schema.js → schema.mjs} +14 -17
- package/dist/index.cjs +132 -166
- package/dist/{index.js → index.mjs} +108 -129
- package/package.json +26 -29
- /package/config/{schema.d.ts → schema.d.mts} +0 -0
- /package/dist/{index.d.ts → index.d.mts} +0 -0
package/README.md
CHANGED
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
[](https://github.com/stephansama/packages/tree/main/core/auto-readme)
|
|
4
4
|
[](https://packages.stephansama.info/api/@stephansama/auto-readme)
|
|
5
5
|
[](https://www.npmx.dev/package/@stephansama/auto-readme)
|
|
6
|
+
[](https://jsr.io/@stephansama/auto-readme)
|
|
7
|
+
[](https://socket.dev/npm/package/@stephansama/auto-readme/overview)
|
|
6
8
|
[](https://www.npmx.dev/package/@stephansama/auto-readme)
|
|
7
9
|
|
|
8
10
|
Generate lists and tables for your README automagically based on your repository
|
|
@@ -142,7 +144,7 @@ disableEmojis: true
|
|
|
142
144
|
#### JavaScript Example
|
|
143
145
|
|
|
144
146
|
```javascript
|
|
145
|
-
/** @type {import(
|
|
147
|
+
/** @type {import("@stephansama/auto-readme").Config} */
|
|
146
148
|
export default {
|
|
147
149
|
disableEmojis: true,
|
|
148
150
|
};
|
|
@@ -190,7 +192,7 @@ _Object containing the following properties:_
|
|
|
190
192
|
| `enablePrettier` | Whether or not to use prettier to format the files | `boolean` | `true` |
|
|
191
193
|
| `enableToc` | generate table of contents for readmes | `boolean` | `false` |
|
|
192
194
|
| `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_) | `{
|
|
195
|
+
| `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_) | `{}` |
|
|
194
196
|
| `onlyReadmes` | Whether or not to only traverse readmes | `boolean` | `true` |
|
|
195
197
|
| `onlyShowPublicPackages` | Only show public packages in workspaces | `boolean` | `false` |
|
|
196
198
|
| `removeScope` | Remove common workspace scope | `string` | `''` |
|
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
|
-
const defaultTableHeadings = tableHeadingsSchema.parse(
|
|
85
|
-
const
|
|
86
|
-
affectedRegexes: zod.array(zod.string()),
|
|
87
|
-
collapseHeadings: zod.array(zod.string()),
|
|
83
|
+
const defaultTableHeadings = tableHeadingsSchema.parse({});
|
|
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;
|
package/config/schema.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"type":"array","items":{"type":"string"}},"collapseHeadings":{"type":"array","items":{"type":"string"}},"defaultLanguage":{"alias":"l","description":"Default language to infer projects from","default":"JS","type":"string","enum":["JS","RS"]},"disableEmojis":{"alias":"e","description":"Whether or not to use emojis in markdown table headings","default":false,"type":"boolean"},"disableMarkdownHeadings":{"description":"Whether or not to display markdown headings","default":false,"type":"boolean"},"enablePrettier":{"description":"Whether or not to use prettier to format the files","default":true,"type":"boolean"},"enableToc":{"alias":"t","description":"generate table of contents for readmes","default":false,"type":"boolean"},"enableUsage":{"description":"Whether or not to enable usage plugin","default":false,"type":"boolean"},"headings":{"description":"List of headings for different table outputs","default":{
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"type":"array","items":{"type":"string"}},"collapseHeadings":{"type":"array","items":{"type":"string"}},"defaultLanguage":{"alias":"l","description":"Default language to infer projects from","default":"JS","type":"string","enum":["JS","RS"]},"disableEmojis":{"alias":"e","description":"Whether or not to use emojis in markdown table headings","default":false,"type":"boolean"},"disableMarkdownHeadings":{"description":"Whether or not to display markdown headings","default":false,"type":"boolean"},"enablePrettier":{"description":"Whether or not to use prettier to format the files","default":true,"type":"boolean"},"enableToc":{"alias":"t","description":"generate table of contents for readmes","default":false,"type":"boolean"},"enableUsage":{"description":"Whether or not to enable usage plugin","default":false,"type":"boolean"},"headings":{"description":"List of headings for different table outputs","default":{},"type":"object","propertyNames":{"description":"Comment action options","type":"string","enum":["ACTION","PKG","USAGE","WORKSPACE","ZOD"]},"additionalProperties":{"type":"array","items":{"description":"Table heading options","type":"string","enum":["default","description","devDependency","downloads","name","private","required","version"]}}},"onlyReadmes":{"alias":"r","description":"Whether or not to only traverse readmes","default":true,"type":"boolean"},"onlyShowPublicPackages":{"alias":"p","description":"Only show public packages in workspaces","default":false,"type":"boolean"},"removeScope":{"description":"Remove common workspace scope","default":"","type":"string"},"templates":{"description":"Handlebars templates used to fuel list and table generation","default":{"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"},"type":"object","properties":{"downloadImage":{"default":"https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F","type":"string"},"emojis":{"description":"Table heading emojis used when enabled","default":{"default":"⚙️","description":"📝","devDependency":"💻","downloads":"📥","name":"🏷️","private":"🔒","required":"","version":""},"type":"object","propertyNames":{"description":"Table heading options","type":"string","enum":["default","description","devDependency","downloads","name","private","required","version"]},"additionalProperties":{"type":"string"}},"registryUrl":{"default":"https://www.npmjs.com/package/{{name}}","type":"string"},"versionImage":{"default":"https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F","type":"string"}},"required":["downloadImage","emojis","registryUrl","versionImage"],"additionalProperties":false},"tocHeading":{"description":"Markdown heading used to generate table of contents","default":"Table of contents","type":"string"},"usageFile":{"description":"Workspace level usage file","default":"","type":"string"},"usageHeading":{"description":"Markdown heading used to generate usage example","default":"Usage","type":"string"},"verbose":{"alias":"v","description":"whether or not to display verbose logging","default":false,"type":"boolean"}},"required":["affectedRegexes","collapseHeadings","defaultLanguage","disableEmojis","disableMarkdownHeadings","enablePrettier","enableToc","enableUsage","headings","onlyReadmes","onlyShowPublicPackages","removeScope","templates","tocHeading","usageFile","usageHeading","verbose"],"additionalProperties":false}
|
|
@@ -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
|
-
const defaultTableHeadings = tableHeadingsSchema.parse(
|
|
61
|
-
const
|
|
62
|
-
affectedRegexes: z.array(z.string()),
|
|
63
|
-
collapseHeadings: z.array(z.string()),
|
|
59
|
+
const defaultTableHeadings = tableHeadingsSchema.parse({});
|
|
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 };
|