mdat 3.6.0 → 3.6.1

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.
package/dist/bin/cli.js CHANGED
@@ -1,5 +1,5 @@
1
1
  #!/usr/bin/env node
2
- import { S as version, a as expand, b as setLogger$1, d as templates_default, f as ensureArray, l as createReadme, r as collapse, s as strip, t as check, u as createReadmeInteractive, x as name, y as log } from "../lib-CqQWGRqt.js";
2
+ import { S as version, a as expand, b as setLogger$1, d as templates_default, f as ensureArray, l as createReadme, r as collapse, s as strip, t as check, u as createReadmeInteractive, x as name, y as log } from "../lib-BU0oLDpf.js";
3
3
  import { createLogger } from "lognow";
4
4
  import picocolors from "picocolors";
5
5
  import prettyMilliseconds from "pretty-ms";
package/dist/lib/index.js CHANGED
@@ -1,3 +1,3 @@
1
- import { _ as getReadmeMetadata, a as expand, b as setLogger, c as stripString, g as getContextMetadata, h as mergeConfig, i as collapseString, l as createReadme, m as loadConfig, n as checkString, o as expandString, p as defineConfig, r as collapse, s as strip, t as check, u as createReadmeInteractive, v as resetMetadataCaches } from "../lib-CqQWGRqt.js";
1
+ import { _ as getReadmeMetadata, a as expand, b as setLogger, c as stripString, g as getContextMetadata, h as mergeConfig, i as collapseString, l as createReadme, m as loadConfig, n as checkString, o as expandString, p as defineConfig, r as collapse, s as strip, t as check, u as createReadmeInteractive, v as resetMetadataCaches } from "../lib-BU0oLDpf.js";
2
2
 
3
3
  export { check, checkString, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger, strip, stripString };
@@ -26,7 +26,7 @@ import { confirm, group, intro, note, outro, select } from "@clack/prompts";
26
26
 
27
27
  //#region package.json
28
28
  var name = "mdat";
29
- var version = "3.6.0";
29
+ var version = "3.6.1";
30
30
 
31
31
  //#endregion
32
32
  //#region src/lib/deep-merge-defined.ts
@@ -1130,11 +1130,12 @@ async function findSkills(projectDirectory) {
1130
1130
  if (error instanceof Error && "code" in error && error.code === "ENOENT") continue;
1131
1131
  throw error;
1132
1132
  }
1133
+ const filePath = `${SKILLS_DIRECTORY}/${entry.name}/${SKILL_FILE_NAME}`;
1133
1134
  const frontmatter = skillFrontmatterSchema.safeParse(matter(skillFile).data);
1134
- if (!frontmatter.success) throw new Error(`Skill at "${path.relative(projectDirectory, skillFilePath)}" needs "name" and "description" strings in its frontmatter`);
1135
+ if (!frontmatter.success) throw new Error(`Skill at "${filePath}" needs "name" and "description" strings in its frontmatter`);
1135
1136
  skills.push({
1136
1137
  ...frontmatter.data,
1137
- filePath: `${SKILLS_DIRECTORY}/${entry.name}/${SKILL_FILE_NAME}`
1138
+ filePath
1138
1139
  });
1139
1140
  }
1140
1141
  return skills.toSorted((a, b) => a.name.localeCompare(b.name));
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "mdat",
3
- "version": "3.6.0",
4
- "description": "CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.",
3
+ "version": "3.6.1",
4
+ "description": "CLI tool and TypeScript library to turn comments into content in Markdown files. MDAT makes it easy to generate and update dynamic boilerplate in project readmes.",
5
5
  "keywords": [
6
6
  "mdat",
7
7
  "markdown",
package/readme.md CHANGED
@@ -4,18 +4,19 @@
4
4
 
5
5
  <!-- /title -->
6
6
 
7
- <!-- // badges -->
7
+ <!-- badges({ npmDownloads: true }) -->
8
8
 
9
9
  [![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://www.npmjs.com/package/mdat)
10
10
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
11
11
  [![CI](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml)
12
12
  [![Homebrew](https://img.shields.io/badge/Homebrew-kitschpatrol%2Ftap%2Fmdat-FBB040?logo=homebrew&logoColor=white)](https://github.com/kitschpatrol/homebrew-tap/blob/HEAD/Formula/mdat.rb)
13
+ [![NPM Downloads mdat](https://img.shields.io/npm/dm/mdat)](https://www.npmjs.com/package/mdat)
13
14
 
14
- <!-- // /badges -->
15
+ <!-- /badges -->
15
16
 
16
17
  <!-- description -->
17
18
 
18
- **CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.**
19
+ **CLI tool and TypeScript library to turn comments into content in Markdown files. MDAT makes it easy to generate and update dynamic boilerplate in project readmes.**
19
20
 
20
21
  <!-- /description -->
21
22
 
@@ -66,9 +67,9 @@ MDAT is a CLI tool and library that uses HTML comments in Markdown files as plac
66
67
  <!-- tldraw({src: "assets/mdat-flow.tldr"}) -->
67
68
 
68
69
  <picture>
69
- <source media="(prefers-color-scheme: dark)" srcset="assets/mdat-flow-63a3366c-dark.svg">
70
- <source media="(prefers-color-scheme: light)" srcset="assets/mdat-flow-63a3366c-light.svg">
71
- <img alt="tldraw diagram" src="assets/mdat-flow-63a3366c-light.svg">
70
+ <source media="(prefers-color-scheme: dark)" srcset="assets/mdat-flow-c037b16c-dark.svg">
71
+ <source media="(prefers-color-scheme: light)" srcset="assets/mdat-flow-c037b16c-light.svg">
72
+ <img alt="tldraw diagram" src="assets/mdat-flow-c037b16c-light.svg">
72
73
  </picture>
73
74
 
74
75
  <!-- /tldraw -->
@@ -798,7 +799,7 @@ Generate API documentation for a TypeScript package's public exports. Runs [Type
798
799
 
799
800
  Example: `<!-- api-help({ format: "compact", include: ["sync*"] }) -->`
800
801
 
801
- <!-- // skills -->
802
+ <!-- skills -->
802
803
 
803
804
  ## Agent skills
804
805
 
@@ -826,7 +827,7 @@ Use and configure mdat, the Markdown Autophagic Template CLI and library that ex
826
827
 
827
828
  Write custom mdat expansion rules and publishable mdat rule plugins (mdat-plugin-\* packages).
828
829
 
829
- <!-- // /skills -->
830
+ <!-- /skills -->
830
831
 
831
832
  ## Migrating from 1.x to 2.x
832
833
 
@@ -928,6 +929,8 @@ There's quite a bit of prior art and similar explorations of this problem space:
928
929
 
929
930
  This project was split from a monorepo containing both `mdat` and `remark-mdat` into separate repos in July 2024.
930
931
 
932
+ The name "MDAT" is an acronym for the "Markdown Autophagic Template" system, so named because of the circularity of a templating system where the input file is also the output file.
933
+
931
934
  Run `pnpm bench` to compare performance against `test/benchmarks/baseline.json`. Run `pnpm bench:baseline` to refresh the saved results using Vitest 5's benchmark format. Both commands support filters such as `-t loadConfig`; refreshing a filtered subset preserves the other baselines. Use the same machine and Node.js version for meaningful comparisons.
932
935
 
933
936
  ## Maintainers