@stephansama/auto-readme 0.2.1 → 0.2.2

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.
Files changed (13) hide show
  1. package/config/schema.cjs +122 -127
  2. package/config/schema.cjs.map +1 -1
  3. package/config/schema.d.cts +134 -133
  4. package/config/schema.d.ts +134 -133
  5. package/config/schema.js +96 -100
  6. package/config/schema.js.map +1 -1
  7. package/dist/index.cjs +602 -661
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +5 -0
  10. package/dist/index.d.ts +5 -0
  11. package/dist/index.js +557 -631
  12. package/dist/index.js.map +1 -1
  13. package/package.json +21 -21
package/config/schema.d.ts CHANGED
@@ -1,21 +1,50 @@
1
- import { z } from 'zod';
1
+ import { z } from "zod";
2
2
 
3
+ //#region src/schema.d.ts
3
4
  declare const actionsSchema: z.ZodEnum<{
4
- ACTION: "ACTION";
5
- PKG: "PKG";
6
- USAGE: "USAGE";
7
- WORKSPACE: "WORKSPACE";
8
- ZOD: "ZOD";
5
+ ACTION: "ACTION";
6
+ PKG: "PKG";
7
+ USAGE: "USAGE";
8
+ WORKSPACE: "WORKSPACE";
9
+ ZOD: "ZOD";
9
10
  }>;
10
11
  declare const formatsSchema: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
11
- LIST: "LIST";
12
- TABLE: "TABLE";
12
+ LIST: "LIST";
13
+ TABLE: "TABLE";
13
14
  }>>>;
14
15
  declare const languageSchema: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
15
- JS: "JS";
16
- RS: "RS";
16
+ JS: "JS";
17
+ RS: "RS";
17
18
  }>>>;
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<{
19
48
  default: "default";
20
49
  description: "description";
21
50
  devDependency: "devDependency";
@@ -24,14 +53,36 @@ declare const headingsSchema: z.ZodEnum<{
24
53
  private: "private";
25
54
  required: "required";
26
55
  version: "version";
27
- }>;
28
- declare const tableHeadingsSchema: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
56
+ }>, z.ZodString>>>;
57
+ registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
58
+ versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
59
+ }, z.core.$strip>;
60
+ declare const defaultTemplates: {
61
+ downloadImage: string;
62
+ emojis: Record<"default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>;
63
+ registryUrl: string;
64
+ versionImage: string;
65
+ };
66
+ declare const defaultTableHeadings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD", ("default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version")[] | undefined>;
67
+ declare const configSchema: z.ZodOptional<z.ZodObject<{
68
+ affectedRegexes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
69
+ collapseHeadings: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
70
+ defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
71
+ JS: "JS";
72
+ RS: "RS";
73
+ }>>>;
74
+ disableEmojis: z.ZodDefault<z.ZodBoolean>;
75
+ disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
76
+ enablePrettier: z.ZodDefault<z.ZodBoolean>;
77
+ enableToc: z.ZodDefault<z.ZodBoolean>;
78
+ enableUsage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
79
+ headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
29
80
  ACTION: "ACTION";
30
81
  PKG: "PKG";
31
82
  USAGE: "USAGE";
32
83
  WORKSPACE: "WORKSPACE";
33
84
  ZOD: "ZOD";
34
- }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
85
+ }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
35
86
  default: "default";
36
87
  description: "description";
37
88
  devDependency: "devDependency";
@@ -40,132 +91,82 @@ declare const tableHeadingsSchema: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodE
40
91
  private: "private";
41
92
  required: "required";
42
93
  version: "version";
43
- }>>>>>>;
44
- declare const templatesSchema: z.ZodObject<{
94
+ }>>>>>>>>;
95
+ onlyReadmes: z.ZodDefault<z.ZodBoolean>;
96
+ onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
97
+ removeScope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
98
+ templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
45
99
  downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
46
100
  emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
47
- default: "default";
48
- description: "description";
49
- devDependency: "devDependency";
50
- downloads: "downloads";
51
- name: "name";
52
- private: "private";
53
- required: "required";
54
- version: "version";
101
+ default: "default";
102
+ description: "description";
103
+ devDependency: "devDependency";
104
+ downloads: "downloads";
105
+ name: "name";
106
+ private: "private";
107
+ required: "required";
108
+ version: "version";
55
109
  }>, z.ZodString>>>;
56
110
  registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
57
111
  versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
58
- }, z.core.$strip>;
59
- declare const defaultTemplates: {
60
- downloadImage: string;
61
- emojis: Record<"default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>;
62
- registryUrl: string;
63
- versionImage: string;
64
- };
65
- declare const defaultTableHeadings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD", ("default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version")[] | undefined>;
66
- declare const configSchema: z.ZodOptional<z.ZodObject<{
67
- affectedRegexes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
68
- collapseHeadings: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
69
- defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
70
- JS: "JS";
71
- RS: "RS";
72
- }>>>;
73
- disableEmojis: z.ZodDefault<z.ZodBoolean>;
74
- disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
75
- enablePrettier: z.ZodDefault<z.ZodBoolean>;
76
- enableToc: z.ZodDefault<z.ZodBoolean>;
77
- enableUsage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
78
- headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
79
- ACTION: "ACTION";
80
- PKG: "PKG";
81
- USAGE: "USAGE";
82
- WORKSPACE: "WORKSPACE";
83
- ZOD: "ZOD";
84
- }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
85
- default: "default";
86
- description: "description";
87
- devDependency: "devDependency";
88
- downloads: "downloads";
89
- name: "name";
90
- private: "private";
91
- required: "required";
92
- version: "version";
93
- }>>>>>>>>;
94
- onlyReadmes: z.ZodDefault<z.ZodBoolean>;
95
- onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
96
- removeScope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
97
- templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
98
- downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
99
- emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
100
- default: "default";
101
- description: "description";
102
- devDependency: "devDependency";
103
- downloads: "downloads";
104
- name: "name";
105
- private: "private";
106
- required: "required";
107
- version: "version";
108
- }>, z.ZodString>>>;
109
- registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
110
- versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
111
- }, z.core.$strip>>>;
112
- tocHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
113
- usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
114
- usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
115
- verbose: z.ZodDefault<z.ZodBoolean>;
112
+ }, z.core.$strip>>>;
113
+ tocHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
114
+ usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
115
+ usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
116
+ verbose: z.ZodDefault<z.ZodBoolean>;
116
117
  }, z.core.$strip>>;
117
118
  type Config = Partial<z.infer<typeof _configSchema>>;
118
-
119
119
  declare const _configSchema: z.ZodObject<{
120
- affectedRegexes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
121
- collapseHeadings: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
122
- defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
123
- JS: "JS";
124
- RS: "RS";
125
- }>>>;
126
- disableEmojis: z.ZodDefault<z.ZodBoolean>;
127
- disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
128
- enablePrettier: z.ZodDefault<z.ZodBoolean>;
129
- enableToc: z.ZodDefault<z.ZodBoolean>;
130
- enableUsage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
131
- headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
132
- ACTION: "ACTION";
133
- PKG: "PKG";
134
- USAGE: "USAGE";
135
- WORKSPACE: "WORKSPACE";
136
- ZOD: "ZOD";
137
- }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
138
- default: "default";
139
- description: "description";
140
- devDependency: "devDependency";
141
- downloads: "downloads";
142
- name: "name";
143
- private: "private";
144
- required: "required";
145
- version: "version";
146
- }>>>>>>>>;
147
- onlyReadmes: z.ZodDefault<z.ZodBoolean>;
148
- onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
149
- removeScope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
150
- templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
151
- downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
152
- emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
153
- default: "default";
154
- description: "description";
155
- devDependency: "devDependency";
156
- downloads: "downloads";
157
- name: "name";
158
- private: "private";
159
- required: "required";
160
- version: "version";
161
- }>, z.ZodString>>>;
162
- registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
163
- versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
164
- }, z.core.$strip>>>;
165
- tocHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
166
- usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
167
- usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
168
- verbose: z.ZodDefault<z.ZodBoolean>;
120
+ affectedRegexes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
121
+ collapseHeadings: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
122
+ defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
123
+ JS: "JS";
124
+ RS: "RS";
125
+ }>>>;
126
+ disableEmojis: z.ZodDefault<z.ZodBoolean>;
127
+ disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
128
+ enablePrettier: z.ZodDefault<z.ZodBoolean>;
129
+ enableToc: z.ZodDefault<z.ZodBoolean>;
130
+ enableUsage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
131
+ headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
132
+ ACTION: "ACTION";
133
+ PKG: "PKG";
134
+ USAGE: "USAGE";
135
+ WORKSPACE: "WORKSPACE";
136
+ ZOD: "ZOD";
137
+ }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
138
+ default: "default";
139
+ description: "description";
140
+ devDependency: "devDependency";
141
+ downloads: "downloads";
142
+ name: "name";
143
+ private: "private";
144
+ required: "required";
145
+ version: "version";
146
+ }>>>>>>>>;
147
+ onlyReadmes: z.ZodDefault<z.ZodBoolean>;
148
+ onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
149
+ removeScope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
150
+ templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
151
+ downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
152
+ emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
153
+ default: "default";
154
+ description: "description";
155
+ devDependency: "devDependency";
156
+ downloads: "downloads";
157
+ name: "name";
158
+ private: "private";
159
+ required: "required";
160
+ version: "version";
161
+ }>, z.ZodString>>>;
162
+ registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
163
+ versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
164
+ }, z.core.$strip>>>;
165
+ tocHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
166
+ usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
167
+ usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
168
+ verbose: z.ZodDefault<z.ZodBoolean>;
169
169
  }, z.core.$strip>;
170
-
171
- export { type Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, headingsSchema, languageSchema, tableHeadingsSchema, templatesSchema };
170
+ //#endregion
171
+ export { Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, headingsSchema, languageSchema, tableHeadingsSchema, templatesSchema };
172
+ //# sourceMappingURL=schema.d.ts.map
package/config/schema.js CHANGED
@@ -1,106 +1,102 @@
1
- // src/schema.js
2
1
  import { z } from "zod";
3
- var actionsSchema = z.enum(["ACTION", "PKG", "USAGE", "WORKSPACE", "ZOD"]).describe("Comment action options");
4
- var formatsSchema = z.enum(["LIST", "TABLE"]).default("TABLE").optional();
5
- var languageSchema = z.enum(["JS", "RS"]).optional().default("JS");
6
- var headingsSchema = z.enum([
7
- "default",
8
- "description",
9
- "devDependency",
10
- "downloads",
11
- "name",
12
- "private",
13
- "required",
14
- "version"
2
+
3
+ //#region src/schema.js
4
+ const actionsSchema = z.enum([
5
+ "ACTION",
6
+ "PKG",
7
+ "USAGE",
8
+ "WORKSPACE",
9
+ "ZOD"
10
+ ]).describe("Comment action options");
11
+ const formatsSchema = z.enum(["LIST", "TABLE"]).default("TABLE").optional();
12
+ const languageSchema = z.enum(["JS", "RS"]).optional().default("JS");
13
+ const headingsSchema = z.enum([
14
+ "default",
15
+ "description",
16
+ "devDependency",
17
+ "downloads",
18
+ "name",
19
+ "private",
20
+ "required",
21
+ "version"
15
22
  ]).describe("Table heading options");
16
- var tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optional()).optional().describe("Table heading action configuration").default({
17
- ACTION: ["name", "required", "default", "description"],
18
- PKG: ["name", "version", "devDependency"],
19
- WORKSPACE: ["name", "version", "downloads", "description"],
20
- ZOD: []
23
+ const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optional()).optional().describe("Table heading action configuration").default({
24
+ ACTION: [
25
+ "name",
26
+ "required",
27
+ "default",
28
+ "description"
29
+ ],
30
+ PKG: [
31
+ "name",
32
+ "version",
33
+ "devDependency"
34
+ ],
35
+ WORKSPACE: [
36
+ "name",
37
+ "version",
38
+ "downloads",
39
+ "description"
40
+ ],
41
+ ZOD: []
21
42
  });
22
- var templatesSchema = z.object({
23
- downloadImage: z.string().optional().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
24
- emojis: z.record(headingsSchema, z.string()).optional().describe("Table heading emojis used when enabled").default({
25
- default: "\u2699\uFE0F",
26
- description: "\u{1F4DD}",
27
- devDependency: "\u{1F4BB}",
28
- downloads: "\u{1F4E5}",
29
- name: "\u{1F3F7}\uFE0F",
30
- private: "\u{1F512}",
31
- required: "",
32
- version: ""
33
- }),
34
- registryUrl: z.string().optional().default("https://www.npmjs.com/package/{{name}}"),
35
- versionImage: z.string().optional().default(
36
- "https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F"
37
- )
43
+ const templatesSchema = z.object({
44
+ downloadImage: z.string().optional().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
45
+ emojis: z.record(headingsSchema, z.string()).optional().describe("Table heading emojis used when enabled").default({
46
+ default: "⚙️",
47
+ description: "📝",
48
+ devDependency: "💻",
49
+ downloads: "📥",
50
+ name: "🏷️",
51
+ private: "🔒",
52
+ required: "",
53
+ version: ""
54
+ }),
55
+ registryUrl: z.string().optional().default("https://www.npmjs.com/package/{{name}}"),
56
+ versionImage: z.string().optional().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
38
57
  });
39
- var defaultTemplates = templatesSchema.parse({});
40
- var defaultTableHeadings = tableHeadingsSchema.parse(void 0);
41
- var _configSchema = z.object({
42
- affectedRegexes: z.string().array().optional().default([]),
43
- collapseHeadings: z.string().array().optional().default([]),
44
- defaultLanguage: languageSchema.meta({
45
- alias: "l",
46
- description: "Default language to infer projects from"
47
- }),
48
- disableEmojis: z.boolean().default(false).meta({
49
- alias: "e",
50
- description: "Whether or not to use emojis in markdown table headings"
51
- }),
52
- disableMarkdownHeadings: z.boolean().default(false).meta({
53
- description: "Whether or not to display markdown headings"
54
- }),
55
- enablePrettier: z.boolean().default(true).meta({
56
- description: "Whether or not to use prettier to format the files"
57
- }),
58
- enableToc: z.boolean().default(false).meta({
59
- alias: "t",
60
- description: "generate table of contents for readmes"
61
- }),
62
- enableUsage: z.boolean().optional().default(false).meta({
63
- description: "Whether or not to enable usage plugin"
64
- }),
65
- headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
66
- onlyReadmes: z.boolean().default(true).meta({
67
- alias: "r",
68
- description: "Whether or not to only traverse readmes"
69
- }),
70
- onlyShowPublicPackages: z.boolean().default(false).meta({
71
- alias: "p",
72
- description: "Only show public packages in workspaces"
73
- }),
74
- removeScope: z.string().optional().default("").meta({
75
- description: "Remove common workspace scope"
76
- }),
77
- templates: templatesSchema.optional().default(defaultTemplates).describe(
78
- "Handlebars templates used to fuel list and table generation"
79
- ),
80
- tocHeading: z.string().optional().default("Table of contents").meta({
81
- description: "Markdown heading used to generate table of contents"
82
- }),
83
- usageFile: z.string().optional().default("").meta({
84
- description: "Workspace level usage file"
85
- }),
86
- usageHeading: z.string().optional().default("Usage").meta({
87
- description: "Markdown heading used to generate usage example"
88
- }),
89
- verbose: z.boolean().default(false).meta({
90
- alias: "v",
91
- description: "whether or not to display verbose logging"
92
- })
58
+ const defaultTemplates = templatesSchema.parse({});
59
+ const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
60
+ const _configSchema = z.object({
61
+ affectedRegexes: z.string().array().optional().default([]),
62
+ collapseHeadings: z.string().array().optional().default([]),
63
+ defaultLanguage: languageSchema.meta({
64
+ alias: "l",
65
+ description: "Default language to infer projects from"
66
+ }),
67
+ disableEmojis: z.boolean().default(false).meta({
68
+ alias: "e",
69
+ description: "Whether or not to use emojis in markdown table headings"
70
+ }),
71
+ disableMarkdownHeadings: z.boolean().default(false).meta({ description: "Whether or not to display markdown headings" }),
72
+ enablePrettier: z.boolean().default(true).meta({ description: "Whether or not to use prettier to format the files" }),
73
+ enableToc: z.boolean().default(false).meta({
74
+ alias: "t",
75
+ description: "generate table of contents for readmes"
76
+ }),
77
+ enableUsage: z.boolean().optional().default(false).meta({ description: "Whether or not to enable usage plugin" }),
78
+ headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
79
+ onlyReadmes: z.boolean().default(true).meta({
80
+ alias: "r",
81
+ description: "Whether or not to only traverse readmes"
82
+ }),
83
+ onlyShowPublicPackages: z.boolean().default(false).meta({
84
+ alias: "p",
85
+ description: "Only show public packages in workspaces"
86
+ }),
87
+ removeScope: z.string().optional().default("").meta({ description: "Remove common workspace scope" }),
88
+ templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
89
+ tocHeading: z.string().optional().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
90
+ usageFile: z.string().optional().default("").meta({ description: "Workspace level usage file" }),
91
+ usageHeading: z.string().optional().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
92
+ verbose: z.boolean().default(false).meta({
93
+ alias: "v",
94
+ description: "whether or not to display verbose logging"
95
+ })
93
96
  });
94
- var configSchema = _configSchema.optional();
95
- export {
96
- actionsSchema,
97
- configSchema,
98
- defaultTableHeadings,
99
- defaultTemplates,
100
- formatsSchema,
101
- headingsSchema,
102
- languageSchema,
103
- tableHeadingsSchema,
104
- templatesSchema
105
- };
97
+ const configSchema = _configSchema.optional();
98
+ /** @typedef {Partial<z.infer<typeof _configSchema>>} Config */
99
+
100
+ //#endregion
101
+ export { actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, headingsSchema, languageSchema, tableHeadingsSchema, templatesSchema };
106
102
  //# sourceMappingURL=schema.js.map
package/config/schema.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/schema.js"],"sourcesContent":["import { z } from \"zod\";\n\nexport const actionsSchema = z\n\t.enum([\"ACTION\", \"PKG\", \"USAGE\", \"WORKSPACE\", \"ZOD\"])\n\t.describe(\"Comment action options\");\n\nexport const formatsSchema = z\n\t.enum([\"LIST\", \"TABLE\"])\n\t.default(\"TABLE\")\n\t.optional();\n\nexport const languageSchema = z.enum([\"JS\", \"RS\"]).optional().default(\"JS\");\n\nexport const headingsSchema = z\n\t.enum([\n\t\t\"default\",\n\t\t\"description\",\n\t\t\"devDependency\",\n\t\t\"downloads\",\n\t\t\"name\",\n\t\t\"private\",\n\t\t\"required\",\n\t\t\"version\",\n\t])\n\t.describe(\"Table heading options\");\n\nexport const tableHeadingsSchema = z\n\t.record(actionsSchema, headingsSchema.array().optional())\n\t.optional()\n\t.describe(\"Table heading action configuration\")\n\t.default({\n\t\tACTION: [\"name\", \"required\", \"default\", \"description\"],\n\t\tPKG: [\"name\", \"version\", \"devDependency\"],\n\t\tWORKSPACE: [\"name\", \"version\", \"downloads\", \"description\"],\n\t\tZOD: [],\n\t});\n\nexport const templatesSchema = z.object({\n\tdownloadImage: z\n\t\t.string()\n\t\t.optional()\n\t\t.default(\"https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F\"),\n\temojis: z\n\t\t.record(headingsSchema, z.string())\n\t\t.optional()\n\t\t.describe(\"Table heading emojis used when enabled\")\n\t\t.default({\n\t\t\tdefault: \"⚙️\",\n\t\t\tdescription: \"📝\",\n\t\t\tdevDependency: \"💻\",\n\t\t\tdownloads: \"📥\",\n\t\t\tname: \"🏷️\",\n\t\t\tprivate: \"🔒\",\n\t\t\trequired: \"\",\n\t\t\tversion: \"\",\n\t\t}),\n\tregistryUrl: z\n\t\t.string()\n\t\t.optional()\n\t\t.default(\"https://www.npmjs.com/package/{{name}}\"),\n\tversionImage: z\n\t\t.string()\n\t\t.optional()\n\t\t.default(\n\t\t\t\"https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F\",\n\t\t),\n});\n\nexport const defaultTemplates = templatesSchema.parse({});\nexport const defaultTableHeadings = tableHeadingsSchema.parse(undefined);\n\nconst _configSchema = z.object({\n\taffectedRegexes: z.string().array().optional().default([]),\n\tcollapseHeadings: z.string().array().optional().default([]),\n\tdefaultLanguage: languageSchema.meta({\n\t\talias: \"l\",\n\t\tdescription: \"Default language to infer projects from\",\n\t}),\n\tdisableEmojis: z.boolean().default(false).meta({\n\t\talias: \"e\",\n\t\tdescription: \"Whether or not to use emojis in markdown table headings\",\n\t}),\n\tdisableMarkdownHeadings: z.boolean().default(false).meta({\n\t\tdescription: \"Whether or not to display markdown headings\",\n\t}),\n\tenablePrettier: z.boolean().default(true).meta({\n\t\tdescription: \"Whether or not to use prettier to format the files\",\n\t}),\n\tenableToc: z.boolean().default(false).meta({\n\t\talias: \"t\",\n\t\tdescription: \"generate table of contents for readmes\",\n\t}),\n\tenableUsage: z.boolean().optional().default(false).meta({\n\t\tdescription: \"Whether or not to enable usage plugin\",\n\t}),\n\theadings: tableHeadingsSchema\n\t\t.optional()\n\t\t.default(defaultTableHeadings)\n\t\t.describe(\"List of headings for different table outputs\"),\n\tonlyReadmes: z.boolean().default(true).meta({\n\t\talias: \"r\",\n\t\tdescription: \"Whether or not to only traverse readmes\",\n\t}),\n\tonlyShowPublicPackages: z.boolean().default(false).meta({\n\t\talias: \"p\",\n\t\tdescription: \"Only show public packages in workspaces\",\n\t}),\n\tremoveScope: z.string().optional().default(\"\").meta({\n\t\tdescription: \"Remove common workspace scope\",\n\t}),\n\ttemplates: templatesSchema\n\t\t.optional()\n\t\t.default(defaultTemplates)\n\t\t.describe(\n\t\t\t\"Handlebars templates used to fuel list and table generation\",\n\t\t),\n\ttocHeading: z.string().optional().default(\"Table of contents\").meta({\n\t\tdescription: \"Markdown heading used to generate table of contents\",\n\t}),\n\tusageFile: z.string().optional().default(\"\").meta({\n\t\tdescription: \"Workspace level usage file\",\n\t}),\n\tusageHeading: z.string().optional().default(\"Usage\").meta({\n\t\tdescription: \"Markdown heading used to generate usage example\",\n\t}),\n\tverbose: z.boolean().default(false).meta({\n\t\talias: \"v\",\n\t\tdescription: \"whether or not to display verbose logging\",\n\t}),\n});\n\nexport const configSchema = _configSchema.optional();\n\n/** @typedef {Partial<z.infer<typeof _configSchema>>} Config */\n"],"mappings":";AAAA,SAAS,SAAS;AAEX,IAAM,gBAAgB,EAC3B,KAAK,CAAC,UAAU,OAAO,SAAS,aAAa,KAAK,CAAC,EACnD,SAAS,wBAAwB;AAE5B,IAAM,gBAAgB,EAC3B,KAAK,CAAC,QAAQ,OAAO,CAAC,EACtB,QAAQ,OAAO,EACf,SAAS;AAEJ,IAAM,iBAAiB,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,SAAS,EAAE,QAAQ,IAAI;AAEnE,IAAM,iBAAiB,EAC5B,KAAK;AAAA,EACL;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC,EACA,SAAS,uBAAuB;AAE3B,IAAM,sBAAsB,EACjC,OAAO,eAAe,eAAe,MAAM,EAAE,SAAS,CAAC,EACvD,SAAS,EACT,SAAS,oCAAoC,EAC7C,QAAQ;AAAA,EACR,QAAQ,CAAC,QAAQ,YAAY,WAAW,aAAa;AAAA,EACrD,KAAK,CAAC,QAAQ,WAAW,eAAe;AAAA,EACxC,WAAW,CAAC,QAAQ,WAAW,aAAa,aAAa;AAAA,EACzD,KAAK,CAAC;AACP,CAAC;AAEK,IAAM,kBAAkB,EAAE,OAAO;AAAA,EACvC,eAAe,EACb,OAAO,EACP,SAAS,EACT,QAAQ,0DAA0D;AAAA,EACpE,QAAQ,EACN,OAAO,gBAAgB,EAAE,OAAO,CAAC,EACjC,SAAS,EACT,SAAS,wCAAwC,EACjD,QAAQ;AAAA,IACR,SAAS;AAAA,IACT,aAAa;AAAA,IACb,eAAe;AAAA,IACf,WAAW;AAAA,IACX,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,IACV,SAAS;AAAA,EACV,CAAC;AAAA,EACF,aAAa,EACX,OAAO,EACP,SAAS,EACT,QAAQ,wCAAwC;AAAA,EAClD,cAAc,EACZ,OAAO,EACP,SAAS,EACT;AAAA,IACA;AAAA,EACD;AACF,CAAC;AAEM,IAAM,mBAAmB,gBAAgB,MAAM,CAAC,CAAC;AACjD,IAAM,uBAAuB,oBAAoB,MAAM,MAAS;AAEvE,IAAM,gBAAgB,EAAE,OAAO;AAAA,EAC9B,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAAA,EACzD,kBAAkB,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAAA,EAC1D,iBAAiB,eAAe,KAAK;AAAA,IACpC,OAAO;AAAA,IACP,aAAa;AAAA,EACd,CAAC;AAAA,EACD,eAAe,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,KAAK;AAAA,IAC9C,OAAO;AAAA,IACP,aAAa;AAAA,EACd,CAAC;AAAA,EACD,yBAAyB,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,KAAK;AAAA,IACxD,aAAa;AAAA,EACd,CAAC;AAAA,EACD,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,IAAI,EAAE,KAAK;AAAA,IAC9C,aAAa;AAAA,EACd,CAAC;AAAA,EACD,WAAW,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,KAAK;AAAA,IAC1C,OAAO;AAAA,IACP,aAAa;AAAA,EACd,CAAC;AAAA,EACD,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,KAAK;AAAA,IACvD,aAAa;AAAA,EACd,CAAC;AAAA,EACD,UAAU,oBACR,SAAS,EACT,QAAQ,oBAAoB,EAC5B,SAAS,8CAA8C;AAAA,EACzD,aAAa,EAAE,QAAQ,EAAE,QAAQ,IAAI,EAAE,KAAK;AAAA,IAC3C,OAAO;AAAA,IACP,aAAa;AAAA,EACd,CAAC;AAAA,EACD,wBAAwB,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,KAAK;AAAA,IACvD,OAAO;AAAA,IACP,aAAa;AAAA,EACd,CAAC;AAAA,EACD,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,KAAK;AAAA,IACnD,aAAa;AAAA,EACd,CAAC;AAAA,EACD,WAAW,gBACT,SAAS,EACT,QAAQ,gBAAgB,EACxB;AAAA,IACA;AAAA,EACD;AAAA,EACD,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,mBAAmB,EAAE,KAAK;AAAA,IACnE,aAAa;AAAA,EACd,CAAC;AAAA,EACD,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,KAAK;AAAA,IACjD,aAAa;AAAA,EACd,CAAC;AAAA,EACD,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,OAAO,EAAE,KAAK;AAAA,IACzD,aAAa;AAAA,EACd,CAAC;AAAA,EACD,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,KAAK;AAAA,IACxC,OAAO;AAAA,IACP,aAAa;AAAA,EACd,CAAC;AACF,CAAC;AAEM,IAAM,eAAe,cAAc,SAAS;","names":[]}
1
+ {"version":3,"file":"schema.js","names":[],"sources":["../src/schema.js"],"sourcesContent":["import { z } from \"zod\";\n\nexport const actionsSchema = z\n\t.enum([\"ACTION\", \"PKG\", \"USAGE\", \"WORKSPACE\", \"ZOD\"])\n\t.describe(\"Comment action options\");\n\nexport const formatsSchema = z\n\t.enum([\"LIST\", \"TABLE\"])\n\t.default(\"TABLE\")\n\t.optional();\n\nexport const languageSchema = z.enum([\"JS\", \"RS\"]).optional().default(\"JS\");\n\nexport const headingsSchema = z\n\t.enum([\n\t\t\"default\",\n\t\t\"description\",\n\t\t\"devDependency\",\n\t\t\"downloads\",\n\t\t\"name\",\n\t\t\"private\",\n\t\t\"required\",\n\t\t\"version\",\n\t])\n\t.describe(\"Table heading options\");\n\nexport const tableHeadingsSchema = z\n\t.record(actionsSchema, headingsSchema.array().optional())\n\t.optional()\n\t.describe(\"Table heading action configuration\")\n\t.default({\n\t\tACTION: [\"name\", \"required\", \"default\", \"description\"],\n\t\tPKG: [\"name\", \"version\", \"devDependency\"],\n\t\tWORKSPACE: [\"name\", \"version\", \"downloads\", \"description\"],\n\t\tZOD: [],\n\t});\n\nexport const templatesSchema = z.object({\n\tdownloadImage: z\n\t\t.string()\n\t\t.optional()\n\t\t.default(\"https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F\"),\n\temojis: z\n\t\t.record(headingsSchema, z.string())\n\t\t.optional()\n\t\t.describe(\"Table heading emojis used when enabled\")\n\t\t.default({\n\t\t\tdefault: \"⚙️\",\n\t\t\tdescription: \"📝\",\n\t\t\tdevDependency: \"💻\",\n\t\t\tdownloads: \"📥\",\n\t\t\tname: \"🏷️\",\n\t\t\tprivate: \"🔒\",\n\t\t\trequired: \"\",\n\t\t\tversion: \"\",\n\t\t}),\n\tregistryUrl: z\n\t\t.string()\n\t\t.optional()\n\t\t.default(\"https://www.npmjs.com/package/{{name}}\"),\n\tversionImage: z\n\t\t.string()\n\t\t.optional()\n\t\t.default(\n\t\t\t\"https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F\",\n\t\t),\n});\n\nexport const defaultTemplates = templatesSchema.parse({});\nexport const defaultTableHeadings = tableHeadingsSchema.parse(undefined);\n\nconst _configSchema = z.object({\n\taffectedRegexes: z.string().array().optional().default([]),\n\tcollapseHeadings: z.string().array().optional().default([]),\n\tdefaultLanguage: languageSchema.meta({\n\t\talias: \"l\",\n\t\tdescription: \"Default language to infer projects from\",\n\t}),\n\tdisableEmojis: z.boolean().default(false).meta({\n\t\talias: \"e\",\n\t\tdescription: \"Whether or not to use emojis in markdown table headings\",\n\t}),\n\tdisableMarkdownHeadings: z.boolean().default(false).meta({\n\t\tdescription: \"Whether or not to display markdown headings\",\n\t}),\n\tenablePrettier: z.boolean().default(true).meta({\n\t\tdescription: \"Whether or not to use prettier to format the files\",\n\t}),\n\tenableToc: z.boolean().default(false).meta({\n\t\talias: \"t\",\n\t\tdescription: \"generate table of contents for readmes\",\n\t}),\n\tenableUsage: z.boolean().optional().default(false).meta({\n\t\tdescription: \"Whether or not to enable usage plugin\",\n\t}),\n\theadings: tableHeadingsSchema\n\t\t.optional()\n\t\t.default(defaultTableHeadings)\n\t\t.describe(\"List of headings for different table outputs\"),\n\tonlyReadmes: z.boolean().default(true).meta({\n\t\talias: \"r\",\n\t\tdescription: \"Whether or not to only traverse readmes\",\n\t}),\n\tonlyShowPublicPackages: z.boolean().default(false).meta({\n\t\talias: \"p\",\n\t\tdescription: \"Only show public packages in workspaces\",\n\t}),\n\tremoveScope: z.string().optional().default(\"\").meta({\n\t\tdescription: \"Remove common workspace scope\",\n\t}),\n\ttemplates: templatesSchema\n\t\t.optional()\n\t\t.default(defaultTemplates)\n\t\t.describe(\n\t\t\t\"Handlebars templates used to fuel list and table generation\",\n\t\t),\n\ttocHeading: z.string().optional().default(\"Table of contents\").meta({\n\t\tdescription: \"Markdown heading used to generate table of contents\",\n\t}),\n\tusageFile: z.string().optional().default(\"\").meta({\n\t\tdescription: \"Workspace level usage file\",\n\t}),\n\tusageHeading: z.string().optional().default(\"Usage\").meta({\n\t\tdescription: \"Markdown heading used to generate usage example\",\n\t}),\n\tverbose: z.boolean().default(false).meta({\n\t\talias: \"v\",\n\t\tdescription: \"whether or not to display verbose logging\",\n\t}),\n});\n\nexport const configSchema = _configSchema.optional();\n\n/** @typedef {Partial<z.infer<typeof _configSchema>>} Config */\n"],"mappings":";;;AAEA,MAAa,gBAAgB,EAC3B,KAAK;CAAC;CAAU;CAAO;CAAS;CAAa;CAAM,CAAC,CACpD,SAAS,yBAAyB;AAEpC,MAAa,gBAAgB,EAC3B,KAAK,CAAC,QAAQ,QAAQ,CAAC,CACvB,QAAQ,QAAQ,CAChB,UAAU;AAEZ,MAAa,iBAAiB,EAAE,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,UAAU,CAAC,QAAQ,KAAK;AAE3E,MAAa,iBAAiB,EAC5B,KAAK;CACL;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA,CAAC,CACD,SAAS,wBAAwB;AAEnC,MAAa,sBAAsB,EACjC,OAAO,eAAe,eAAe,OAAO,CAAC,UAAU,CAAC,CACxD,UAAU,CACV,SAAS,qCAAqC,CAC9C,QAAQ;CACR,QAAQ;EAAC;EAAQ;EAAY;EAAW;EAAc;CACtD,KAAK;EAAC;EAAQ;EAAW;EAAgB;CACzC,WAAW;EAAC;EAAQ;EAAW;EAAa;EAAc;CAC1D,KAAK,EAAE;CACP,CAAC;AAEH,MAAa,kBAAkB,EAAE,OAAO;CACvC,eAAe,EACb,QAAQ,CACR,UAAU,CACV,QAAQ,2DAA2D;CACrE,QAAQ,EACN,OAAO,gBAAgB,EAAE,QAAQ,CAAC,CAClC,UAAU,CACV,SAAS,yCAAyC,CAClD,QAAQ;EACR,SAAS;EACT,aAAa;EACb,eAAe;EACf,WAAW;EACX,MAAM;EACN,SAAS;EACT,UAAU;EACV,SAAS;EACT,CAAC;CACH,aAAa,EACX,QAAQ,CACR,UAAU,CACV,QAAQ,yCAAyC;CACnD,cAAc,EACZ,QAAQ,CACR,UAAU,CACV,QACA,kGACA;CACF,CAAC;AAEF,MAAa,mBAAmB,gBAAgB,MAAM,EAAE,CAAC;AACzD,MAAa,uBAAuB,oBAAoB,MAAM,OAAU;AAExE,MAAM,gBAAgB,EAAE,OAAO;CAC9B,iBAAiB,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;CAC1D,kBAAkB,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;CAC3D,iBAAiB,eAAe,KAAK;EACpC,OAAO;EACP,aAAa;EACb,CAAC;CACF,eAAe,EAAE,SAAS,CAAC,QAAQ,MAAM,CAAC,KAAK;EAC9C,OAAO;EACP,aAAa;EACb,CAAC;CACF,yBAAyB,EAAE,SAAS,CAAC,QAAQ,MAAM,CAAC,KAAK,EACxD,aAAa,+CACb,CAAC;CACF,gBAAgB,EAAE,SAAS,CAAC,QAAQ,KAAK,CAAC,KAAK,EAC9C,aAAa,sDACb,CAAC;CACF,WAAW,EAAE,SAAS,CAAC,QAAQ,MAAM,CAAC,KAAK;EAC1C,OAAO;EACP,aAAa;EACb,CAAC;CACF,aAAa,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,MAAM,CAAC,KAAK,EACvD,aAAa,yCACb,CAAC;CACF,UAAU,oBACR,UAAU,CACV,QAAQ,qBAAqB,CAC7B,SAAS,+CAA+C;CAC1D,aAAa,EAAE,SAAS,CAAC,QAAQ,KAAK,CAAC,KAAK;EAC3C,OAAO;EACP,aAAa;EACb,CAAC;CACF,wBAAwB,EAAE,SAAS,CAAC,QAAQ,MAAM,CAAC,KAAK;EACvD,OAAO;EACP,aAAa;EACb,CAAC;CACF,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,GAAG,CAAC,KAAK,EACnD,aAAa,iCACb,CAAC;CACF,WAAW,gBACT,UAAU,CACV,QAAQ,iBAAiB,CACzB,SACA,8DACA;CACF,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,oBAAoB,CAAC,KAAK,EACnE,aAAa,uDACb,CAAC;CACF,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,GAAG,CAAC,KAAK,EACjD,aAAa,8BACb,CAAC;CACF,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,QAAQ,CAAC,KAAK,EACzD,aAAa,mDACb,CAAC;CACF,SAAS,EAAE,SAAS,CAAC,QAAQ,MAAM,CAAC,KAAK;EACxC,OAAO;EACP,aAAa;EACb,CAAC;CACF,CAAC;AAEF,MAAa,eAAe,cAAc,UAAU"}