prettier-plugin-mdc 0.0.1 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,53 @@
 # prettier-plugin-mdc
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+[![NPM version](https://img.shields.io/npm/v/prettier-plugin-mdc?color=a1b858&label=)](https://www.npmjs.com/package/prettier-plugin-mdc)
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+A [Prettier](https://prettier.io/) plugin for formatting [MDC (Markdown Components)](https://content.nuxt.com/docs/files/markdown#mdc-syntax) syntax used in [Nuxt Content](https://content.nuxt.com/).
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+## 💎 Features
 
-## Purpose
+- Preserve YAML front matter in components
+- Support for nested components
+- Compatible with GFM (GitHub Flavored Markdown) and math syntax
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `prettier-plugin-mdc`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+## 📦 Installation
 
-## What is OIDC Trusted Publishing?
+```bash
+npm install -D prettier-plugin-mdc
+# or
+yarn add -D prettier-plugin-mdc
+# or
+pnpm add -D prettier-plugin-mdc
+```
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+## 🚀 Usage
 
-## Setup Instructions
+Add the plugin to your Prettier configuration:
 
-To properly configure OIDC trusted publishing for this package:
+```json
+// .prettierrc
+{
+  "plugins": ["prettier-plugin-mdc"]
+}
+```
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+Or in `prettier.config.js`:
 
-## DO NOT USE THIS PACKAGE
+```js
+export default {
+  plugins: ["prettier-plugin-mdc"],
+};
+```
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+Then format your `.mdc` or `.md` files:
 
-## More Information
+```bash
+prettier --write "**/*.mdc"
+prettier --write "**/*.md"
+```
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+For MDC Syntax Reference, please check [remark-mdc](https://github.com/nuxt-content/remark-mdc).
 
----
+## License
 
-**Maintained for OIDC setup purposes only**
+[MIT](./LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

package/dist/index.d.mts

@@ -0,0 +1,13 @@
+import { Parser, Printer } from "prettier";
+import { Node } from "unist";
+
+//#region src/constants.d.ts
+declare const AST_FORMAT = "mdc";
+//#endregion
+//#region src/parsers.d.ts
+declare const parsers: Record<typeof AST_FORMAT, Parser<Node>>;
+//#endregion
+//#region src/printers.d.ts
+declare const printers: Record<typeof AST_FORMAT, Printer<Node>>;
+//#endregion
+export { parsers, printers };

package/dist/index.mjs

@@ -0,0 +1,286 @@
+import { createRequire } from "node:module";
+import markdown from "prettier/parser-markdown";
+import remarkGfm from "remark-gfm";
+import remarkMath from "remark-math";
+import remarkMdc from "remark-mdc";
+import remarkParse from "remark-parse";
+import { unified } from "unified";
+import * as markdown$1 from "prettier/plugins/markdown";
+import { doc } from "prettier";
+import { createSyncFn } from "synckit";
+
+//#region src/constants.ts
+const AST_FORMAT = "mdc";
+
+//#endregion
+//#region src/parsers.ts
+const parsers = { [AST_FORMAT]: {
+	...markdown.parsers.markdown,
+	astFormat: AST_FORMAT,
+	parse: async (text) => {
+		const processor = unified().use(remarkParse, { commonmark: true }).use(remarkMath).use(remarkGfm).use(remarkMdc);
+		return await processor.run(processor.parse(text));
+	}
+} };
+
+//#endregion
+//#region src/is.ts
+const isTextComponentNode = (node) => node.type === "textComponent";
+const isContainerComponentNode = (node) => node.type === "containerComponent";
+const isComponentContainerSectionNode = (node) => node.type === "componentContainerSection";
+const isLinkNode = (node) => node.type === "link";
+const isWordOrTextNode = (node) => node.type === "word" || node.type === "text";
+/**
+* Check if a node has any textComponent descendants
+*/
+function hasTextComponentDescendant(node) {
+	if (isTextComponentNode(node)) return true;
+	if ("children" in node && Array.isArray(node.children)) return node.children.some(hasTextComponentDescendant);
+	return false;
+}
+function hasTextWithBrackets(node) {
+	if (isWordOrTextNode(node) && /[[\]]/.test(node.value)) return true;
+	if ("children" in node && Array.isArray(node.children)) return node.children.some(hasTextWithBrackets);
+	return false;
+}
+/**
+* Check if a link needs custom printing (has textComponent or brackets in text)
+*/
+function linkNeedsCustomPrinting(node) {
+	if (!node.children) return false;
+	for (const child of node.children) if (isTextComponentNode(child) || hasTextWithBrackets(child) || "children" in child && hasTextComponentDescendant(child)) return true;
+	return false;
+}
+
+//#endregion
+//#region src/visitor-keys.ts
+const visitorKeys = {
+	componentContainerSection: ["children"],
+	containerComponent: ["children"],
+	textComponent: ["children"]
+};
+const mdcNodeTypes = Object.keys(visitorKeys);
+
+//#endregion
+//#region src/utils.ts
+const extendedInlineNodes = [
+	"image",
+	"link",
+	"linkReference",
+	"strong",
+	"inlineCode",
+	"emphasis"
+];
+const extendedInlineNodesHaveAttributes = (node) => extendedInlineNodes.includes(node.type) && "attributes" in node;
+const escapeQuotes = (value, quote) => value.replace(new RegExp(quote, "g"), `\\${quote}`);
+
+//#endregion
+//#region src/yaml.ts
+const require = createRequire(import.meta.url);
+const formatYaml = (text, options) => {
+	return createSyncFn(require.resolve("./yaml-worker.mjs"))(text, {
+		tabWidth: options.tabWidth,
+		useTabs: options.useTabs,
+		singleQuote: options.singleQuote,
+		printWidth: options.printWidth,
+		proseWrap: options.proseWrap
+	});
+};
+
+//#endregion
+//#region src/print.ts
+const { hardline, join } = doc.builders;
+const mapChildren = (path, print) => path.map(print, "children");
+function serializeValue(value, options) {
+	const quote = options.singleQuote ? "'" : "\"";
+	if (typeof value === "string") return `${quote}${escapeQuotes(value.replace(/\\/g, "\\\\"), quote)}${quote}`;
+	if (typeof value === "number" || typeof value === "boolean") return String(value);
+	return `${quote}${escapeQuotes(JSON.stringify(value), quote)}${quote}`;
+}
+function printAttributes(node, options) {
+	const attrs = node.attributes;
+	if (!attrs || Object.keys(attrs).length === 0) return "";
+	const parts = [];
+	for (const [key, value] of Object.entries(attrs)) if (key === "id") parts.push(`#${value}`);
+	else if (key === "class") {
+		const classes = String(value).split(/\s+/).filter(Boolean);
+		for (const cls of classes) parts.push(`.${cls}`);
+	} else if (value === true) parts.push(key);
+	else parts.push(`${key}=${serializeValue(value, options)}`);
+	return parts.length > 0 ? `{${parts.join(" ")}}` : "";
+}
+/**
+* Print binding component: {{ value }} or {{ value || 'default' }}
+*/
+function printBinding(node, options) {
+	const value = node.attributes?.value ?? "";
+	const defaultValue = node.attributes?.defaultValue;
+	const quote = options.singleQuote ? "'" : "\"";
+	if (defaultValue !== void 0 && defaultValue !== "undefined") return [`{{ ${value} || ${quote}${escapeQuotes(String(defaultValue), quote)}${quote} }}`];
+	return [`{{ ${value} }}`];
+}
+/**
+* Check if span component uses shorthand form [content] vs explicit
+* :span[content]
+*/
+function isShorthandSpan(node) {
+	if (node.name !== "span") return false;
+	const pos = node.position;
+	if (!pos) return false;
+	const nodeLength = pos.end.offset - pos.start.offset;
+	if (node.children && node.children.length > 0) {
+		const firstChild = node.children[0];
+		if (firstChild.position) return firstChild.position.start.offset === pos.start.offset + 1;
+	}
+	return nodeLength <= 3;
+}
+/**
+* Print inline text component: :name[content]{attrs} Special cases:
+*
+* - Binding: {{ value }}
+* - Span shorthand without attrs: [content]
+*/
+function printTextComponent(path, print, options) {
+	const { node } = path;
+	if (node.name === "binding") return printBinding(node, options);
+	const attrStr = printAttributes(node, options);
+	function printChildrenWithEscapedBrackets() {
+		const childParts = [];
+		for (let i = 0; i < node.children.length; i++) {
+			const child = node.children[i];
+			if (child.type === "text" || child.type === "sentence" || child.type === "whitespace") childParts.push(escapeTextBrackets(child));
+			else childParts.push(path.call(print, "children", i));
+		}
+		return childParts;
+	}
+	if (isShorthandSpan(node)) {
+		if (node.children && node.children.length > 0) return [
+			"[",
+			...printChildrenWithEscapedBrackets(),
+			"]",
+			attrStr
+		];
+		return ["[]", attrStr];
+	}
+	const parts = [`:${node.name}`];
+	if (node.children && node.children.length > 0) parts.push("[", ...printChildrenWithEscapedBrackets(), "]");
+	if (attrStr) parts.push(attrStr);
+	return parts;
+}
+/**
+* Calculate the nesting depth of a container component
+*/
+function getContainerDepth(path) {
+	let depth = 0;
+	for (const item of path.stack) if (typeof item === "object" && item !== null && "type" in item && item.type === "containerComponent") depth++;
+	return Math.max(0, depth - 1);
+}
+/**
+* Print YAML front matter from rawData rawData format: "\nkey: value\n---"
+*/
+function printRawData(rawData, options) {
+	if (!rawData) return [];
+	let content = rawData.slice(1, -3).trimEnd();
+	if (!content) return [];
+	content = formatYaml(content, options);
+	return [
+		"---",
+		hardline,
+		join(hardline, content.split("\n")),
+		hardline,
+		"---",
+		hardline
+	];
+}
+/**
+* Print container component: ::name{attrs}\n---\nfmAttrs\n---\nchildren\n::
+*/
+function printContainerComponent(path, print, options) {
+	const { node } = path;
+	const depth = getContainerDepth(path);
+	const colons = ":".repeat(depth + 2);
+	const parts = [colons, node.name];
+	const attrStr = printAttributes(node, options);
+	if (attrStr) parts.push(attrStr);
+	parts.push(hardline);
+	parts.push(...printRawData(node.rawData, options));
+	if (node.children && node.children.length > 0) {
+		const childDocs = mapChildren(path, print);
+		parts.push(join(hardline, childDocs));
+		parts.push(hardline);
+	}
+	parts.push(colons);
+	return parts;
+}
+/**
+* Print component container section (slot): #name\ncontent
+*/
+function printComponentContainerSection(path, print) {
+	const { node } = path;
+	const parts = [];
+	if (node.name && node.name !== "default") parts.push(`#${node.name}`, hardline);
+	if (node.children && node.children.length > 0) {
+		const childDocs = mapChildren(path, print);
+		parts.push(join(hardline, childDocs));
+	}
+	return parts;
+}
+/**
+* Recursively escape brackets in text content
+*/
+function escapeTextBrackets(node) {
+	if (node.type === "text" || node.type === "word") return node.value.replace(/\[/g, "\\[").replace(/\]/g, "\\]");
+	if (node.type === "whitespace") return node.value;
+	if ("children" in node && Array.isArray(node.children)) return node.children.map(escapeTextBrackets).join("");
+	return "";
+}
+/**
+* Print link with MDC children: [content](url) This is needed because
+* prettier's markdown printer adds breaks between children
+*/
+function printLink(path, print, options) {
+	const { node } = path;
+	const childParts = [];
+	for (let i = 0; i < node.children.length; i++) {
+		const child = node.children[i];
+		if (child.type === "text" || child.type === "sentence" || child.type === "whitespace") childParts.push(escapeTextBrackets(child));
+		else childParts.push(path.call(print, "children", i));
+	}
+	const parts = [
+		"[",
+		...childParts,
+		"]"
+	];
+	parts.push("(", node.url);
+	if (node.title) {
+		const quote = options.singleQuote ? "'" : "\"";
+		parts.push(" ", quote, node.title, quote);
+	}
+	parts.push(")");
+	const attrStr = printAttributes(node, options);
+	if (attrStr) parts.push(attrStr);
+	return parts;
+}
+
+//#endregion
+//#region src/printers.ts
+const mdastPrinter = markdown$1.printers.mdast;
+const printers = { [AST_FORMAT]: {
+	...mdastPrinter,
+	getVisitorKeys(node, nonTraversableKeys) {
+		if (mdcNodeTypes.includes(node.type)) return visitorKeys[node.type];
+		return mdastPrinter.getVisitorKeys(node, nonTraversableKeys);
+	},
+	print(path, options, print, args) {
+		const { node } = path;
+		if (isLinkNode(node) && linkNeedsCustomPrinting(node)) return printLink(path, print, options);
+		if (extendedInlineNodesHaveAttributes(node)) return [mdastPrinter.print(path, options, print, args), printAttributes(node, options)];
+		if (isTextComponentNode(node)) return printTextComponent(path, print, options);
+		else if (isContainerComponentNode(node)) return printContainerComponent(path, print, options);
+		else if (isComponentContainerSectionNode(node)) return printComponentContainerSection(path, print);
+		return mdastPrinter.print(path, options, print, args);
+	}
+} };
+
+//#endregion
+export { parsers, printers };

package/dist/yaml-worker.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/yaml-worker.mjs

@@ -0,0 +1,13 @@
+import * as prettier from "prettier";
+import { runAsWorker } from "synckit";
+
+//#region src/yaml-worker.ts
+runAsWorker(async (text, options) => {
+	return (await prettier.format(text, {
+		...options,
+		parser: "yaml"
+	})).trimEnd();
+});
+
+//#endregion
+export {  };

package/package.json

@@ -1,10 +1,78 @@
 {
   "name": "prettier-plugin-mdc",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for prettier-plugin-mdc",
+  "version": "0.1.1",
+  "author": "Ray <i@mk1.io> (@so1ve)",
+  "type": "module",
+  "description": "Prettier plugin for MDC syntax",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "prettier",
+    "prettier-plugin",
+    "mdc",
+    "markdown",
+    "remark",
+    "unified"
+  ],
+  "homepage": "https://github.com/so1ve/prettier-plugin-mdc#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/so1ve/prettier-plugin-mdc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/so1ve/prettier-plugin-mdc/issues"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./yaml-worker": "./dist/yaml-worker.mjs",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "@types/unist": "^3.0.3",
+    "remark-gfm": "^4.0.1",
+    "remark-math": "^6.0.0",
+    "remark-mdc": "^3.10.0",
+    "remark-parse": "^11.0.0",
+    "synckit": "^0.11.11",
+    "unified": "^11.0.5"
+  },
+  "devDependencies": {
+    "@antfu/ni": "^28.0.0",
+    "@so1ve/eslint-config": "^4.1.5",
+    "@so1ve/prettier-config": "^4.1.5",
+    "@types/node": "^25.0.3",
+    "@typescript/native-preview": "7.0.0-dev.20251029.1",
+    "bumpp": "^10.3.2",
+    "dedent": "^1.7.1",
+    "eslint": "^9.39.2",
+    "prettier": "^3.7.4",
+    "tsdown": "^0.18.3",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.0",
+    "vitest": "^4.0.16"
+  },
+  "peerDependencies": {
+    "prettier": "~3.6.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint . && prettier . --check",
+    "lint:fix": "eslint . --fix && prettier . --write",
+    "release": "bumpp --commit --push --tag",
+    "test": "vitest",
+    "typecheck": "nr typecheck:isolated && nr typecheck:non-isolated",
+    "typecheck:isolated": "tsc --noEmit --project tsconfig.isolated.json",
+    "typecheck:non-isolated": "tsgo --noEmit --project tsconfig.non-isolated.json",
+    "watch": "tsdown --watch"
+  }
+}