@stephansama/auto-readme 0.1.0

package/config/schema.d.ts

@@ -0,0 +1,167 @@
+import { z } from 'zod';
+
+declare const actionsSchema: z.ZodEnum<{
+    ACTION: "ACTION";
+    PKG: "PKG";
+    USAGE: "USAGE";
+    WORKSPACE: "WORKSPACE";
+    ZOD: "ZOD";
+}>;
+declare const formatsSchema: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+    LIST: "LIST";
+    TABLE: "TABLE";
+}>>>;
+declare const languageSchema: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+    JS: "JS";
+    RS: "RS";
+}>>>;
+declare const headingsSchema: z.ZodEnum<{
+    default: "default";
+    description: "description";
+    devDependency: "devDependency";
+    downloads: "downloads";
+    name: "name";
+    private: "private";
+    required: "required";
+    version: "version";
+}>;
+declare const tableHeadingsSchema: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+    ACTION: "ACTION";
+    PKG: "PKG";
+    USAGE: "USAGE";
+    WORKSPACE: "WORKSPACE";
+    ZOD: "ZOD";
+}>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
+    default: "default";
+    description: "description";
+    devDependency: "devDependency";
+    downloads: "downloads";
+    name: "name";
+    private: "private";
+    required: "required";
+    version: "version";
+}>>>>>>;
+declare const templatesSchema: z.ZodObject<{
+    downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        default: "default";
+        description: "description";
+        devDependency: "devDependency";
+        downloads: "downloads";
+        name: "name";
+        private: "private";
+        required: "required";
+        version: "version";
+    }>, z.ZodString>>>;
+    registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+declare const defaultTemplates: {
+    downloadImage: string;
+    emojis: Record<"default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>;
+    registryUrl: string;
+    versionImage: string;
+};
+declare const defaultTableHeadings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD", ("default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version")[] | undefined>;
+declare const configSchema: z.ZodOptional<z.ZodObject<{
+    affectedRegexes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        JS: "JS";
+        RS: "RS";
+    }>>>;
+    disableEmojis: z.ZodDefault<z.ZodBoolean>;
+    disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
+    enableToc: z.ZodDefault<z.ZodBoolean>;
+    enableUsage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        ACTION: "ACTION";
+        PKG: "PKG";
+        USAGE: "USAGE";
+        WORKSPACE: "WORKSPACE";
+        ZOD: "ZOD";
+    }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        default: "default";
+        description: "description";
+        devDependency: "devDependency";
+        downloads: "downloads";
+        name: "name";
+        private: "private";
+        required: "required";
+        version: "version";
+    }>>>>>>>>;
+    onlyReadmes: z.ZodDefault<z.ZodBoolean>;
+    onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
+    removeScope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            default: "default";
+            description: "description";
+            devDependency: "devDependency";
+            downloads: "downloads";
+            name: "name";
+            private: "private";
+            required: "required";
+            version: "version";
+        }>, z.ZodString>>>;
+        registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tocHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    verbose: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>>;
+type Config = Partial<z.infer<typeof _configSchema>>;
+
+declare const _configSchema: z.ZodObject<{
+    affectedRegexes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    defaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        JS: "JS";
+        RS: "RS";
+    }>>>;
+    disableEmojis: z.ZodDefault<z.ZodBoolean>;
+    disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
+    enableToc: z.ZodDefault<z.ZodBoolean>;
+    enableUsage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        ACTION: "ACTION";
+        PKG: "PKG";
+        USAGE: "USAGE";
+        WORKSPACE: "WORKSPACE";
+        ZOD: "ZOD";
+    }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        default: "default";
+        description: "description";
+        devDependency: "devDependency";
+        downloads: "downloads";
+        name: "name";
+        private: "private";
+        required: "required";
+        version: "version";
+    }>>>>>>>>;
+    onlyReadmes: z.ZodDefault<z.ZodBoolean>;
+    onlyShowPublicPackages: z.ZodDefault<z.ZodBoolean>;
+    removeScope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        downloadImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        emojis: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            default: "default";
+            description: "description";
+            devDependency: "devDependency";
+            downloads: "downloads";
+            name: "name";
+            private: "private";
+            required: "required";
+            version: "version";
+        }>, z.ZodString>>>;
+        registryUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        versionImage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tocHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    usageFile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    usageHeading: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    verbose: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+
+export { type Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, headingsSchema, languageSchema, tableHeadingsSchema, templatesSchema };

package/config/schema.js

@@ -0,0 +1,102 @@
+// 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"
+]).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: []
+});
+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"
+  )
+});
+var defaultTemplates = templatesSchema.parse({});
+var defaultTableHeadings = tableHeadingsSchema.parse(void 0);
+var _configSchema = z.object({
+  affectedRegexes: 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"
+  }),
+  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

package/config/schema.js.map

@@ -0,0 +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\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\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,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,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":[]}

package/config/schema.json

@@ -0,0 +1 @@
+{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"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"},"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","defaultLanguage","disableEmojis","disableMarkdownHeadings","enableToc","enableUsage","headings","onlyReadmes","onlyShowPublicPackages","removeScope","templates","tocHeading","usageFile","usageHeading","verbose"],"additionalProperties":false}

package/config/schema.yaml

@@ -0,0 +1,182 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+type: object
+properties:
+  affectedRegexes:
+    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
+  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
+  - defaultLanguage
+  - disableEmojis
+  - disableMarkdownHeadings
+  - enableToc
+  - enableUsage
+  - headings
+  - onlyReadmes
+  - onlyShowPublicPackages
+  - removeScope
+  - templates
+  - tocHeading
+  - usageFile
+  - usageHeading
+  - verbose
+additionalProperties: false