@tofrankie/prettier-plugin-wxml 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## prettier-plugin-wxml@0.0.1 (2026-03-23)
+
+- 使用 `angular-html-parser` 解析 WXML
+- 格式化插值

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Frankie
+
+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

@@ -0,0 +1,97 @@
+# @tofrankie/prettier-plugin-wxml
+
+[![npm version](https://img.shields.io/npm/v/@tofrankie/prettier-plugin-wxml)](https://www.npmjs.com/package/@tofrankie/prettier-plugin-wxml) [![node version](https://img.shields.io/node/v/@tofrankie/prettier-plugin-wxml)](https://nodejs.org) [![npm package license](https://img.shields.io/npm/l/@tofrankie/prettier-plugin-wxml)](https://github.com/tofrankie/prettier-plugin-wxml/blob/main/LICENSE) [![npm last update](https://img.shields.io/npm/last-update/@tofrankie/prettier-plugin-wxml)](https://www.npmjs.com/package/@tofrankie/prettier-plugin-wxml)
+
+> [!WARNING]
+> **尚未稳定**，在 **1.0.0** 之前仍可能发布**不兼容的破坏性变更**，升级前请查看 [CHANGELOG](CHANGELOG.md)。
+
+面向微信小程序 **WXML** 的 **Prettier 3.x** 插件：仅做一件事，在**不改动标签结构、缩进与换行策略**的前提下，对文本节点与属性值中的 **`{{ ... }}` 插值语法**格式化处理：
+
+- 花括号内部表达式保留一个空格：`{{username}}` → `{{ username }}`
+- 若 WXML 插值语法使用语句（如 `if` / `return`）而不是表达式，则会保持原样（**不处理**）。
+- 若 WXML 插值语法内使用不合法的表达式（如 `{{foo+}}`），则会保持原样（**不处理**）。
+
+## 安装
+
+```bash
+pnpm add -D prettier @tofrankie/prettier-plugin-wxml
+```
+
+## 配置
+
+在 Prettier 配置中注册插件，并指定 `parser` 为 `wxml`（或依赖文件扩展名 `.wxml` 自动选用该 parser）：
+
+```json
+{
+  "plugins": ["@tofrankie/prettier-plugin-wxml"],
+  "overrides": [
+    {
+      "files": "*.wxml",
+      "options": {
+        "parser": "wxml"
+      }
+    }
+  ]
+}
+```
+
+通用选项（如 `singleQuote`、`printWidth`、`tabWidth` 等）会**一并传入**内层对表达式的 `format()`，但内层固定 `semi: false` 且**不会**加载本插件，以避免循环解析。
+
+## 插件选项
+
+| 选项               | 类型                 | 默认       | 说明                                                                                                    |
+| ------------------ | -------------------- | ---------- | ------------------------------------------------------------------------------------------------------- |
+| `wxmlThrowOnError` | `boolean`            | `false`    | 为 `true` 时，WXML 解析失败或某一插值无法安全格式化时**抛出**原始错误，便于排查。                       |
+| `wxmlReportLevel`  | `'silent' \| 'warn'` | `'silent'` | 为 `warn` 时，在容错回退（整文件跳过或部分插值未改）时向 `console.warn` 输出一行提示（含 `filepath`）。 |
+
+## 行为与限制
+
+### 整文件 HTML 解析（`angular-html-parser` 的 `parseHtml`）
+
+插件依赖 `angular-html-parser` 将源码当作类 HTML 解析。若与微信 WXML 存在细微差异，或源码无法被解析器接受，可能产生**解析错误**。默认**整文件原样返回**（不做任何插值改写）；若 `wxmlThrowOnError: true` 则抛出。
+
+### 扫描范围
+
+仅在 AST 给出的**文本节点**与**属性值**对应区间内提取 `{{ }}`。**注释节点整段跳过**（注释里的 `{{ }}` 不处理）。
+
+### 插值边界扫描（字符串与模板字符串）
+
+在每一段可扫描的文本或属性值内部，用状态机配对 `{{` 与 `}}`：在 **单引号 / 双引号** 字符串字面量内出现的 `}}` **不会**被当作闭合。  
+**模板字符串**（反引号 `` ` ``）与嵌套 `{}` **未**按 JS 模板字符串语法处理；若插值内使用反引号表达式，可能出现 `}}` 配对错误，属于已知限制，该插值可能无法正确格式化或区间异常。
+
+### 插值语言
+
+仅将内容视为 **JavaScript 表达式** 格式化；**不包含** TypeScript（无 `typescript` / `babel-ts` 承诺）。
+
+### 典型表达式
+
+业务中常见：标识符、数字、字符串、数组字面量（如 `wx:for="{{[1, 2, 3]}}"`）、对象字面量等。更复杂的写法在能解析时同样会格式化；**若解析或格式化失败，则该插值原样保留**（默认）。
+
+### `template` / `data` 的「类对象」简写
+
+小程序 `data="{{foo, bar}}"` 等运行时语义与 **ECMAScript 中同一字符串作为独立表达式** 的解析结果**可能不一致**。本插件仍对**抽出的字符串**按 JS 去 `format`；若无法解析或存在语义偏差，依赖容错——**该插值原样保留**（首版不承诺还原为与微信「完全等价」的对象字面量）。
+
+### 属性值与源码偏移
+
+实现依赖解析器给出的节点在源码中的起止位置；若某版本解析器对属性值区间与微信不一致，可能影响插值定位（属实现细节）。
+
+### `}}` 与 `}}` 后、引号前的空格
+
+若属性写成 `wx:for="{{[1,2,3]}} "`（`}}` 与闭合引号 `"` 之间有空格），该空格**属于属性值字符串的一部分**，可能影响运行时语义。  
+**插件行为**：只替换一对 `{{`…`}}` 所覆盖的区间内的表达式；**不会**删除或移动 `}}` 与引号之间的空格。
+
+### 绝对偏移与逆序替换
+
+整份 `.wxml` 是一个字符串，从 0 编号。每个插值记录 `{{` 与 `}}` 之后**在**整串中的**绝对偏移**；**printer** 按各插值的 `start` **从大到小**逆序替换，避免先改前面导致后面下标偏移。
+
+## 容错与错误
+
+- 默认 **`wxmlThrowOnError: false`**：`parseHtml` 失败则整文件不变；某一插值表达式失败则**仅该插值**不变，其余继续。
+- **`wxmlThrowOnError: true`**：上述错误直接抛出。
+- **`wxmlReportLevel: 'warn'`**：在容错回退时向 `console.warn` 输出一行提示，例如：
+  - `[prettier-plugin-wxml] 已跳过 <filepath>：WXML 解析失败：<message>`
+  - `[prettier-plugin-wxml] 部分失败 <filepath>：共 <N> 处插值未能格式化`
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,362 @@
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[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 angular_html_parser = require("angular-html-parser");
+let _babel_parser = require("@babel/parser");
+let prettier = require("prettier");
+prettier = __toESM(prettier);
+//#region src/interpolation.ts
+const MUSTACHE_SCAN_STATE = {
+	SCAN: "scan",
+	SINGLE_QUOTE: "singleQuote",
+	DOUBLE_QUOTE: "doubleQuote"
+};
+/**
+* 在一段节点内容内提取 `{{`…`}}` 区间（相对 content 的偏移）。
+* 使用状态机，避免字符串字面量内的 `}}` 被误当作闭合。
+* @param content
+*/
+function extractMustacheRegions(content) {
+	const regions = [];
+	let i = 0;
+	while (i < content.length - 1) if (content[i] === "{" && content[i + 1] === "{") {
+		const end = findMustacheEnd(content, i);
+		if (end === null) {
+			i += 1;
+			continue;
+		}
+		regions.push({
+			start: i,
+			end
+		});
+		i = end;
+	} else i += 1;
+	return regions;
+}
+/**
+* 从 `openIdx` 处的 `{{` 起，找配对的 `}}` 结束下标（不含则返回 null）。
+* @param content 节点内整段文本
+* @param openIdx 指向 `{{` 的第一个 `{`
+*/
+function findMustacheEnd(content, openIdx) {
+	if (content[openIdx] !== "{" || content[openIdx + 1] !== "{") return null;
+	let pos = openIdx + 2;
+	let state = MUSTACHE_SCAN_STATE.SCAN;
+	while (pos < content.length) {
+		const c = content[pos];
+		if (state === MUSTACHE_SCAN_STATE.SCAN) {
+			if (c === "'") {
+				state = MUSTACHE_SCAN_STATE.SINGLE_QUOTE;
+				pos += 1;
+				continue;
+			}
+			if (c === "\"") {
+				state = MUSTACHE_SCAN_STATE.DOUBLE_QUOTE;
+				pos += 1;
+				continue;
+			}
+			if (c === "}" && content[pos + 1] === "}") return pos + 2;
+			pos += 1;
+			continue;
+		}
+		if (state === MUSTACHE_SCAN_STATE.SINGLE_QUOTE) {
+			if (c === "\\") {
+				pos += 2;
+				continue;
+			}
+			if (c === "'") {
+				state = MUSTACHE_SCAN_STATE.SCAN;
+				pos += 1;
+				continue;
+			}
+			pos += 1;
+			continue;
+		}
+		if (state === MUSTACHE_SCAN_STATE.DOUBLE_QUOTE) {
+			if (c === "\\") {
+				pos += 2;
+				continue;
+			}
+			if (c === "\"") {
+				state = MUSTACHE_SCAN_STATE.SCAN;
+				pos += 1;
+				continue;
+			}
+			pos += 1;
+			continue;
+		}
+	}
+	return null;
+}
+//#endregion
+//#region src/collect-mustache-regions.ts
+const HTML_FATAL_ERROR_LEVEL = 1;
+function hasFatalHtmlParseErrors(result) {
+	return result.errors.some((e) => e.level === HTML_FATAL_ERROR_LEVEL);
+}
+function collectMustacheRegions(source) {
+	const result = (0, angular_html_parser.parseHtml)(source);
+	if (hasFatalHtmlParseErrors(result)) throw new Error(result.errors.map((e) => e.msg).join("; "));
+	const mustacheRegions = [];
+	(0, angular_html_parser.visitAll)(new MustacheRegionCollector(source, mustacheRegions), result.rootNodes);
+	return mustacheRegions;
+}
+var MustacheRegionCollector = class extends angular_html_parser.RecursiveVisitor {
+	constructor(source, mustacheRegions) {
+		super();
+		this.source = source;
+		this.mustacheRegions = mustacheRegions;
+	}
+	visitText(ast, context) {
+		this.pushSpan(ast.sourceSpan);
+		super.visitText(ast, context);
+	}
+	visitCdata(ast, context) {
+		this.pushSpan(ast.sourceSpan);
+		super.visitCdata(ast, context);
+	}
+	visitAttribute(ast, context) {
+		if (ast.valueSpan && ast.value.includes("{{")) this.pushSpan(ast.valueSpan);
+		super.visitAttribute(ast, context);
+	}
+	pushSpan(span) {
+		const start = span.start.offset;
+		const end = span.end.offset;
+		const slice = this.source.slice(start, end);
+		if (!slice.includes("{{")) return;
+		for (const r of extractMustacheRegions(slice)) this.mustacheRegions.push({
+			start: start + r.start,
+			end: start + r.end
+		});
+	}
+};
+//#endregion
+//#region src/format-expression.ts
+const RE_SEMICOLON_END = /;\s*$/;
+const EXPORT_DEFAULT_PREFIX = "export default ";
+/**
+* 与 {@link tryFormatWrappedObjectLiteral} 中剥除 `export default` 与尾部分号的方式一致。
+* @param output
+*/
+function stripFormattedExportDefaultLine(output) {
+	const trimmedOut = output.trimEnd();
+	if (!trimmedOut.startsWith(EXPORT_DEFAULT_PREFIX)) throw new Error("Unexpected Prettier output for expression");
+	let body = trimmedOut.slice(15).trimEnd();
+	body = body.replace(RE_SEMICOLON_END, "").trimEnd();
+	return body;
+}
+function buildInnerFormatOptions(options) {
+	return {
+		parser: "babel",
+		semi: false,
+		singleQuote: options.singleQuote,
+		printWidth: options.printWidth,
+		tabWidth: options.tabWidth,
+		useTabs: options.useTabs,
+		bracketSpacing: options.bracketSpacing,
+		arrowParens: options.arrowParens,
+		endOfLine: options.endOfLine,
+		plugins: []
+	};
+}
+/**
+* 鉴于 WXML 对对象的支持情况，https://developers.weixin.qq.com/miniprogram/dev/reference/wxml/data.html#对象
+* 若裸字符串不是合法表达式，则用 `{}` 包一层再试：可解析为对象字面量时，
+* 按对象走 Prettier，再把外层 `{}` 剥掉写回插值（WXML 常见 `a:1,b:2` 即如此）。
+* @param trimmed
+* @param options
+* @param throwOnError
+*/
+async function tryFormatWrappedObjectLiteral(trimmed, options, throwOnError) {
+	const wrapped = `{${trimmed}}`;
+	try {
+		(0, _babel_parser.parseExpression)(wrapped, { sourceType: "module" });
+	} catch {
+		return null;
+	}
+	try {
+		const src = `export default ${wrapped};`;
+		const body = stripFormattedExportDefaultLine(await prettier.format(src, buildInnerFormatOptions(options)));
+		if (!body.startsWith("{") || !body.endsWith("}")) throw new Error("Unexpected Prettier output for object literal");
+		return body.slice(1, -1).trim();
+	} catch (err) {
+		if (throwOnError) throw err;
+		return null;
+	}
+}
+/**
+* 将插值内层按 JS 表达式校验并交给 Prettier babel 格式化。
+* 非表达式（语句）或语法错误时返回 null（除非 throwOnError）。
+* @param inner
+* @param options
+* @param throwOnError
+*/
+async function formatInterpolationInner(inner, options, throwOnError) {
+	const trimmed = inner.trim();
+	if (!trimmed) {
+		if (throwOnError) throw new Error("Empty WXML interpolation expression");
+		return null;
+	}
+	try {
+		(0, _babel_parser.parseExpression)(trimmed, { sourceType: "module" });
+	} catch (err) {
+		const fromObj = await tryFormatWrappedObjectLiteral(trimmed, options, throwOnError);
+		if (fromObj !== null) return fromObj;
+		if (throwOnError) throw err;
+		return null;
+	}
+	try {
+		const wrapped = `export default ${trimmed};`;
+		return stripFormattedExportDefaultLine(await prettier.format(wrapped, buildInnerFormatOptions(options)));
+	} catch (err) {
+		if (throwOnError) throw err;
+		return null;
+	}
+}
+//#endregion
+//#region src/plugin.ts
+const AST_FORMAT = "wxml-ast";
+const WXML_REPORT_LEVEL = {
+	SILENT: "silent",
+	WARN: "warn"
+};
+function getThrowOnError(options) {
+	return Boolean(options.wxmlThrowOnError);
+}
+function getReportLevel(options) {
+	return options.wxmlReportLevel === WXML_REPORT_LEVEL.WARN ? WXML_REPORT_LEVEL.WARN : WXML_REPORT_LEVEL.SILENT;
+}
+function warnPartial(filepath, count) {
+	const fp = filepath ?? "<stdin>";
+	console.warn(`[prettier-plugin-wxml] partial ${fp}: expression-format-failed x${count}`);
+}
+function warnSkipped(filepath, reason) {
+	const fp = filepath ?? "<stdin>";
+	console.warn(`[prettier-plugin-wxml] skipped ${fp}: wxml-parse-failed: ${reason}`);
+}
+async function buildAst(text, options) {
+	const pluginOptions = options;
+	const throwOnError = getThrowOnError(pluginOptions);
+	const reportLevel = getReportLevel(pluginOptions);
+	const filepath = pluginOptions.filepath;
+	let mustacheRegions;
+	try {
+		mustacheRegions = collectMustacheRegions(text);
+	} catch (err) {
+		const msg = err instanceof Error ? err.message : String(err);
+		if (throwOnError) throw err;
+		if (reportLevel === WXML_REPORT_LEVEL.WARN) warnSkipped(filepath, msg);
+		return {
+			type: "wxml-root",
+			source: text,
+			interpolations: []
+		};
+	}
+	mustacheRegions.sort((a, b) => a.start - b.start);
+	const interpolations = [];
+	let formatFailCount = 0;
+	for (const { start, end } of mustacheRegions) {
+		const raw = text.slice(start, end);
+		const inner = text.slice(start + 2, end - 2);
+		let formatted;
+		try {
+			formatted = await formatInterpolationInner(inner, options, throwOnError);
+		} catch (err) {
+			if (throwOnError) throw err;
+			formatted = null;
+		}
+		if (formatted === null && inner.trim() !== "") formatFailCount += 1;
+		interpolations.push({
+			start,
+			end,
+			raw,
+			formatted
+		});
+	}
+	if (formatFailCount > 0 && reportLevel === WXML_REPORT_LEVEL.WARN && !throwOnError) warnPartial(filepath, formatFailCount);
+	return {
+		type: "wxml-root",
+		source: text,
+		interpolations
+	};
+}
+const wxmlParser = {
+	astFormat: AST_FORMAT,
+	parse: (text, options) => buildAst(text, options),
+	locStart: () => 0,
+	locEnd: (node) => node.source.length
+};
+const wxmlPrinter = { print(path) {
+	const node = path.getValue();
+	if (node.type !== "wxml-root") return "";
+	const { source, interpolations } = node;
+	const sorted = [...interpolations].sort((a, b) => b.start - a.start);
+	let out = source;
+	for (const item of sorted) {
+		if (item.formatted === null) continue;
+		const replacement = `{{ ${item.formatted} }}`;
+		out = out.slice(0, item.start) + replacement + out.slice(item.end);
+	}
+	return out;
+} };
+const languages = [{
+	name: "WXML",
+	parsers: ["wxml"],
+	extensions: [".wxml"],
+	vscodeLanguageIds: ["wxml"]
+}];
+const options = {
+	wxmlThrowOnError: {
+		type: "boolean",
+		default: false,
+		category: "WXML",
+		description: "When true, throw on WXML parse failure or when an interpolation cannot be formatted. Default: false (graceful fallback)."
+	},
+	wxmlReportLevel: {
+		type: "choice",
+		category: "WXML",
+		default: WXML_REPORT_LEVEL.SILENT,
+		description: "When not silent, emit console warnings when the file is skipped or partially formatted.",
+		choices: [{
+			value: WXML_REPORT_LEVEL.SILENT,
+			description: "No extra logging."
+		}, {
+			value: WXML_REPORT_LEVEL.WARN,
+			description: "Log warnings when falling back to raw source."
+		}]
+	}
+};
+const defaultExport = {
+	name: "@tofrankie/prettier-plugin-wxml",
+	languages,
+	parsers: { wxml: wxmlParser },
+	printers: { [AST_FORMAT]: wxmlPrinter },
+	options
+};
+//#endregion
+exports.default = defaultExport;
+exports.defaultExport = defaultExport;
+exports.options = options;

package/dist/index.d.cts

@@ -0,0 +1,70 @@
+import { Parser, Printer, SupportLanguage } from "prettier";
+
+//#region src/types.d.ts
+interface WxmlInterpolation {
+  start: number;
+  end: number;
+  raw: string;
+  formatted: string | null;
+}
+interface WxmlRootAst {
+  type: 'wxml-root';
+  source: string;
+  interpolations: WxmlInterpolation[];
+}
+//#endregion
+//#region src/plugin.d.ts
+declare const options: {
+  wxmlThrowOnError: {
+    type: "boolean";
+    default: boolean;
+    category: string;
+    description: string;
+  };
+  wxmlReportLevel: {
+    type: "choice";
+    category: string;
+    default: "silent";
+    description: string;
+    choices: ({
+      value: "silent";
+      description: string;
+    } | {
+      value: "warn";
+      description: string;
+    })[];
+  };
+};
+declare const defaultExport: {
+  name: string;
+  languages: SupportLanguage[];
+  parsers: {
+    wxml: Parser<WxmlRootAst>;
+  };
+  printers: {
+    "wxml-ast": Printer<WxmlRootAst>;
+  };
+  options: {
+    wxmlThrowOnError: {
+      type: "boolean";
+      default: boolean;
+      category: string;
+      description: string;
+    };
+    wxmlReportLevel: {
+      type: "choice";
+      category: string;
+      default: "silent";
+      description: string;
+      choices: ({
+        value: "silent";
+        description: string;
+      } | {
+        value: "warn";
+        description: string;
+      })[];
+    };
+  };
+};
+//#endregion
+export { type WxmlRootAst, defaultExport as default, defaultExport, options };

package/dist/index.d.mts

@@ -0,0 +1,70 @@
+import { Parser, Printer, SupportLanguage } from "prettier";
+
+//#region src/types.d.ts
+interface WxmlInterpolation {
+  start: number;
+  end: number;
+  raw: string;
+  formatted: string | null;
+}
+interface WxmlRootAst {
+  type: 'wxml-root';
+  source: string;
+  interpolations: WxmlInterpolation[];
+}
+//#endregion
+//#region src/plugin.d.ts
+declare const options: {
+  wxmlThrowOnError: {
+    type: "boolean";
+    default: boolean;
+    category: string;
+    description: string;
+  };
+  wxmlReportLevel: {
+    type: "choice";
+    category: string;
+    default: "silent";
+    description: string;
+    choices: ({
+      value: "silent";
+      description: string;
+    } | {
+      value: "warn";
+      description: string;
+    })[];
+  };
+};
+declare const defaultExport: {
+  name: string;
+  languages: SupportLanguage[];
+  parsers: {
+    wxml: Parser<WxmlRootAst>;
+  };
+  printers: {
+    "wxml-ast": Printer<WxmlRootAst>;
+  };
+  options: {
+    wxmlThrowOnError: {
+      type: "boolean";
+      default: boolean;
+      category: string;
+      description: string;
+    };
+    wxmlReportLevel: {
+      type: "choice";
+      category: string;
+      default: "silent";
+      description: string;
+      choices: ({
+        value: "silent";
+        description: string;
+      } | {
+        value: "warn";
+        description: string;
+      })[];
+    };
+  };
+};
+//#endregion
+export { type WxmlRootAst, defaultExport as default, defaultExport, options };

package/dist/index.mjs

@@ -0,0 +1,333 @@
+import { RecursiveVisitor, parseHtml, visitAll } from "angular-html-parser";
+import { parseExpression } from "@babel/parser";
+import * as prettier from "prettier";
+//#region src/interpolation.ts
+const MUSTACHE_SCAN_STATE = {
+	SCAN: "scan",
+	SINGLE_QUOTE: "singleQuote",
+	DOUBLE_QUOTE: "doubleQuote"
+};
+/**
+* 在一段节点内容内提取 `{{`…`}}` 区间（相对 content 的偏移）。
+* 使用状态机，避免字符串字面量内的 `}}` 被误当作闭合。
+* @param content
+*/
+function extractMustacheRegions(content) {
+	const regions = [];
+	let i = 0;
+	while (i < content.length - 1) if (content[i] === "{" && content[i + 1] === "{") {
+		const end = findMustacheEnd(content, i);
+		if (end === null) {
+			i += 1;
+			continue;
+		}
+		regions.push({
+			start: i,
+			end
+		});
+		i = end;
+	} else i += 1;
+	return regions;
+}
+/**
+* 从 `openIdx` 处的 `{{` 起，找配对的 `}}` 结束下标（不含则返回 null）。
+* @param content 节点内整段文本
+* @param openIdx 指向 `{{` 的第一个 `{`
+*/
+function findMustacheEnd(content, openIdx) {
+	if (content[openIdx] !== "{" || content[openIdx + 1] !== "{") return null;
+	let pos = openIdx + 2;
+	let state = MUSTACHE_SCAN_STATE.SCAN;
+	while (pos < content.length) {
+		const c = content[pos];
+		if (state === MUSTACHE_SCAN_STATE.SCAN) {
+			if (c === "'") {
+				state = MUSTACHE_SCAN_STATE.SINGLE_QUOTE;
+				pos += 1;
+				continue;
+			}
+			if (c === "\"") {
+				state = MUSTACHE_SCAN_STATE.DOUBLE_QUOTE;
+				pos += 1;
+				continue;
+			}
+			if (c === "}" && content[pos + 1] === "}") return pos + 2;
+			pos += 1;
+			continue;
+		}
+		if (state === MUSTACHE_SCAN_STATE.SINGLE_QUOTE) {
+			if (c === "\\") {
+				pos += 2;
+				continue;
+			}
+			if (c === "'") {
+				state = MUSTACHE_SCAN_STATE.SCAN;
+				pos += 1;
+				continue;
+			}
+			pos += 1;
+			continue;
+		}
+		if (state === MUSTACHE_SCAN_STATE.DOUBLE_QUOTE) {
+			if (c === "\\") {
+				pos += 2;
+				continue;
+			}
+			if (c === "\"") {
+				state = MUSTACHE_SCAN_STATE.SCAN;
+				pos += 1;
+				continue;
+			}
+			pos += 1;
+			continue;
+		}
+	}
+	return null;
+}
+//#endregion
+//#region src/collect-mustache-regions.ts
+const HTML_FATAL_ERROR_LEVEL = 1;
+function hasFatalHtmlParseErrors(result) {
+	return result.errors.some((e) => e.level === HTML_FATAL_ERROR_LEVEL);
+}
+function collectMustacheRegions(source) {
+	const result = parseHtml(source);
+	if (hasFatalHtmlParseErrors(result)) throw new Error(result.errors.map((e) => e.msg).join("; "));
+	const mustacheRegions = [];
+	visitAll(new MustacheRegionCollector(source, mustacheRegions), result.rootNodes);
+	return mustacheRegions;
+}
+var MustacheRegionCollector = class extends RecursiveVisitor {
+	constructor(source, mustacheRegions) {
+		super();
+		this.source = source;
+		this.mustacheRegions = mustacheRegions;
+	}
+	visitText(ast, context) {
+		this.pushSpan(ast.sourceSpan);
+		super.visitText(ast, context);
+	}
+	visitCdata(ast, context) {
+		this.pushSpan(ast.sourceSpan);
+		super.visitCdata(ast, context);
+	}
+	visitAttribute(ast, context) {
+		if (ast.valueSpan && ast.value.includes("{{")) this.pushSpan(ast.valueSpan);
+		super.visitAttribute(ast, context);
+	}
+	pushSpan(span) {
+		const start = span.start.offset;
+		const end = span.end.offset;
+		const slice = this.source.slice(start, end);
+		if (!slice.includes("{{")) return;
+		for (const r of extractMustacheRegions(slice)) this.mustacheRegions.push({
+			start: start + r.start,
+			end: start + r.end
+		});
+	}
+};
+//#endregion
+//#region src/format-expression.ts
+const RE_SEMICOLON_END = /;\s*$/;
+const EXPORT_DEFAULT_PREFIX = "export default ";
+/**
+* 与 {@link tryFormatWrappedObjectLiteral} 中剥除 `export default` 与尾部分号的方式一致。
+* @param output
+*/
+function stripFormattedExportDefaultLine(output) {
+	const trimmedOut = output.trimEnd();
+	if (!trimmedOut.startsWith(EXPORT_DEFAULT_PREFIX)) throw new Error("Unexpected Prettier output for expression");
+	let body = trimmedOut.slice(15).trimEnd();
+	body = body.replace(RE_SEMICOLON_END, "").trimEnd();
+	return body;
+}
+function buildInnerFormatOptions(options) {
+	return {
+		parser: "babel",
+		semi: false,
+		singleQuote: options.singleQuote,
+		printWidth: options.printWidth,
+		tabWidth: options.tabWidth,
+		useTabs: options.useTabs,
+		bracketSpacing: options.bracketSpacing,
+		arrowParens: options.arrowParens,
+		endOfLine: options.endOfLine,
+		plugins: []
+	};
+}
+/**
+* 鉴于 WXML 对对象的支持情况，https://developers.weixin.qq.com/miniprogram/dev/reference/wxml/data.html#对象
+* 若裸字符串不是合法表达式，则用 `{}` 包一层再试：可解析为对象字面量时，
+* 按对象走 Prettier，再把外层 `{}` 剥掉写回插值（WXML 常见 `a:1,b:2` 即如此）。
+* @param trimmed
+* @param options
+* @param throwOnError
+*/
+async function tryFormatWrappedObjectLiteral(trimmed, options, throwOnError) {
+	const wrapped = `{${trimmed}}`;
+	try {
+		parseExpression(wrapped, { sourceType: "module" });
+	} catch {
+		return null;
+	}
+	try {
+		const src = `export default ${wrapped};`;
+		const body = stripFormattedExportDefaultLine(await prettier.format(src, buildInnerFormatOptions(options)));
+		if (!body.startsWith("{") || !body.endsWith("}")) throw new Error("Unexpected Prettier output for object literal");
+		return body.slice(1, -1).trim();
+	} catch (err) {
+		if (throwOnError) throw err;
+		return null;
+	}
+}
+/**
+* 将插值内层按 JS 表达式校验并交给 Prettier babel 格式化。
+* 非表达式（语句）或语法错误时返回 null（除非 throwOnError）。
+* @param inner
+* @param options
+* @param throwOnError
+*/
+async function formatInterpolationInner(inner, options, throwOnError) {
+	const trimmed = inner.trim();
+	if (!trimmed) {
+		if (throwOnError) throw new Error("Empty WXML interpolation expression");
+		return null;
+	}
+	try {
+		parseExpression(trimmed, { sourceType: "module" });
+	} catch (err) {
+		const fromObj = await tryFormatWrappedObjectLiteral(trimmed, options, throwOnError);
+		if (fromObj !== null) return fromObj;
+		if (throwOnError) throw err;
+		return null;
+	}
+	try {
+		const wrapped = `export default ${trimmed};`;
+		return stripFormattedExportDefaultLine(await prettier.format(wrapped, buildInnerFormatOptions(options)));
+	} catch (err) {
+		if (throwOnError) throw err;
+		return null;
+	}
+}
+//#endregion
+//#region src/plugin.ts
+const AST_FORMAT = "wxml-ast";
+const WXML_REPORT_LEVEL = {
+	SILENT: "silent",
+	WARN: "warn"
+};
+function getThrowOnError(options) {
+	return Boolean(options.wxmlThrowOnError);
+}
+function getReportLevel(options) {
+	return options.wxmlReportLevel === WXML_REPORT_LEVEL.WARN ? WXML_REPORT_LEVEL.WARN : WXML_REPORT_LEVEL.SILENT;
+}
+function warnPartial(filepath, count) {
+	const fp = filepath ?? "<stdin>";
+	console.warn(`[prettier-plugin-wxml] partial ${fp}: expression-format-failed x${count}`);
+}
+function warnSkipped(filepath, reason) {
+	const fp = filepath ?? "<stdin>";
+	console.warn(`[prettier-plugin-wxml] skipped ${fp}: wxml-parse-failed: ${reason}`);
+}
+async function buildAst(text, options) {
+	const pluginOptions = options;
+	const throwOnError = getThrowOnError(pluginOptions);
+	const reportLevel = getReportLevel(pluginOptions);
+	const filepath = pluginOptions.filepath;
+	let mustacheRegions;
+	try {
+		mustacheRegions = collectMustacheRegions(text);
+	} catch (err) {
+		const msg = err instanceof Error ? err.message : String(err);
+		if (throwOnError) throw err;
+		if (reportLevel === WXML_REPORT_LEVEL.WARN) warnSkipped(filepath, msg);
+		return {
+			type: "wxml-root",
+			source: text,
+			interpolations: []
+		};
+	}
+	mustacheRegions.sort((a, b) => a.start - b.start);
+	const interpolations = [];
+	let formatFailCount = 0;
+	for (const { start, end } of mustacheRegions) {
+		const raw = text.slice(start, end);
+		const inner = text.slice(start + 2, end - 2);
+		let formatted;
+		try {
+			formatted = await formatInterpolationInner(inner, options, throwOnError);
+		} catch (err) {
+			if (throwOnError) throw err;
+			formatted = null;
+		}
+		if (formatted === null && inner.trim() !== "") formatFailCount += 1;
+		interpolations.push({
+			start,
+			end,
+			raw,
+			formatted
+		});
+	}
+	if (formatFailCount > 0 && reportLevel === WXML_REPORT_LEVEL.WARN && !throwOnError) warnPartial(filepath, formatFailCount);
+	return {
+		type: "wxml-root",
+		source: text,
+		interpolations
+	};
+}
+const wxmlParser = {
+	astFormat: AST_FORMAT,
+	parse: (text, options) => buildAst(text, options),
+	locStart: () => 0,
+	locEnd: (node) => node.source.length
+};
+const wxmlPrinter = { print(path) {
+	const node = path.getValue();
+	if (node.type !== "wxml-root") return "";
+	const { source, interpolations } = node;
+	const sorted = [...interpolations].sort((a, b) => b.start - a.start);
+	let out = source;
+	for (const item of sorted) {
+		if (item.formatted === null) continue;
+		const replacement = `{{ ${item.formatted} }}`;
+		out = out.slice(0, item.start) + replacement + out.slice(item.end);
+	}
+	return out;
+} };
+const languages = [{
+	name: "WXML",
+	parsers: ["wxml"],
+	extensions: [".wxml"],
+	vscodeLanguageIds: ["wxml"]
+}];
+const options = {
+	wxmlThrowOnError: {
+		type: "boolean",
+		default: false,
+		category: "WXML",
+		description: "When true, throw on WXML parse failure or when an interpolation cannot be formatted. Default: false (graceful fallback)."
+	},
+	wxmlReportLevel: {
+		type: "choice",
+		category: "WXML",
+		default: WXML_REPORT_LEVEL.SILENT,
+		description: "When not silent, emit console warnings when the file is skipped or partially formatted.",
+		choices: [{
+			value: WXML_REPORT_LEVEL.SILENT,
+			description: "No extra logging."
+		}, {
+			value: WXML_REPORT_LEVEL.WARN,
+			description: "Log warnings when falling back to raw source."
+		}]
+	}
+};
+const defaultExport = {
+	name: "@tofrankie/prettier-plugin-wxml",
+	languages,
+	parsers: { wxml: wxmlParser },
+	printers: { [AST_FORMAT]: wxmlPrinter },
+	options
+};
+//#endregion
+export { defaultExport as default, defaultExport, options };

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@tofrankie/prettier-plugin-wxml",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "格式化微信小程序 WXML 的 Prettier 插件",
+  "author": "Frankie <1426203851@qq.com> (https://github.com/tofrankie)",
+  "license": "MIT",
+  "homepage": "https://github.com/tofrankie/prettier-plugin-wxml#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tofrankie/prettier-plugin-wxml.git"
+  },
+  "bugs": "https://github.com/tofrankie/prettier-plugin-wxml/issues",
+  "keywords": [
+    "prettier",
+    "plugin",
+    "wxml",
+    "wechat",
+    "miniprogram",
+    "tofrankie"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "CHANGELOG.md",
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "prettier": ">=3.0.0"
+  },
+  "dependencies": {
+    "@babel/parser": "^7.29.2",
+    "angular-html-parser": "^10.4.0"
+  },
+  "devDependencies": {
+    "@tofrankie/action": "^0.0.4",
+    "@tofrankie/eslint": "^0.0.15",
+    "@tofrankie/prettier": "^0.0.5",
+    "@types/node": "^25.5.0",
+    "eslint": "^9.39.4",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.4.0",
+    "npm-run-all2": "^8.0.4",
+    "prettier": "^3.8.1",
+    "publint": "^0.3.18",
+    "tsdown": "^0.21.4",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "run-s lint:eslint lint:prettier tsc publint",
+    "lint:eslint": "eslint . --cache --fix",
+    "lint:prettier": "prettier . --cache --write --log-level silent",
+    "publint": "publint",
+    "tsc": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "github:release": "tfr"
+  }
+}