@stephansama/auto-readme 0.2.8 → 0.2.10

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 (7) hide show
  1. package/README.md +6 -2
  2. package/config/schema.cjs +1 -1
  3. package/config/schema.json +1 -1
  4. package/config/schema.mjs +1 -1
  5. package/dist/index.cjs +5 -5
  6. package/dist/index.mjs +3 -3
  7. package/package.json +24 -19
package/README.md CHANGED
@@ -1,4 +1,8 @@
1
- # Auto Readme 🪄
1
+ <div align="center">
2
+
3
+ # [`@stephansama`](https://github.com/stephansama) / auto-readme
4
+
5
+ </div>
2
6
 
3
7
  [![Source code](https://img.shields.io/badge/Source-666666?style=flat&logo=github&label=Github&labelColor=211F1F)](https://github.com/stephansama/packages/tree/main/core/auto-readme)
4
8
  [![Documentation](https://img.shields.io/badge/Documentation-211F1F?style=flat&logo=Wikibooks&labelColor=211F1F)](https://packages.stephansama.info/api/@stephansama/auto-readme)
@@ -192,7 +196,7 @@ _Object containing the following properties:_
192
196
  | `enablePrettier` | Whether or not to use prettier to format the files | `boolean` | `true` |
193
197
  | `enableToc` | generate table of contents for readmes | `boolean` | `false` |
194
198
  | `enableUsage` | Whether or not to enable usage plugin | `boolean` | `false` |
195
- | `headings` | List of headings for different table outputs | _Object with dynamic keys of type_ [Actions](#actions) _and values of type_ `Array<'default' \| 'description' \| 'devDependency' \| 'downloads' \| 'name' \| 'private' \| 'required' \| 'version'>` (_optional_) | `{}` |
199
+ | `headings` | List of headings for different table outputs | _Object with dynamic keys of type_ [Actions](#actions) _and values of type_ `Array<'default' \| 'description' \| 'devDependency' \| 'downloads' \| 'name' \| 'private' \| 'required' \| 'version'>` (_optional_) | `{"ACTION":["name","required","default","description"],"PKG":["name","version","devDependency"],"USAGE":[],"WORKSPACE":["name","version","downloads","description"],"ZOD":[]}` |
196
200
  | `onlyReadmes` | Whether or not to only traverse readmes | `boolean` | `true` |
197
201
  | `onlyShowPublicPackages` | Only show public packages in workspaces | `boolean` | `false` |
198
202
  | `removeScope` | Remove common workspace scope | `string` | `''` |
package/config/schema.cjs CHANGED
@@ -80,7 +80,7 @@ const templatesSchema = zod.object({
80
80
  versionImage: zod.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
81
81
  });
82
82
  const defaultTemplates = templatesSchema.parse({});
83
- const defaultTableHeadings = tableHeadingsSchema.parse({});
83
+ const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
84
84
  const configSchema = zod.object({
85
85
  affectedRegexes: zod.array(zod.string().trim()),
86
86
  collapseHeadings: zod.array(zod.string().trim()),
package/config/schema.json CHANGED
@@ -1 +1 @@
1
- {"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"type":"array","items":{"type":"string"}},"collapseHeadings":{"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":{},"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}
1
+ {"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"affectedRegexes":{"type":"array","items":{"type":"string"}},"collapseHeadings":{"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/config/schema.mjs CHANGED
@@ -56,7 +56,7 @@ const templatesSchema = z.object({
56
56
  versionImage: z.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
57
57
  });
58
58
  const defaultTemplates = templatesSchema.parse({});
59
- const defaultTableHeadings = tableHeadingsSchema.parse({});
59
+ const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
60
60
  const configSchema = z.object({
61
61
  affectedRegexes: z.array(z.string().trim()),
62
62
  collapseHeadings: z.array(z.string().trim()),
package/dist/index.cjs CHANGED
@@ -34,11 +34,11 @@ let yargs_helpers = require("yargs/helpers");
34
34
  let zod = require("zod");
35
35
  zod = __toESM(zod, 1);
36
36
  let mdast_comment_marker = require("mdast-comment-marker");
37
- let _iarna_toml = require("@iarna/toml");
38
- _iarna_toml = __toESM(_iarna_toml, 1);
39
37
  let cosmiconfig = require("cosmiconfig");
40
38
  let deepmerge = require("deepmerge");
41
39
  deepmerge = __toESM(deepmerge, 1);
40
+ let smol_toml = require("smol-toml");
41
+ smol_toml = __toESM(smol_toml, 1);
42
42
  let _manypkg_get_packages = require("@manypkg/get-packages");
43
43
  let node_fs = require("node:fs");
44
44
  node_fs = __toESM(node_fs, 1);
@@ -120,7 +120,7 @@ const templatesSchema = zod.object({
120
120
  versionImage: zod.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
121
121
  });
122
122
  const defaultTemplates = templatesSchema.parse({});
123
- const defaultTableHeadings = tableHeadingsSchema.parse({});
123
+ const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
124
124
  const configSchema = zod.object({
125
125
  affectedRegexes: zod.array(zod.string().trim()),
126
126
  collapseHeadings: zod.array(zod.string().trim()),
@@ -284,7 +284,7 @@ async function loadConfig(arguments_) {
284
284
  return configSchema.parse((0, deepmerge.default)(search?.config || {}, arguments_, { arrayMerge: (_, sourceArray) => sourceArray }));
285
285
  }
286
286
  function loadToml(_filepath, content) {
287
- return _iarna_toml.default.parse(content);
287
+ return smol_toml.parse(content);
288
288
  }
289
289
  function getSearchPlaces() {
290
290
  return [
@@ -488,7 +488,7 @@ const autoReadmeRemarkPlugin = (config, data) => (tree) => {
488
488
  const workspace = data.find((d) => d?.action === "WORKSPACE");
489
489
  const templates = loadTemplates(config.templates);
490
490
  const packages = workspace?.workspaces?.packages || [];
491
- const headings = config.headings?.WORKSPACE?.length && config.headings?.WORKSPACE || defaultTableHeadings.WORKSPACE || [];
491
+ const headings = config.headings?.WORKSPACE?.length && config.headings?.WORKSPACE || defaultTableHeadings.WORKSPACE;
492
492
  if (comment && comment.format === "LIST") {}
493
493
  const table = (0, markdown_table.markdownTable)([createHeading(headings, config.disableEmojis, config.templates?.emojis) || [], ...packages.filter((pkg) => config.onlyShowPublicPackages ? !pkg.packageJson.private : true).map((pkg) => {
494
494
  const { name } = pkg.packageJson;
package/dist/index.mjs CHANGED
@@ -7,9 +7,9 @@ import yargs from "yargs";
7
7
  import { hideBin } from "yargs/helpers";
8
8
  import * as z from "zod";
9
9
  import { commentMarker } from "mdast-comment-marker";
10
- import toml from "@iarna/toml";
11
10
  import { cosmiconfig, getDefaultSearchPlaces } from "cosmiconfig";
12
11
  import deepmerge from "deepmerge";
12
+ import * as toml from "smol-toml";
13
13
  import { getPackages } from "@manypkg/get-packages";
14
14
  import * as fs from "node:fs";
15
15
  import path from "node:path";
@@ -83,7 +83,7 @@ const templatesSchema = z.object({
83
83
  versionImage: z.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
84
84
  });
85
85
  const defaultTemplates = templatesSchema.parse({});
86
- const defaultTableHeadings = tableHeadingsSchema.parse({});
86
+ const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
87
87
  const configSchema = z.object({
88
88
  affectedRegexes: z.array(z.string().trim()),
89
89
  collapseHeadings: z.array(z.string().trim()),
@@ -451,7 +451,7 @@ const autoReadmeRemarkPlugin = (config, data) => (tree) => {
451
451
  const workspace = data.find((d) => d?.action === "WORKSPACE");
452
452
  const templates = loadTemplates(config.templates);
453
453
  const packages = workspace?.workspaces?.packages || [];
454
- const headings = config.headings?.WORKSPACE?.length && config.headings?.WORKSPACE || defaultTableHeadings.WORKSPACE || [];
454
+ const headings = config.headings?.WORKSPACE?.length && config.headings?.WORKSPACE || defaultTableHeadings.WORKSPACE;
455
455
  if (comment && comment.format === "LIST") {}
456
456
  const table = markdownTable([createHeading(headings, config.disableEmojis, config.templates?.emojis) || [], ...packages.filter((pkg) => config.onlyShowPublicPackages ? !pkg.packageJson.private : true).map((pkg) => {
457
457
  const { name } = pkg.packageJson;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stephansama/auto-readme",
3
- "version": "0.2.8",
3
+ "version": "0.2.10",
4
4
  "description": "Generate lists and tables for your README automagically based on your repository and comments",
5
5
  "keywords": [
6
6
  "auto",
@@ -28,42 +28,48 @@
28
28
  "type": "module",
29
29
  "exports": {
30
30
  ".": {
31
+ "import": "./dist/index.mjs",
32
+ "require": "./dist/index.cjs"
33
+ },
34
+ "./schema": {
31
35
  "import": "./config/schema.mjs",
32
36
  "require": "./config/schema.cjs"
33
37
  },
34
- "./package.json": "./package.json"
38
+ "./package.json": "./package.json",
39
+ "./schema.json": "./config/schema.json"
35
40
  },
36
- "main": "./config/schema.cjs",
37
- "types": "./config/schema.d.cts",
41
+ "main": "./dist/index.cjs",
42
+ "module": "./dist/index.mjs",
43
+ "types": "./dist/index.d.cts",
38
44
  "bin": "./cli.mjs",
39
45
  "files": [
40
46
  "./dist",
41
47
  "./config"
42
48
  ],
43
49
  "dependencies": {
44
- "@iarna/toml": "2.2.5",
45
50
  "@manypkg/get-packages": "3.1.0",
46
51
  "cosmiconfig": "9.0.0",
47
52
  "deepmerge": "4.3.1",
48
53
  "handlebars": "4.7.9",
49
- "markdown-table": "^3.0.4",
54
+ "markdown-table": "3.0.4",
50
55
  "mdast": "3.0.0",
51
- "mdast-comment-marker": "^3.0.0",
52
- "mdast-util-from-markdown": "^2.0.2",
56
+ "mdast-comment-marker": "3.0.0",
57
+ "mdast-util-from-markdown": "2.0.2",
53
58
  "mdast-zone": "github:stephansama/mdast-zone#1c5b08cd97240debeed4c9c6afad49df5877a132",
54
59
  "obug": "2.1.1",
55
- "pkg-types": "^2.3.0",
60
+ "pkg-types": "2.3.0",
56
61
  "remark": "15.0.1",
57
- "remark-code-import": "^1.2.0",
58
- "remark-collapse": "^0.1.2",
59
- "remark-toc": "^9.0.0",
60
- "remark-usage": "^11.0.1",
62
+ "remark-code-import": "1.2.0",
63
+ "remark-collapse": "0.1.2",
64
+ "remark-toc": "9.0.0",
65
+ "remark-usage": "11.0.1",
66
+ "smol-toml": "1.6.1",
61
67
  "tinyglobby": "0.2.16",
62
- "vfile": "^6.0.3",
63
- "yaml": "^2.8.2",
68
+ "vfile": "6.0.3",
69
+ "yaml": "2.8.2",
64
70
  "yargs": "18.0.0",
65
71
  "zod": "4.2.1",
66
- "zod2md": "^0.2.5"
72
+ "zod2md": "0.2.5"
67
73
  },
68
74
  "devDependencies": {
69
75
  "@types/mdast": "4.0.4",
@@ -80,11 +86,10 @@
80
86
  "access": "public",
81
87
  "provenance": true
82
88
  },
83
- "module": "./config/schema.mjs",
84
89
  "scripts": {
85
- "build": "node build.mjs",
90
+ "build": "tsdown",
86
91
  "postbuild": "publint",
87
- "dev": "node --watch-path=./src build.mjs",
92
+ "dev": "tsdown --watch",
88
93
  "lint": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern",
89
94
  "lint:fix": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern --fix"
90
95
  }