Implement AST-based dependency extraction in FormulaVisitor.calculateDependencies (markdown-template)

未关闭
  • 哪里不对？
#679 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript
领域
backend, tooling

调研方向

Start by reading packages/markdown-template/src/FormulaVisitor.ts and trace how calculateDependencies is called from templatemarkutil.ts and how dependencies is serialized and read back. The issue leaves the runtime parser and which identifiers count unresolved, so first settle those decisions in the discussion before implementing. Done means extracting the agreed dependencies from formula TypeScript while respecting the agreed handling of bindings and parse failures.

由索引模型根据 Issue 内容生成。

描述

Stale

Summary

FormulaVisitor.calculateDependencies(tsCode) in packages/markdown-template/src/FormulaVisitor.ts is a stub (// TODO!!) that always returns []. It's invoked during TemplateMark typing (templatemarkutil.ts → templateMarkTypingGen), which sets dependencies on every FormulaDefinition / ConditionalDefinition, and the value is serialized through markdown-html (ToHtmlStringVisitor.ts writes the dependencies attribute, rules.ts reads it back). Today that attribute is always an empty array.

Continuing the working discussion with @mttrbrts

Current state / safety

Traced consumers of the field across the org:

  • markdown-transform: only written (HTML attr), read back (rules.ts), or stripped (markdown-cicero/ToCommonMarkVisitor.ts deletes it).
  • template-engine: only TemplateMarkInterpreter.ts does delete context.dependencies.

No code branches on the values, so implementing real extraction is self-contained with no regression surface — it only populates a field that is currently always empty.

Proposed approach

Extract root identifiers from the formula's TypeScript source (the param is named tsCode) via the AST rather than regex:

  • Collect root identifiers that reference template variables / model, excluding locally-bound names, function params, and built-ins.
  • Handle optional chaining (a?.b?.c → root a).
  • Return [] on parse failure or unrecognized constructs (note: this changes the current catch, which throws — flagging so it's an explicit decision).

Open questions to scope before implementation

  1. Runtime parser: typescript is currently a devDependency of markdown-template. Preference for promoting the TS compiler API to a runtime dep vs. a lighter parser (e.g. @typescript-eslint/typescript-estree)?
  2. Dependency definition: which identifier classes count — model/variable refs only, and are locally-declared bindings and function params always excluded?
  3. Cross-formula references: Devanshi noted formulas lack stable user-facing names, so these look out-of-scope for v1 — agreed to defer?

I can't make the Wednesday call, so opening this for async discussion per your
suggestion. Once (1) the runtime parser and (2) the dependency-definition
question are settled here, I'll scope the PR to those decisions.

主要语言
TypeScript
星标
86
派生
69
平均合并
6 分钟
30 天内合并 PR
3

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

accordproject/markdown-transform 的其他 Issue

查看 accordproject/markdown-transform 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。