mdat 2.3.0 → 2.3.1

package/dist/bin/cli.js

@@ -42,7 +42,7 @@ function deepMergeDefined(...objects) {
 //#endregion
 //#region package.json
 var name = "mdat";
-var version = "2.3.0";
+var version = "2.3.1";
 
 //#endregion
 //#region src/lib/log.ts
@@ -56,9 +56,11 @@ let log = createLogger({
 setLogger(getChildLogger(log, "remark-mdat"));
 setLogger$1(getChildLogger(log, "metascope"));
 /**
-* Set the logger instance for the module.
-* Export this for library consumers to inject their own logger.
-* @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+* Set the logger instance for the module. Export this for library consumers to
+* inject their own logger.
+*
+* @param logger - Accepts either a LogLayer instance or a Console- or
+*   Stream-like log target
 */
 function setLogger$2(logger) {
 	log = injectionHelper(logger);
@@ -69,9 +71,10 @@ function setLogger$2(logger) {
 //#endregion
 //#region src/lib/mdat-json-loader.ts
 /**
-* Lets arbitrary JSON objects (like from package.json) become reasonably good mdat rule sets
-* HOWEVER cosmiconfig treats package.json as a special case and will always load only specific keys from it
-* So we have to intercept and load them manually in config.ts
+* Lets arbitrary JSON objects (like from package.json) become reasonably good
+* mdat rule sets HOWEVER cosmiconfig treats package.json as a special case and
+* will always load only specific keys from it So we have to intercept and load
+* them manually in config.ts
 */
 function mdatJsonLoader(filePath, content) {
 	const defaultJsonLoader = defaultLoaders[".json"];
@@ -183,6 +186,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		issuesUrl: codemeta.issueTracker,
 		license: helpers.toBasicLicense(helpers.firstOf(helpers.ensureArray(codemeta.license))),
 		licenseFilePath: licenseFileData?.source,
+		licenseUrl: licenseFileData?.data.spdxUrl,
 		name: codemeta.name,
 		operatingSystem: codemeta.operatingSystem,
 		peerDependencies,
@@ -215,12 +219,12 @@ var badges_default = { badges: { async content(options) {
 		npm: z.array(z.string()).optional()
 	}).optional().parse(options);
 	const metadata = await getReadmeMetadata();
-	const { ciActionFileName, license, name, repositoryUrl } = metadata;
+	const { ciActionFileName, license, licenseUrl, name, repositoryUrl } = metadata;
 	const badges = [];
 	if (validOptions?.npm === void 0) {
 		if (metadata.isPublicNpmPackage) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://npmjs.com/package/${name})`);
 	} else for (const name of validOptions.npm) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://npmjs.com/package/${name})`);
-	if (license !== void 0) badges.push(`[![License: ${license}](https://img.shields.io/badge/License-${license.replaceAll("-", "--")}-yellow.svg)](https://opensource.org/licenses/${license})`);
+	if (license !== void 0 && licenseUrl !== void 0) badges.push(`[![License: ${license}](https://img.shields.io/badge/License-${license.replaceAll("-", "--")}-yellow.svg)](${licenseUrl})`);
 	if (ciActionFileName !== void 0 && repositoryUrl !== void 0) badges.push(`[![CI](${repositoryUrl}/actions/workflows/${ciActionFileName}/badge.svg)](${repositoryUrl}/actions/workflows/${ciActionFileName})`);
 	if (validOptions?.custom !== void 0) for (const [name, { image, link }] of Object.entries(validOptions.custom)) badges.push(`[![${name}](${image})](${link})`);
 	return badges.join("\n");
@@ -484,6 +488,7 @@ const brotliCompressAsync = promisify(brotliCompress);
 const gzipCompressAsync = promisify(gzip);
 /**
 * Creates a SizeInfo object with formatted values
+*
 * @param bytes - Size in bytes
 * @param originalSize - Original file size for percentage calculation
 */
@@ -498,9 +503,11 @@ function createSizeInfo(bytes, originalSize) {
 }
 /**
 * Analyzes a file's size and its compressed sizes using Brotli and Gzip
+*
 * @param filePath - Path to the file to analyze
+*
 * @returns Promise containing detailed size report
-* @throws {Error} if file cannot be read or compressed
+* @throws {Error} If file cannot be read or compressed
 */
 async function createSizeReport(filePath) {
 	try {
@@ -724,8 +731,8 @@ function validateConfig(value) {
 let cachedPrettier;
 const configCache = /* @__PURE__ */ new Map();
 /**
-* Format a markdown string with Prettier, using config discovered from the file path.
-* Requires `prettier` to be installed as a peer dependency.
+* Format a markdown string with Prettier, using config discovered from the file
+* path. Requires `prettier` to be installed as a peer dependency.
 */
 async function formatWithPrettier(content, filePath) {
 	if (cachedPrettier === void 0) try {
@@ -956,6 +963,7 @@ var templates_default = {
 //#region src/lib/readme/create.ts
 /**
 * Creates a new readme file interactively.
+*
 * @returns Path to the created readme file.
 */
 async function createReadmeInteractive() {
@@ -996,6 +1004,7 @@ async function createReadmeInteractive() {
 }
 /**
 * Creates a new readme file with the given options.
+*
 * @returns Path to the created readme file.
 */
 async function createReadme(options) {

package/dist/lib/index.d.ts

@@ -60,11 +60,13 @@ type MdatReadmeCreateOptions = {
 };
 /**
  * Creates a new readme file interactively.
+ *
  * @returns Path to the created readme file.
  */
 declare function createReadmeInteractive(): Promise<string>;
 /**
  * Creates a new readme file with the given options.
+ *
  * @returns Path to the created readme file.
  */
 declare function createReadme(options?: Partial<MdatReadmeCreateOptions>): Promise<string>;
@@ -163,6 +165,7 @@ declare const readmeMetadataTemplate: _$metascope.Template<{
   issuesUrl: string | undefined;
   license: string | undefined;
   licenseFilePath: string | undefined;
+  licenseUrl: string | undefined;
   name: string | undefined;
   operatingSystem: string[] | undefined;
   peerDependencies: {
@@ -194,6 +197,7 @@ declare function getReadmeMetadata(): Promise<{
   issuesUrl: string | undefined;
   license: string | undefined;
   licenseFilePath: string | undefined;
+  licenseUrl: string | undefined;
   name: string | undefined;
   operatingSystem: string[] | undefined;
   peerDependencies: {
@@ -214,9 +218,11 @@ declare function resetMetadataCaches(): void;
 //#endregion
 //#region src/lib/log.d.ts
 /**
- * Set the logger instance for the module.
- * Export this for library consumers to inject their own logger.
- * @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+ * Set the logger instance for the module. Export this for library consumers to
+ * inject their own logger.
+ *
+ * @param logger - Accepts either a LogLayer instance or a Console- or
+ *   Stream-like log target
  */
 declare function setLogger(logger?: ILogBasic | ILogLayer<unknown>): void;
 //#endregion

package/dist/lib/index.js

@@ -45,9 +45,11 @@ let log = createLogger({
 setLogger$1(getChildLogger(log, "remark-mdat"));
 setLogger$2(getChildLogger(log, "metascope"));
 /**
-* Set the logger instance for the module.
-* Export this for library consumers to inject their own logger.
-* @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+* Set the logger instance for the module. Export this for library consumers to
+* inject their own logger.
+*
+* @param logger - Accepts either a LogLayer instance or a Console- or
+*   Stream-like log target
 */
 function setLogger(logger) {
 	log = injectionHelper(logger);
@@ -57,9 +59,10 @@ function setLogger(logger) {
 //#endregion
 //#region src/lib/mdat-json-loader.ts
 /**
-* Lets arbitrary JSON objects (like from package.json) become reasonably good mdat rule sets
-* HOWEVER cosmiconfig treats package.json as a special case and will always load only specific keys from it
-* So we have to intercept and load them manually in config.ts
+* Lets arbitrary JSON objects (like from package.json) become reasonably good
+* mdat rule sets HOWEVER cosmiconfig treats package.json as a special case and
+* will always load only specific keys from it So we have to intercept and load
+* them manually in config.ts
 */
 function mdatJsonLoader(filePath, content) {
 	const defaultJsonLoader = defaultLoaders[".json"];
@@ -179,6 +182,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		issuesUrl: codemeta.issueTracker,
 		license: helpers.toBasicLicense(helpers.firstOf(helpers.ensureArray(codemeta.license))),
 		licenseFilePath: licenseFileData?.source,
+		licenseUrl: licenseFileData?.data.spdxUrl,
 		name: codemeta.name,
 		operatingSystem: codemeta.operatingSystem,
 		peerDependencies,
@@ -227,12 +231,12 @@ var badges_default = { badges: { async content(options) {
 		npm: z.array(z.string()).optional()
 	}).optional().parse(options);
 	const metadata = await getReadmeMetadata();
-	const { ciActionFileName, license, name, repositoryUrl } = metadata;
+	const { ciActionFileName, license, licenseUrl, name, repositoryUrl } = metadata;
 	const badges = [];
 	if (validOptions?.npm === void 0) {
 		if (metadata.isPublicNpmPackage) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://npmjs.com/package/${name})`);
 	} else for (const name of validOptions.npm) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://npmjs.com/package/${name})`);
-	if (license !== void 0) badges.push(`[![License: ${license}](https://img.shields.io/badge/License-${license.replaceAll("-", "--")}-yellow.svg)](https://opensource.org/licenses/${license})`);
+	if (license !== void 0 && licenseUrl !== void 0) badges.push(`[![License: ${license}](https://img.shields.io/badge/License-${license.replaceAll("-", "--")}-yellow.svg)](${licenseUrl})`);
 	if (ciActionFileName !== void 0 && repositoryUrl !== void 0) badges.push(`[![CI](${repositoryUrl}/actions/workflows/${ciActionFileName}/badge.svg)](${repositoryUrl}/actions/workflows/${ciActionFileName})`);
 	if (validOptions?.custom !== void 0) for (const [name, { image, link }] of Object.entries(validOptions.custom)) badges.push(`[![${name}](${image})](${link})`);
 	return badges.join("\n");
@@ -484,6 +488,7 @@ const brotliCompressAsync = promisify(brotliCompress);
 const gzipCompressAsync = promisify(gzip);
 /**
 * Creates a SizeInfo object with formatted values
+*
 * @param bytes - Size in bytes
 * @param originalSize - Original file size for percentage calculation
 */
@@ -498,9 +503,11 @@ function createSizeInfo(bytes, originalSize) {
 }
 /**
 * Analyzes a file's size and its compressed sizes using Brotli and Gzip
+*
 * @param filePath - Path to the file to analyze
+*
 * @returns Promise containing detailed size report
-* @throws {Error} if file cannot be read or compressed
+* @throws {Error} If file cannot be read or compressed
 */
 async function createSizeReport(filePath) {
 	try {
@@ -729,8 +736,8 @@ function defineConfig(config) {
 let cachedPrettier;
 const configCache = /* @__PURE__ */ new Map();
 /**
-* Format a markdown string with Prettier, using config discovered from the file path.
-* Requires `prettier` to be installed as a peer dependency.
+* Format a markdown string with Prettier, using config discovered from the file
+* path. Requires `prettier` to be installed as a peer dependency.
 */
 async function formatWithPrettier(content, filePath) {
 	if (cachedPrettier === void 0) try {
@@ -937,6 +944,7 @@ var templates_default = {
 //#region src/lib/readme/create.ts
 /**
 * Creates a new readme file interactively.
+*
 * @returns Path to the created readme file.
 */
 async function createReadmeInteractive() {
@@ -977,6 +985,7 @@ async function createReadmeInteractive() {
 }
 /**
 * Creates a new readme file with the given options.
+*
 * @returns Path to the created readme file.
 */
 async function createReadme(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "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.",
   "keywords": [
     "mdat",
@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.2",
-    "@kitschpatrol/shared-config": "^7.4.1",
+    "@kitschpatrol/shared-config": "^7.5.2",
     "@types/mdast": "^4.0.4",
     "@types/node": "~22.17.2",
     "@types/unist": "^3.0.3",
@@ -77,14 +77,14 @@
     "@vitest/coverage-v8": "4.1.2",
     "bumpp": "^11.0.1",
     "execa": "^9.6.1",
-    "mdat-plugin-cli-help": "^2.1.2",
+    "mdat-plugin-cli-help": "^3.0.0",
     "mdat-plugin-example": "^2.0.0",
-    "mdat-plugin-tldraw": "^2.0.1",
+    "mdat-plugin-tldraw": "^2.0.2",
     "nanoid": "^5.1.9",
     "prettier": "^3.8.3",
     "publint": "^0.3.18",
     "shx": "^0.4.0",
-    "tsdown": "^0.21.9",
+    "tsdown": "^0.21.10",
     "typescript": "~6.0.3",
     "unplugin-raw": "^0.7.0",
     "vitest": "^4.1.5"

package/readme.md

@@ -824,10 +824,14 @@ This project was split from a monorepo containing both `mdat` and `remark-mdat`
 
 ## Contributing
 
-[Issues](https://github.com/kitschpatrol/mdat/issues) and pull requests are welcome.
+[Issues](https://github.com/kitschpatrol/mdat/issues) are welcome and appreciated.
+
+Please open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.
+
+This repository uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) (via its `ksc` CLI) for linting and formatting, plus [MDAT](https://github.com/kitschpatrol/mdat) for readme placeholder expansion.
 
 ## License
 
-[MIT](license.txt) © Eric Mika
+[MIT](license.txt) © [Eric Mika](https://ericmika.com)
 
 <!-- /footer -->