@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.
Files changed (16) hide show
  1. package/README.md +19 -61
  2. package/config/schema.cjs +32 -36
  3. package/config/schema.d.cts +49 -91
  4. package/config/schema.d.ts +49 -91
  5. package/config/schema.js +22 -23
  6. package/config/schema.json +1 -1
  7. package/dist/index.cjs +48 -49
  8. package/dist/index.d.cts +1 -2
  9. package/dist/index.d.ts +1 -2
  10. package/dist/index.js +38 -39
  11. package/package.json +11 -12
  12. package/config/schema.cjs.map +0 -1
  13. package/config/schema.js.map +0 -1
  14. package/config/schema.yaml +0 -193
  15. package/dist/index.cjs.map +0 -1
  16. package/dist/index.js.map +0 -1
package/config/schema.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { z } from "zod";
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.ZodOptional<z.ZodDefault<z.ZodEnum<{
11
+ declare const formatsSchema: z.ZodDefault<z.ZodEnum<{
12
12
  LIST: "LIST";
13
13
  TABLE: "TABLE";
14
- }>>>;
15
- declare const languageSchema: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
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<"default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>;
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", ("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<{
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.ZodOptional<z.ZodBoolean>>;
79
- headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
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.ZodOptional<z.ZodString>>;
56
+ removeScope: z.ZodDefault<z.ZodString>;
98
57
  templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
99
- downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
100
- emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
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.ZodOptional<z.ZodString>>;
111
- versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
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.ZodOptional<z.ZodString>>;
114
- usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
115
- usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
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
- type Config = Partial<z.infer<typeof _configSchema>>;
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<{
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.ZodOptional<z.ZodBoolean>>;
131
- headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
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.ZodOptional<z.ZodString>>;
107
+ removeScope: z.ZodDefault<z.ZodString>;
150
108
  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";
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.ZodOptional<z.ZodString>>;
163
- versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
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.ZodOptional<z.ZodString>>;
166
- usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
167
- usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
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, headingsSchema, languageSchema, tableHeadingsSchema, templatesSchema };
172
- //# sourceMappingURL=schema.d.ts.map
130
+ export { Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };
package/config/schema.js CHANGED
@@ -1,15 +1,15 @@
1
- import { z } from "zod";
1
+ import * as z from "zod";
2
2
 
3
- //#region src/schema.js
3
+ //#region src/schema.ts
4
4
  const actionsSchema = z.enum([
5
5
  "ACTION",
6
6
  "PKG",
7
7
  "USAGE",
8
8
  "WORKSPACE",
9
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");
10
+ ]).meta({ description: "Comment action options" });
11
+ const formatsSchema = z.enum(["LIST", "TABLE"]).default("TABLE");
12
+ const languageSchema = z.enum(["JS", "RS"]).default("JS");
13
13
  const headingsSchema = z.enum([
14
14
  "default",
15
15
  "description",
@@ -19,8 +19,8 @@ const headingsSchema = z.enum([
19
19
  "private",
20
20
  "required",
21
21
  "version"
22
- ]).describe("Table heading options");
23
- const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optional()).optional().describe("Table heading action configuration").default({
22
+ ]).meta({ description: "Table heading options" });
23
+ const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optional()).default({
24
24
  ACTION: [
25
25
  "name",
26
26
  "required",
@@ -32,6 +32,7 @@ const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optio
32
32
  "version",
33
33
  "devDependency"
34
34
  ],
35
+ USAGE: [],
35
36
  WORKSPACE: [
36
37
  "name",
37
38
  "version",
@@ -39,10 +40,10 @@ const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optio
39
40
  "description"
40
41
  ],
41
42
  ZOD: []
42
- });
43
+ }).meta({ description: "Table heading action configuration" });
43
44
  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({
45
+ downloadImage: z.string().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
46
+ emojis: z.record(headingsSchema, z.string()).default({
46
47
  default: "⚙️",
47
48
  description: "📝",
48
49
  devDependency: "💻",
@@ -51,15 +52,15 @@ const templatesSchema = z.object({
51
52
  private: "🔒",
52
53
  required: "",
53
54
  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")
55
+ }).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")
57
58
  });
58
59
  const defaultTemplates = templatesSchema.parse({});
59
60
  const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
60
61
  const _configSchema = z.object({
61
- affectedRegexes: z.string().array().optional().default([]),
62
- collapseHeadings: z.string().array().optional().default([]),
62
+ affectedRegexes: z.string().array().default([]),
63
+ collapseHeadings: z.string().array().default([]),
63
64
  defaultLanguage: languageSchema.meta({
64
65
  alias: "l",
65
66
  description: "Default language to infer projects from"
@@ -74,7 +75,7 @@ const _configSchema = z.object({
74
75
  alias: "t",
75
76
  description: "generate table of contents for readmes"
76
77
  }),
77
- enableUsage: z.boolean().optional().default(false).meta({ description: "Whether or not to enable usage plugin" }),
78
+ enableUsage: z.boolean().default(false).meta({ description: "Whether or not to enable usage plugin" }),
78
79
  headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
79
80
  onlyReadmes: z.boolean().default(true).meta({
80
81
  alias: "r",
@@ -84,19 +85,17 @@ const _configSchema = z.object({
84
85
  alias: "p",
85
86
  description: "Only show public packages in workspaces"
86
87
  }),
87
- removeScope: z.string().optional().default("").meta({ description: "Remove common workspace scope" }),
88
+ removeScope: z.string().default("").meta({ description: "Remove common workspace scope" }),
88
89
  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" }),
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" }),
92
93
  verbose: z.boolean().default(false).meta({
93
94
  alias: "v",
94
95
  description: "whether or not to display verbose logging"
95
96
  })
96
97
  });
97
98
  const configSchema = _configSchema.optional();
98
- /** @typedef {Partial<z.infer<typeof _configSchema>>} Config */
99
99
 
100
100
  //#endregion
101
- export { actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, headingsSchema, languageSchema, tableHeadingsSchema, templatesSchema };
102
- //# sourceMappingURL=schema.js.map
101
+ export { actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };
package/config/schema.json CHANGED
@@ -1 +1 @@
1
- {"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"default":[],"type":"array","items":{"type":"string"}},"collapseHeadings":{"default":[],"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":{"ACTION":["name","required","default","description"],"PKG":["name","version","devDependency"],"WORKSPACE":["name","version","downloads","description"],"ZOD":[]},"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":{"default":{"default":"⚙️","description":"📝","devDependency":"💻","downloads":"📥","name":"🏷️","private":"🔒","required":"","version":""},"description":"Table heading emojis used when enabled","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
+ {"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"default":[],"type":"array","items":{"type":"string"}},"collapseHeadings":{"default":[],"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":{"ACTION":["name","required","default","description"],"PKG":["name","version","devDependency"],"USAGE":[],"WORKSPACE":["name","version","downloads","description"],"ZOD":[]},"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}
package/dist/index.cjs CHANGED
@@ -78,17 +78,17 @@ markdown_table = __toESM(markdown_table);
78
78
  let mdast_zone = require("mdast-zone");
79
79
  mdast_zone = __toESM(mdast_zone);
80
80
 
81
- //#region src/schema.js
82
- const actionsSchema = zod.z.enum([
81
+ //#region src/schema.ts
82
+ const actionsSchema = zod.enum([
83
83
  "ACTION",
84
84
  "PKG",
85
85
  "USAGE",
86
86
  "WORKSPACE",
87
87
  "ZOD"
88
- ]).describe("Comment action options");
89
- const formatsSchema = zod.z.enum(["LIST", "TABLE"]).default("TABLE").optional();
90
- const languageSchema = zod.z.enum(["JS", "RS"]).optional().default("JS");
91
- const headingsSchema = zod.z.enum([
88
+ ]).meta({ description: "Comment action options" });
89
+ const formatsSchema = zod.enum(["LIST", "TABLE"]).default("TABLE");
90
+ const languageSchema = zod.enum(["JS", "RS"]).default("JS");
91
+ const headingsSchema = zod.enum([
92
92
  "default",
93
93
  "description",
94
94
  "devDependency",
@@ -97,8 +97,8 @@ const headingsSchema = zod.z.enum([
97
97
  "private",
98
98
  "required",
99
99
  "version"
100
- ]).describe("Table heading options");
101
- const tableHeadingsSchema = zod.z.record(actionsSchema, headingsSchema.array().optional()).optional().describe("Table heading action configuration").default({
100
+ ]).meta({ description: "Table heading options" });
101
+ const tableHeadingsSchema = zod.record(actionsSchema, headingsSchema.array().optional()).default({
102
102
  ACTION: [
103
103
  "name",
104
104
  "required",
@@ -110,6 +110,7 @@ const tableHeadingsSchema = zod.z.record(actionsSchema, headingsSchema.array().o
110
110
  "version",
111
111
  "devDependency"
112
112
  ],
113
+ USAGE: [],
113
114
  WORKSPACE: [
114
115
  "name",
115
116
  "version",
@@ -117,10 +118,10 @@ const tableHeadingsSchema = zod.z.record(actionsSchema, headingsSchema.array().o
117
118
  "description"
118
119
  ],
119
120
  ZOD: []
120
- });
121
- const templatesSchema = zod.z.object({
122
- downloadImage: zod.z.string().optional().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
123
- emojis: zod.z.record(headingsSchema, zod.z.string()).optional().describe("Table heading emojis used when enabled").default({
121
+ }).meta({ description: "Table heading action configuration" });
122
+ const templatesSchema = zod.object({
123
+ downloadImage: zod.string().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
124
+ emojis: zod.record(headingsSchema, zod.string()).default({
124
125
  default: "⚙️",
125
126
  description: "📝",
126
127
  devDependency: "💻",
@@ -129,51 +130,50 @@ const templatesSchema = zod.z.object({
129
130
  private: "🔒",
130
131
  required: "",
131
132
  version: ""
132
- }),
133
- registryUrl: zod.z.string().optional().default("https://www.npmjs.com/package/{{name}}"),
134
- versionImage: zod.z.string().optional().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
133
+ }).meta({ description: "Table heading emojis used when enabled" }),
134
+ registryUrl: zod.string().default("https://www.npmjs.com/package/{{name}}"),
135
+ versionImage: zod.string().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
135
136
  });
136
137
  const defaultTemplates = templatesSchema.parse({});
137
138
  const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
138
- const _configSchema = zod.z.object({
139
- affectedRegexes: zod.z.string().array().optional().default([]),
140
- collapseHeadings: zod.z.string().array().optional().default([]),
139
+ const _configSchema = zod.object({
140
+ affectedRegexes: zod.string().array().default([]),
141
+ collapseHeadings: zod.string().array().default([]),
141
142
  defaultLanguage: languageSchema.meta({
142
143
  alias: "l",
143
144
  description: "Default language to infer projects from"
144
145
  }),
145
- disableEmojis: zod.z.boolean().default(false).meta({
146
+ disableEmojis: zod.boolean().default(false).meta({
146
147
  alias: "e",
147
148
  description: "Whether or not to use emojis in markdown table headings"
148
149
  }),
149
- disableMarkdownHeadings: zod.z.boolean().default(false).meta({ description: "Whether or not to display markdown headings" }),
150
- enablePrettier: zod.z.boolean().default(true).meta({ description: "Whether or not to use prettier to format the files" }),
151
- enableToc: zod.z.boolean().default(false).meta({
150
+ disableMarkdownHeadings: zod.boolean().default(false).meta({ description: "Whether or not to display markdown headings" }),
151
+ enablePrettier: zod.boolean().default(true).meta({ description: "Whether or not to use prettier to format the files" }),
152
+ enableToc: zod.boolean().default(false).meta({
152
153
  alias: "t",
153
154
  description: "generate table of contents for readmes"
154
155
  }),
155
- enableUsage: zod.z.boolean().optional().default(false).meta({ description: "Whether or not to enable usage plugin" }),
156
+ enableUsage: zod.boolean().default(false).meta({ description: "Whether or not to enable usage plugin" }),
156
157
  headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
157
- onlyReadmes: zod.z.boolean().default(true).meta({
158
+ onlyReadmes: zod.boolean().default(true).meta({
158
159
  alias: "r",
159
160
  description: "Whether or not to only traverse readmes"
160
161
  }),
161
- onlyShowPublicPackages: zod.z.boolean().default(false).meta({
162
+ onlyShowPublicPackages: zod.boolean().default(false).meta({
162
163
  alias: "p",
163
164
  description: "Only show public packages in workspaces"
164
165
  }),
165
- removeScope: zod.z.string().optional().default("").meta({ description: "Remove common workspace scope" }),
166
+ removeScope: zod.string().default("").meta({ description: "Remove common workspace scope" }),
166
167
  templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
167
- tocHeading: zod.z.string().optional().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
168
- usageFile: zod.z.string().optional().default("").meta({ description: "Workspace level usage file" }),
169
- usageHeading: zod.z.string().optional().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
170
- verbose: zod.z.boolean().default(false).meta({
168
+ tocHeading: zod.string().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
169
+ usageFile: zod.string().default("").meta({ description: "Workspace level usage file" }),
170
+ usageHeading: zod.string().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
171
+ verbose: zod.boolean().default(false).meta({
171
172
  alias: "v",
172
173
  description: "whether or not to display verbose logging"
173
174
  })
174
175
  });
175
176
  const configSchema = _configSchema.optional();
176
- /** @typedef {Partial<z.infer<typeof _configSchema>>} Config */
177
177
 
178
178
  //#endregion
179
179
  //#region src/args.ts
@@ -213,12 +213,12 @@ function zodToYargs() {
213
213
  const { shape } = configSchema.unwrap();
214
214
  const entries = Object.entries(shape).map(([key, value]) => {
215
215
  if (complexOptions.includes(key)) return [];
216
- if (value.def.innerType instanceof zod.default.ZodObject) return [];
216
+ if (value.def.innerType instanceof zod.ZodObject) return [];
217
217
  const meta = value.meta();
218
218
  const { innerType } = value.def;
219
- const isBoolean = innerType instanceof zod.default.ZodBoolean;
220
- const isNumber = innerType instanceof zod.default.ZodNumber;
221
- const yargType = innerType instanceof zod.default.ZodArray && "array" || isNumber && "number" || isBoolean && "boolean" || "string";
219
+ const isBoolean = innerType instanceof zod.ZodBoolean;
220
+ const isNumber = innerType instanceof zod.ZodNumber;
221
+ const yargType = innerType instanceof zod.ZodArray && "array" || isNumber && "number" || isBoolean && "boolean" || "string";
222
222
  const options = {
223
223
  default: value.def.defaultValue,
224
224
  type: yargType
@@ -361,18 +361,6 @@ function findAffectedMarkdowns(root, config) {
361
361
  INFO("Found the following readmes", dedupe);
362
362
  return dedupe;
363
363
  }
364
- function findNearestReadme(gitRoot, inputFile, maxRotations = 15) {
365
- let dir = node_path.dirname(inputFile);
366
- let rotations = 0;
367
- while (true) {
368
- const option = node_path.join(dir, "README.md");
369
- if (node_fs.existsSync(option)) return option;
370
- const parent = node_path.dirname(dir);
371
- if (parent === dir || dir === gitRoot || ++rotations > maxRotations) break;
372
- dir = parent;
373
- }
374
- return null;
375
- }
376
364
  function getGitRoot() {
377
365
  const root = node_child_process.execSync(sh`git rev-parse --show-toplevel`, opts).trim();
378
366
  if (!root) throw new Error("must be ran within a git directory.");
@@ -392,6 +380,18 @@ async function getPrettierPaths(paths) {
392
380
  return node_path.join(node_path.dirname(file), symlink);
393
381
  }));
394
382
  }
383
+ function findNearestReadme(gitRoot, inputFile, maxRotations = 15) {
384
+ let dir = node_path.dirname(inputFile);
385
+ let rotations = 0;
386
+ while (true) {
387
+ const option = node_path.join(dir, "README.md");
388
+ if (node_fs.existsSync(option)) return option;
389
+ const parent = node_path.dirname(dir);
390
+ if (parent === dir || dir === gitRoot || ++rotations > maxRotations) break;
391
+ dir = parent;
392
+ }
393
+ return null;
394
+ }
395
395
 
396
396
  //#endregion
397
397
  //#region src/data.ts
@@ -680,5 +680,4 @@ async function run() {
680
680
  }
681
681
 
682
682
  //#endregion
683
- exports.run = run;
684
- //# sourceMappingURL=index.cjs.map
683
+ exports.run = run;
package/dist/index.d.cts CHANGED
@@ -1,5 +1,4 @@
1
1
  //#region src/index.d.ts
2
2
  declare function run(): Promise<void>;
3
3
  //#endregion
4
- export { run };
5
- //# sourceMappingURL=index.d.cts.map
4
+ export { run };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  //#region src/index.d.ts
2
2
  declare function run(): Promise<void>;
3
3
  //#endregion
4
- export { run };
5
- //# sourceMappingURL=index.d.ts.map
4
+ export { run };