npm.io
2.11.0 • Published 4d ago

@airalogy/aimd-core

Licence
Apache-2.0
Version
2.11.0
Deps
14
Size
787 kB
Vulns
0
Weekly
206
SummaryDependencyVersions

@airalogy/aimd-core

npm version License

AIMD（Airalogy Markdown）的核心解析器与规范化字段提取能力。

它也会把 fenced assigner runtime=client 代码块提取为 fields.client_assigner 前端元数据。 普通 var 的 id 仍然保留在 fields.var；其解析出的类型、默认值和 kwargs 元数据也会通过 fields.var_definitions 暴露。 title、description、example/examples 这类显示元数据会被提取到 var 和 var_table 字段结构里，renderer 与 recorder 可以显示更友好的标签，同时保留稳定的规范 id。 它也暴露 remarkCriticMarkup，用于把 CriticMarkup 风格审阅标记解析进 Markdown AST，但不会把这些审阅标记加入 AIMD 字段提取结果。

协议级 AIMD 语法、assigner 语义与校验规则以 Airalogy 文档为准；@airalogy/aimd-* 文档只描述前端 parser、renderer、recorder 如何实现这些规范。

安装

pnpm add @airalogy/aimd-core

快速开始

import { unified } from "unified"
import remarkParse from "remark-parse"
import { remarkAimd } from "@airalogy/aimd-core/parser"

const content = '{{var|sample_name: str, title="样本名", description="样本的人类可读标签", examples=["S-001"]}}'
const processor = unified().use(remarkParse).use(remarkAimd)
const tree = processor.parse(content)
const file = { data: {} } as any
processor.runSync(tree, file)

console.log(file.data.aimdFields)

示例 client assigner：

```assigner runtime=client
assigner(
  {
    mode: "auto",
    dependent_fields: ["a", "b"],
    assigned_fields: ["total"],
  },
  function calculate_total({ a, b }) {
    return {
      total: a + b,
    };
  }
);
```

如果 AIMD 行内模板出现在 Markdown 表格单元格中，需要在 parse() 之前先保护模板，避免 GFM 把模板里的 | 当成列表格分隔符：

import { protectAimdInlineTemplates, remarkAimd } from "@airalogy/aimd-core/parser"

const { content: protectedContent, templates } = protectAimdInlineTemplates(content)
const file = { data: { aimdInlineTemplates: templates } } as any
const tree = processor.parse(protectedContent)
processor.runSync(tree, file)

CriticMarkup 审阅节点

import { unified } from "unified"
import remarkParse from "remark-parse"
import remarkGfm from "remark-gfm"
import {
  CRITIC_MARKUP_SUBSTITUTIONS_DATA_KEY,
  protectCriticMarkupSubstitutions,
  remarkCriticMarkup,
} from "@airalogy/aimd-core/parser"

const { content: protectedContent, substitutions } = protectCriticMarkupSubstitutions(
  "替换 {~~旧表述~>新表述~~}，并标记 {==重点文字==}。",
)
const file = { data: { [CRITIC_MARKUP_SUBSTITUTIONS_DATA_KEY]: substitutions } } as any
const processor = unified().use(remarkParse).use(remarkGfm).use(remarkCriticMarkup)
const tree = processor.parse(protectedContent)
processor.runSync(tree, file)

remarkCriticMarkup 会生成 criticAddition、criticDeletion、criticSubstitution、criticComment 和 criticHighlight 节点。它不会改变 AIMD 字段提取结果。

Choice 后续字段

选择题选项可以在 followups 下声明条件触发的结构化字段。解析结果会保存在 options[].followups，字段类型只支持 str、int、float、bool；这里有意不接受 number。

```quiz
id: sample_storage
type: choice
mode: single
stem: "样本当前如何保存？"
options:
  - key: A
    text: "冷藏保存"
    followups:
      - key: temperature_c
        type: float
        title: "温度"
        unit: "°C"
      - key: duration_hours
        type: float
        title: "时长"
        unit: "小时"
  - key: B
    text: "冷冻保存"
  - key: C
    text: "常温放置"
```

判断题

判断题使用 type: true_false。answer 和 default 会被规范化为布尔值；如果省略 options，默认选项为 true. True 和 false. False。

```quiz
id: sample_kept_cold
type: true_false
stem: "样本转移过程中是否一直保持低温？"
answer: true
```

校验辅助函数

import {
  parseVarDefinition,
  validateClientAssignerFunctionSource,
  validateVarDefinition,
  validateVarDefaultType,
  validateVarKwargs,
} from "@airalogy/aimd-core/parser"

如果宿主工具需要在保存或执行前预检 fenced assigner runtime=client 函数，可使用 validateClientAssignerFunctionSource()。如果你想在作者填写 AIMD var 默认值时提示类型不匹配警告，可使用 validateVarDefaultType()。如果工具还需要提示 gt、ge、lt、le、multiple_of 这类 Pydantic 风格数值约束被用在非数值类型上，可使用 validateVarKwargs() 或 validateVarDefinition()。

文档

Keywords

aimdmarkdownparserunifiedremarksyntax