@stephansama/auto-readme 0.2.1 → 0.2.3

package/config/schema.js

@@ -1,106 +1,101 @@
-// src/schema.js
 import { z } from "zod";
-var actionsSchema = z.enum(["ACTION", "PKG", "USAGE", "WORKSPACE", "ZOD"]).describe("Comment action options");
-var formatsSchema = z.enum(["LIST", "TABLE"]).default("TABLE").optional();
-var languageSchema = z.enum(["JS", "RS"]).optional().default("JS");
-var headingsSchema = z.enum([
-  "default",
-  "description",
-  "devDependency",
-  "downloads",
-  "name",
-  "private",
-  "required",
-  "version"
+
+//#region src/schema.ts
+const actionsSchema = z.enum([
+	"ACTION",
+	"PKG",
+	"USAGE",
+	"WORKSPACE",
+	"ZOD"
+]).describe("Comment action options");
+const formatsSchema = z.enum(["LIST", "TABLE"]).default("TABLE").optional();
+const languageSchema = z.enum(["JS", "RS"]).optional().default("JS");
+const headingsSchema = z.enum([
+	"default",
+	"description",
+	"devDependency",
+	"downloads",
+	"name",
+	"private",
+	"required",
+	"version"
 ]).describe("Table heading options");
-var tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optional()).optional().describe("Table heading action configuration").default({
-  ACTION: ["name", "required", "default", "description"],
-  PKG: ["name", "version", "devDependency"],
-  WORKSPACE: ["name", "version", "downloads", "description"],
-  ZOD: []
+const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optional()).optional().describe("Table heading action configuration").default({
+	ACTION: [
+		"name",
+		"required",
+		"default",
+		"description"
+	],
+	PKG: [
+		"name",
+		"version",
+		"devDependency"
+	],
+	USAGE: [],
+	WORKSPACE: [
+		"name",
+		"version",
+		"downloads",
+		"description"
+	],
+	ZOD: []
 });
-var templatesSchema = z.object({
-  downloadImage: z.string().optional().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
-  emojis: z.record(headingsSchema, z.string()).optional().describe("Table heading emojis used when enabled").default({
-    default: "\u2699\uFE0F",
-    description: "\u{1F4DD}",
-    devDependency: "\u{1F4BB}",
-    downloads: "\u{1F4E5}",
-    name: "\u{1F3F7}\uFE0F",
-    private: "\u{1F512}",
-    required: "",
-    version: ""
-  }),
-  registryUrl: z.string().optional().default("https://www.npmjs.com/package/{{name}}"),
-  versionImage: z.string().optional().default(
-    "https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F"
-  )
+const templatesSchema = z.object({
+	downloadImage: z.string().optional().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
+	emojis: z.record(headingsSchema, z.string()).optional().describe("Table heading emojis used when enabled").default({
+		default: "⚙️",
+		description: "📝",
+		devDependency: "💻",
+		downloads: "📥",
+		name: "🏷️",
+		private: "🔒",
+		required: "",
+		version: ""
+	}),
+	registryUrl: z.string().optional().default("https://www.npmjs.com/package/{{name}}"),
+	versionImage: z.string().optional().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
 });
-var defaultTemplates = templatesSchema.parse({});
-var defaultTableHeadings = tableHeadingsSchema.parse(void 0);
-var _configSchema = z.object({
-  affectedRegexes: z.string().array().optional().default([]),
-  collapseHeadings: z.string().array().optional().default([]),
-  defaultLanguage: languageSchema.meta({
-    alias: "l",
-    description: "Default language to infer projects from"
-  }),
-  disableEmojis: z.boolean().default(false).meta({
-    alias: "e",
-    description: "Whether or not to use emojis in markdown table headings"
-  }),
-  disableMarkdownHeadings: z.boolean().default(false).meta({
-    description: "Whether or not to display markdown headings"
-  }),
-  enablePrettier: z.boolean().default(true).meta({
-    description: "Whether or not to use prettier to format the files"
-  }),
-  enableToc: z.boolean().default(false).meta({
-    alias: "t",
-    description: "generate table of contents for readmes"
-  }),
-  enableUsage: z.boolean().optional().default(false).meta({
-    description: "Whether or not to enable usage plugin"
-  }),
-  headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
-  onlyReadmes: z.boolean().default(true).meta({
-    alias: "r",
-    description: "Whether or not to only traverse readmes"
-  }),
-  onlyShowPublicPackages: z.boolean().default(false).meta({
-    alias: "p",
-    description: "Only show public packages in workspaces"
-  }),
-  removeScope: z.string().optional().default("").meta({
-    description: "Remove common workspace scope"
-  }),
-  templates: templatesSchema.optional().default(defaultTemplates).describe(
-    "Handlebars templates used to fuel list and table generation"
-  ),
-  tocHeading: z.string().optional().default("Table of contents").meta({
-    description: "Markdown heading used to generate table of contents"
-  }),
-  usageFile: z.string().optional().default("").meta({
-    description: "Workspace level usage file"
-  }),
-  usageHeading: z.string().optional().default("Usage").meta({
-    description: "Markdown heading used to generate usage example"
-  }),
-  verbose: z.boolean().default(false).meta({
-    alias: "v",
-    description: "whether or not to display verbose logging"
-  })
+const defaultTemplates = templatesSchema.parse({});
+const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
+const _configSchema = z.object({
+	affectedRegexes: z.string().array().optional().default([]),
+	collapseHeadings: z.string().array().optional().default([]),
+	defaultLanguage: languageSchema.meta({
+		alias: "l",
+		description: "Default language to infer projects from"
+	}),
+	disableEmojis: z.boolean().default(false).meta({
+		alias: "e",
+		description: "Whether or not to use emojis in markdown table headings"
+	}),
+	disableMarkdownHeadings: z.boolean().default(false).meta({ description: "Whether or not to display markdown headings" }),
+	enablePrettier: z.boolean().default(true).meta({ description: "Whether or not to use prettier to format the files" }),
+	enableToc: z.boolean().default(false).meta({
+		alias: "t",
+		description: "generate table of contents for readmes"
+	}),
+	enableUsage: z.boolean().optional().default(false).meta({ description: "Whether or not to enable usage plugin" }),
+	headings: tableHeadingsSchema.optional().default(defaultTableHeadings).describe("List of headings for different table outputs"),
+	onlyReadmes: z.boolean().default(true).meta({
+		alias: "r",
+		description: "Whether or not to only traverse readmes"
+	}),
+	onlyShowPublicPackages: z.boolean().default(false).meta({
+		alias: "p",
+		description: "Only show public packages in workspaces"
+	}),
+	removeScope: z.string().optional().default("").meta({ description: "Remove common workspace scope" }),
+	templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
+	tocHeading: z.string().optional().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
+	usageFile: z.string().optional().default("").meta({ description: "Workspace level usage file" }),
+	usageHeading: z.string().optional().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
+	verbose: z.boolean().default(false).meta({
+		alias: "v",
+		description: "whether or not to display verbose logging"
+	})
 });
-var configSchema = _configSchema.optional();
-export {
-  actionsSchema,
-  configSchema,
-  defaultTableHeadings,
-  defaultTemplates,
-  formatsSchema,
-  headingsSchema,
-  languageSchema,
-  tableHeadingsSchema,
-  templatesSchema
-};
-//# sourceMappingURL=schema.js.map
+const configSchema = _configSchema.optional();
+
+//#endregion
+export { actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };

package/config/schema.json

@@ -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}
+{"$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":{"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}

package/config/schema.yaml

@@ -53,6 +53,7 @@ properties:
         - name
         - version
         - devDependency
+      USAGE: []
       WORKSPACE:
         - name
         - version