@open-guji/markdown-core 0.1.0

package/dist/plugin.d.ts

@@ -0,0 +1,18 @@
+/**
+ * remark 插件：一次性接上古籍扩展。
+ *
+ * ```js
+ * unified().use(remarkParse).use(remarkGuji).use(remarkRehype)
+ * ```
+ *
+ * 插件做三件事：
+ * 1. 注册 directive 的 micromark / mdast 扩展（不必再单独 use remark-directive）；
+ * 2. 包裹 parser，在解析前把短记号规范化为指令；
+ * 3. 解析后归一指令名、并做抬头的行作用域归并。
+ */
+import type { Root } from 'mdast';
+import type { Plugin } from 'unified';
+import { type GujiOptions } from './options.js';
+declare const remarkGuji: Plugin<[GujiOptions?], Root>;
+export default remarkGuji;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAGjC,OAAO,KAAK,EAAE,MAAM,EAAa,MAAM,SAAS,CAAA;AAEhD,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAA;AAM/D,QAAA,MAAM,UAAU,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CA+B5C,CAAA;AAED,eAAe,UAAU,CAAA"}

package/dist/plugin.js

@@ -0,0 +1,49 @@
+/**
+ * remark 插件：一次性接上古籍扩展。
+ *
+ * ```js
+ * unified().use(remarkParse).use(remarkGuji).use(remarkRehype)
+ * ```
+ *
+ * 插件做三件事：
+ * 1. 注册 directive 的 micromark / mdast 扩展（不必再单独 use remark-directive）；
+ * 2. 包裹 parser，在解析前把短记号规范化为指令；
+ * 3. 解析后归一指令名、并做抬头的行作用域归并。
+ */
+import { directiveFromMarkdown, directiveToMarkdown } from 'mdast-util-directive';
+import { directive } from 'micromark-extension-directive';
+import { gujiToDirective } from './normalize.js';
+import { resolveOptions } from './options.js';
+import { applyLineScope, normalizeDirectiveNames } from './transform.js';
+/** 同一个 processor 上避免重复注册 directive 扩展。 */
+const installed = new WeakSet();
+const remarkGuji = function remarkGuji(options) {
+    const settings = resolveOptions(options);
+    const self = this;
+    const data = self.data();
+    if (!installed.has(self)) {
+        installed.add(self);
+        const micromarkExtensions = data.micromarkExtensions ?? (data.micromarkExtensions = []);
+        const fromMarkdownExtensions = data.fromMarkdownExtensions ?? (data.fromMarkdownExtensions = []);
+        const toMarkdownExtensions = data.toMarkdownExtensions ?? (data.toMarkdownExtensions = []);
+        micromarkExtensions.push(directive());
+        fromMarkdownExtensions.push(directiveFromMarkdown());
+        toMarkdownExtensions.push(directiveToMarkdown());
+    }
+    if (settings.shorthand) {
+        const parser = self.parser;
+        if (typeof parser !== 'function') {
+            throw new Error('remark-guji: 需要先注册 remark-parse，例如 unified().use(remarkParse).use(remarkGuji)。' +
+                '若只做序列化，请传 { shorthand: false }。');
+        }
+        self.parser = (document, file) => parser(gujiToDirective(String(document), settings), file);
+    }
+    return (tree) => {
+        if (settings.normalizeNames)
+            normalizeDirectiveNames(tree);
+        if (settings.lineScope)
+            applyLineScope(tree);
+    };
+};
+export default remarkGuji;
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAEzD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAoB,MAAM,cAAc,CAAA;AAC/D,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAExE,0CAA0C;AAC1C,MAAM,SAAS,GAAG,IAAI,OAAO,EAAU,CAAA;AAEvC,MAAM,UAAU,GAAiC,SAAS,UAAU,CAAC,OAAO;IAC1E,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,IAAI,GAAG,IAA4B,CAAA;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;IAExB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAyB,CAAC,EAAE,CAAC;QAC9C,SAAS,CAAC,GAAG,CAAC,IAAyB,CAAC,CAAA;QACxC,MAAM,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAA;QACvF,MAAM,sBAAsB,GAC1B,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC,CAAA;QACnE,MAAM,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC,CAAA;QAC1F,mBAAmB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QACrC,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA;QACpD,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAClD,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAC1B,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CACb,gFAAgF;gBAC9E,iCAAiC,CACpC,CAAA;QACH,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAA;IAC7F,CAAC;IAED,OAAO,CAAC,IAAU,EAAE,EAAE;QACpB,IAAI,QAAQ,CAAC,cAAc;YAAE,uBAAuB,CAAC,IAAI,CAAC,CAAA;QAC1D,IAAI,QAAQ,CAAC,SAAS;YAAE,cAAc,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC,CAAA;AACH,CAAC,CAAA;AAED,eAAe,UAAU,CAAA"}

package/dist/transform.d.ts

@@ -0,0 +1,15 @@
+/**
+ * mdast 层的两个变换：指令名归一、抬头的行作用域归并。
+ * 规范见 spec/ast.md §1。
+ */
+import type { Root } from 'mdast';
+/** 把别名（`note`、`add` …）改写为规范名（`jz`、`bz` …）。 */
+export declare function normalizeDirectiveNames(tree: Root): void;
+/**
+ * 把 `:tt{n}` 之后、直到本行结束（下一个 `break`、文本中的换行，
+ * 或父节点结束）的兄弟节点，移入该指令的 children。
+ *
+ * 变换后 `tt` 与其他行内指令形态一致，渲染器只需处理一种情况。
+ */
+export declare function applyLineScope(tree: Root): void;
+//# sourceMappingURL=transform.d.ts.map

package/dist/transform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../src/transform.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAS,IAAI,EAAE,MAAM,OAAO,CAAA;AAyBxC,8CAA8C;AAC9C,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAIxD;AAYD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAO/C"}

package/dist/transform.js

@@ -0,0 +1,73 @@
+/**
+ * mdast 层的两个变换：指令名归一、抬头的行作用域归并。
+ * 规范见 spec/ast.md §1。
+ */
+import { visit } from 'unist-util-visit';
+import { resolveDirectiveName } from './directives.js';
+const DIRECTIVE_TYPES = new Set(['textDirective', 'leafDirective', 'containerDirective']);
+function isDirective(node) {
+    return (typeof node === 'object' &&
+        node !== null &&
+        DIRECTIVE_TYPES.has(node.type ?? ''));
+}
+/** 把别名（`note`、`add` …）改写为规范名（`jz`、`bz` …）。 */
+export function normalizeDirectiveNames(tree) {
+    visit(tree, (node) => {
+        if (isDirective(node))
+            node.name = resolveDirectiveName(node.name);
+    });
+}
+/** `:tt{n}` 空标记：无 label 的抬头行内指令。 */
+function isTaitouMarker(node) {
+    return (isDirective(node) &&
+        node.type === 'textDirective' &&
+        resolveDirectiveName(node.name) === 'tt' &&
+        (!node.children || node.children.length === 0));
+}
+/**
+ * 把 `:tt{n}` 之后、直到本行结束（下一个 `break`、文本中的换行，
+ * 或父节点结束）的兄弟节点，移入该指令的 children。
+ *
+ * 变换后 `tt` 与其他行内指令形态一致，渲染器只需处理一种情况。
+ */
+export function applyLineScope(tree) {
+    visit(tree, (node) => {
+        if (!('children' in node) || !Array.isArray(node.children))
+            return;
+        const children = node.children;
+        if (!children.some(isTaitouMarker))
+            return;
+        node.children = scopeChildren(children);
+    });
+}
+function scopeChildren(children) {
+    const out = [];
+    for (let i = 0; i < children.length; i++) {
+        const child = children[i];
+        if (!isTaitouMarker(child)) {
+            out.push(child);
+            continue;
+        }
+        const collected = [];
+        let j = i + 1;
+        for (; j < children.length; j++) {
+            const next = children[j];
+            if (next.type === 'break')
+                break;
+            if (next.type === 'text' && next.value.includes('\n')) {
+                const at = next.value.indexOf('\n');
+                if (at > 0)
+                    collected.push({ type: 'text', value: next.value.slice(0, at) });
+                children[j] = { type: 'text', value: next.value.slice(at) };
+                break;
+            }
+            collected.push(next);
+        }
+        ;
+        child.children = collected;
+        out.push(child);
+        i = j - 1;
+    }
+    return out;
+}
+//# sourceMappingURL=transform.js.map

package/dist/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../src/transform.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,eAAe,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC,CAAA;AAazF,SAAS,WAAW,CAAC,IAAa;IAChC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,eAAe,CAAC,GAAG,CAAE,IAA0B,CAAC,IAAI,IAAI,EAAE,CAAC,CAC5D,CAAA;AACH,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,uBAAuB,CAAC,IAAU;IAChD,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;QACnB,IAAI,WAAW,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACpE,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,oCAAoC;AACpC,SAAS,cAAc,CAAC,IAAa;IACnC,OAAO,CACL,WAAW,CAAC,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,KAAK,eAAe;QAC7B,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI;QACxC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAC/C,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAU;IACvC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;QACnB,IAAI,CAAC,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAM;QAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAmB,CAAA;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;YAAE,OACnC;QAAC,IAA2C,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,QAAiB;IACtC,MAAM,GAAG,GAAY,EAAE,CAAA;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACf,SAAQ;QACV,CAAC;QAED,MAAM,SAAS,GAAY,EAAE,CAAA;QAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACb,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;YACxB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;gBAAE,MAAK;YAChC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtD,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACnC,IAAI,EAAE,GAAG,CAAC;oBAAE,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;gBAC5E,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAA;gBAC3D,MAAK;YACP,CAAC;YACD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtB,CAAC;QAED,CAAC;QAAC,KAAkC,CAAC,QAAQ,GAAG,SAAS,CAAA;QACzD,GAAG,CAAC,IAAI,CAAC,KAAyB,CAAC,CAAA;QACnC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACX,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@open-guji/markdown-core",
+  "version": "0.1.0",
+  "description": "古籍 Markdown 扩展的核心：短记号 → Directive 规范化器与 remark 插件",
+  "keywords": [
+    "markdown",
+    "remark",
+    "directive",
+    "古籍",
+    "guji",
+    "chinese",
+    "classics"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/open-guji/guji-markdown.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/open-guji/guji-markdown/tree/main/packages/core",
+  "bugs": "https://github.com/open-guji/guji-markdown/issues",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.18"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "mdast-util-directive": "^3.1.0",
+    "micromark-extension-directive": "^4.0.0",
+    "remark-parse": "^11.0.0",
+    "remark-stringify": "^11.0.0",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  }
+}