@stephansama/auto-readme 0.2.9 → 0.2.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stephansama/auto-readme",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "Generate lists and tables for your README automagically based on your repository and comments",
   "keywords": [
     "auto",
@@ -27,44 +27,45 @@
   "sideEffects": false,
   "type": "module",
   "exports": {
-    ".": {
-      "import": "./config/schema.mjs",
-      "require": "./config/schema.cjs"
-    },
-    "./package.json": "./package.json"
+    ".": "./dist/index.mjs",
+    "./cli": "./dist/cli.mjs",
+    "./package.json": "./package.json",
+    "./schema": "./dist/schema.mjs",
+    "./schema.json": "./dist/schema.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "auto-readme": "./dist/cli.mjs"
   },
-  "main": "./config/schema.cjs",
-  "module": "./config/schema.mjs",
-  "types": "./config/schema.d.cts",
-  "bin": "./cli.mjs",
   "files": [
-    "./dist",
-    "./config"
+    "./dist"
   ],
   "dependencies": {
     "@manypkg/get-packages": "3.1.0",
     "cosmiconfig": "9.0.0",
     "deepmerge": "4.3.1",
     "handlebars": "4.7.9",
-    "markdown-table": "^3.0.4",
+    "markdown-table": "3.0.4",
     "mdast": "3.0.0",
-    "mdast-comment-marker": "^3.0.0",
-    "mdast-util-from-markdown": "^2.0.2",
+    "mdast-comment-marker": "3.0.0",
+    "mdast-util-from-markdown": "2.0.2",
     "mdast-zone": "github:stephansama/mdast-zone#1c5b08cd97240debeed4c9c6afad49df5877a132",
     "obug": "2.1.1",
-    "pkg-types": "^2.3.0",
+    "pkg-types": "2.3.0",
     "remark": "15.0.1",
-    "remark-code-import": "^1.2.0",
-    "remark-collapse": "^0.1.2",
-    "remark-toc": "^9.0.0",
-    "remark-usage": "^11.0.1",
+    "remark-code-import": "1.2.0",
+    "remark-collapse": "0.1.2",
+    "remark-toc": "9.0.0",
+    "remark-usage": "11.0.1",
     "smol-toml": "1.6.1",
     "tinyglobby": "0.2.16",
-    "vfile": "^6.0.3",
-    "yaml": "^2.8.2",
+    "vfile": "6.0.3",
+    "yaml": "2.8.2",
     "yargs": "18.0.0",
     "zod": "4.2.1",
-    "zod2md": "^0.2.5"
+    "zod2md": "0.2.5"
   },
   "devDependencies": {
     "@types/mdast": "4.0.4",
@@ -82,9 +83,9 @@
     "provenance": true
   },
   "scripts": {
-    "build": "node build.mjs",
+    "build": "tsdown",
     "postbuild": "publint",
-    "dev": "node --watch-path=./src build.mjs",
+    "dev": "tsdown --watch",
     "lint": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern",
     "lint:fix": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern --fix"
   }

package/cli.mjs

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-
-const cli = await import("./dist/index.mjs");
-await cli.run();

package/config/schema.cjs

@@ -1,127 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region \0rolldown/runtime.js
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-//#endregion
-let zod = require("zod");
-zod = __toESM(zod, 1);
-//#region src/schema.ts
-const actionsSchema = zod.enum([
-	"ACTION",
-	"PKG",
-	"USAGE",
-	"WORKSPACE",
-	"ZOD"
-]).meta({ description: "Comment action options" });
-const formatsSchema = zod.enum(["LIST", "TABLE"]).default("TABLE");
-const languageSchema = zod.enum(["JS", "RS"]).default("JS");
-const headingsSchema = zod.enum([
-	"default",
-	"description",
-	"devDependency",
-	"downloads",
-	"name",
-	"private",
-	"required",
-	"version"
-]).meta({ description: "Table heading options" });
-const tableHeadingsSchema = zod.record(actionsSchema, headingsSchema.array().optional()).default({
-	ACTION: [
-		"name",
-		"required",
-		"default",
-		"description"
-	],
-	PKG: [
-		"name",
-		"version",
-		"devDependency"
-	],
-	USAGE: [],
-	WORKSPACE: [
-		"name",
-		"version",
-		"downloads",
-		"description"
-	],
-	ZOD: []
-}).meta({ description: "Table heading action configuration" });
-const templatesSchema = zod.object({
-	downloadImage: zod.string().trim().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
-	emojis: zod.record(headingsSchema, zod.string().trim()).default({
-		default: "⚙️",
-		description: "📝",
-		devDependency: "💻",
-		downloads: "📥",
-		name: "🏷️",
-		private: "🔒",
-		required: "",
-		version: ""
-	}).meta({ description: "Table heading emojis used when enabled" }),
-	registryUrl: zod.string().trim().default("https://www.npmjs.com/package/{{name}}"),
-	versionImage: zod.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
-});
-const defaultTemplates = templatesSchema.parse({});
-const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
-const configSchema = zod.object({
-	affectedRegexes: zod.array(zod.string().trim()),
-	collapseHeadings: zod.array(zod.string().trim()),
-	defaultLanguage: languageSchema.meta({
-		alias: "l",
-		description: "Default language to infer projects from"
-	}),
-	disableEmojis: zod.boolean().default(false).meta({
-		alias: "e",
-		description: "Whether or not to use emojis in markdown table headings"
-	}),
-	disableMarkdownHeadings: zod.boolean().default(false).meta({ description: "Whether or not to display markdown headings" }),
-	enablePrettier: zod.boolean().default(true).meta({ description: "Whether or not to use prettier to format the files" }),
-	enableToc: zod.boolean().default(false).meta({
-		alias: "t",
-		description: "generate table of contents for readmes"
-	}),
-	enableUsage: zod.boolean().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: zod.boolean().default(true).meta({
-		alias: "r",
-		description: "Whether or not to only traverse readmes"
-	}),
-	onlyShowPublicPackages: zod.boolean().default(false).meta({
-		alias: "p",
-		description: "Only show public packages in workspaces"
-	}),
-	removeScope: zod.string().trim().default("").meta({ description: "Remove common workspace scope" }),
-	templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
-	tocHeading: zod.string().trim().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
-	usageFile: zod.string().trim().default("").meta({ description: "Workspace level usage file" }),
-	usageHeading: zod.string().trim().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
-	verbose: zod.boolean().default(false).meta({
-		alias: "v",
-		description: "whether or not to display verbose logging"
-	})
-}).optional();
-//#endregion
-exports.actionsSchema = actionsSchema;
-exports.configSchema = configSchema;
-exports.defaultTableHeadings = defaultTableHeadings;
-exports.defaultTemplates = defaultTemplates;
-exports.formatsSchema = formatsSchema;
-exports.languageSchema = languageSchema;

package/config/schema.d.cts

@@ -1,130 +0,0 @@
-import * as z from "zod";
-
-//#region src/schema.d.ts
-declare const actionsSchema: z.ZodEnum<{
-  ACTION: "ACTION";
-  PKG: "PKG";
-  USAGE: "USAGE";
-  WORKSPACE: "WORKSPACE";
-  ZOD: "ZOD";
-}>;
-declare const formatsSchema: z.ZodDefault<z.ZodEnum<{
-  LIST: "LIST";
-  TABLE: "TABLE";
-}>>;
-declare const languageSchema: z.ZodDefault<z.ZodEnum<{
-  JS: "JS";
-  RS: "RS";
-}>>;
-declare const defaultTemplates: {
-  downloadImage: string;
-  emojis: Record<"description" | "default" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>;
-  registryUrl: string;
-  versionImage: string;
-};
-declare const defaultTableHeadings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD", ("description" | "default" | "devDependency" | "downloads" | "name" | "private" | "required" | "version")[] | undefined>;
-declare const _configSchema: z.ZodObject<{
-  affectedRegexes: z.ZodArray<z.ZodString>;
-  collapseHeadings: z.ZodArray<z.ZodString>;
-  defaultLanguage: z.ZodDefault<z.ZodEnum<{
-    JS: "JS";
-    RS: "RS";
-  }>>;
-  disableEmojis: z.ZodDefault<z.ZodBoolean>;
-  disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
-  enablePrettier: z.ZodDefault<z.ZodBoolean>;
-  enableToc: z.ZodDefault<z.ZodBoolean>;
-  enableUsage: z.ZodDefault<z.ZodBoolean>;
-  headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodRecord<z.ZodEnum<{
-    ACTION: "ACTION";
-    PKG: "PKG";
-    USAGE: "USAGE";
-    WORKSPACE: "WORKSPACE";
-    ZOD: "ZOD";
-  }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
-    description: "description";
-    default: "default";
-    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.ZodString>;
-  templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-    downloadImage: z.ZodDefault<z.ZodString>;
-    emojis: z.ZodDefault<z.ZodRecord<z.ZodEnum<{
-      description: "description";
-      default: "default";
-      devDependency: "devDependency";
-      downloads: "downloads";
-      name: "name";
-      private: "private";
-      required: "required";
-      version: "version";
-    }>, z.ZodString>>;
-    registryUrl: z.ZodDefault<z.ZodString>;
-    versionImage: z.ZodDefault<z.ZodString>;
-  }, z.core.$strip>>>;
-  tocHeading: z.ZodDefault<z.ZodString>;
-  usageFile: z.ZodDefault<z.ZodString>;
-  usageHeading: z.ZodDefault<z.ZodString>;
-  verbose: z.ZodDefault<z.ZodBoolean>;
-}, z.core.$strip>;
-declare const configSchema: z.ZodOptional<z.ZodObject<{
-  affectedRegexes: z.ZodArray<z.ZodString>;
-  collapseHeadings: z.ZodArray<z.ZodString>;
-  defaultLanguage: z.ZodDefault<z.ZodEnum<{
-    JS: "JS";
-    RS: "RS";
-  }>>;
-  disableEmojis: z.ZodDefault<z.ZodBoolean>;
-  disableMarkdownHeadings: z.ZodDefault<z.ZodBoolean>;
-  enablePrettier: z.ZodDefault<z.ZodBoolean>;
-  enableToc: z.ZodDefault<z.ZodBoolean>;
-  enableUsage: z.ZodDefault<z.ZodBoolean>;
-  headings: z.ZodDefault<z.ZodOptional<z.ZodDefault<z.ZodRecord<z.ZodEnum<{
-    ACTION: "ACTION";
-    PKG: "PKG";
-    USAGE: "USAGE";
-    WORKSPACE: "WORKSPACE";
-    ZOD: "ZOD";
-  }>, z.ZodOptional<z.ZodArray<z.ZodEnum<{
-    description: "description";
-    default: "default";
-    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.ZodString>;
-  templates: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-    downloadImage: z.ZodDefault<z.ZodString>;
-    emojis: z.ZodDefault<z.ZodRecord<z.ZodEnum<{
-      description: "description";
-      default: "default";
-      devDependency: "devDependency";
-      downloads: "downloads";
-      name: "name";
-      private: "private";
-      required: "required";
-      version: "version";
-    }>, z.ZodString>>;
-    registryUrl: z.ZodDefault<z.ZodString>;
-    versionImage: z.ZodDefault<z.ZodString>;
-  }, z.core.$strip>>>;
-  tocHeading: z.ZodDefault<z.ZodString>;
-  usageFile: z.ZodDefault<z.ZodString>;
-  usageHeading: z.ZodDefault<z.ZodString>;
-  verbose: z.ZodDefault<z.ZodBoolean>;
-}, z.core.$strip>>;
-type Config = Partial<z.infer<typeof _configSchema>>;
-//#endregion
-export { Config, actionsSchema, configSchema, defaultTableHeadings, defaultTemplates, formatsSchema, languageSchema };

package/dist/index.d.cts

@@ -1,4 +0,0 @@
-//#region src/index.d.ts
-declare function run(): Promise<void>;
-//#endregion
-export { run };