Skip to content

docs(skills): console-development.md 的「Retired names」表称 config/metadataTypeRegistry.ts「从未存在过」—— git 可证它确实以该路径落过地(d601ef693 加入 / ff9a0d9e9 删除) #3859

Description

@yinlianghui

越界发现,记录于 #3738 / PR #3858(按现实改写 ROADMAP.md 的 P1.12.3 / P1.16 九条)期间。该单文件面只含 ROADMAP.md,按纪律只报不改,单独立单,未认领

观察类:一条纠错表自身的事实错误,零运行时影响。故打 finding、不打 pm:queue。严重度留给分诊裁。

事实

skills/objectui/guides/console-development.md「Retired names — do not import these」表(按内容锚定,当前在 :104)称:

Retired symbol Verdict
config/metadataTypeRegistry.ts Never existed under apps/console/src/. The real registry is packages/app-shell/src/views/metadata-admin/registry.ts.

「Never existed under apps/console/src/」不成立。该文件确实以恰好那个路径存在过:

$ git log --oneline --all --diff-filter=AD -- '*metadataTypeRegistry*'
d601ef693 feat: unified metadata management with registry, generic manager page, and dynamic routing
9bf2fa44e test: prune redundant tests, keep core protocol/engine coverage
ff9a0d9e9 chore: remove studio app and migrate to metadata-admin engine

$ git show --stat d601ef693 | grep metadataTypeRegistry
 apps/console/src/config/metadataTypeRegistry.ts    | 195 +++++++++++++++

$ git show --stat ff9a0d9e9 | grep metadataTypeRegistry
 apps/console/src/config/metadataTypeRegistry.ts    |  317 ------

即:d601ef693 以 195 行在 apps/console/src/config/metadataTypeRegistry.ts 加入,长到 317 行,在 ff9a0d9e9(「remove studio app and migrate to metadata-admin engine」)随 studio app 的移除一并删除。表格同一列里其余五行都给了正确的处置词(Deleted. + commit),唯这一行把「已删除」写成了「从未存在」。

CHANGELOG.md:522 也留有它交付时的记录(「New centralized metadata type registry (config/metadataTypeRegistry.ts)」),与 git 一致。

为什么这条值得记

该表的用途正是省掉一次查证(表头自述「searching for them wastes a lap」)。但「从未存在」与「已删除」对读者是两种不同的指示:

  • 「已删除」→ 想知道它当年怎么组织的,git show ff9a0d9e9^:apps/console/src/config/metadataTypeRegistry.ts 一条命令就能读到,这在理解 registry 从 console 侧迁往引擎侧的动机时是有用的史料。
  • 「从未存在」→ 读者不会去 git 里找,并且会认为 ROADMAP.md 里那条 - [x] Metadata type registry (config/metadataTypeRegistry.ts)凭空写的,而它其实是过期的。两者的处理方式不同。

具体代价已经发生过一次:PR #3858 改写 ROADMAP :861 时,若直接沿用 guide 这句话,就会把「从未存在」写进 ROADMAP,把一条已删除记录错记成虚构记录。那次是靠 git log --diff-filter=AD 复核才没有继承。

复核方式

grep -n 'Never existed' skills/objectui/guides/console-development.md
git log --oneline --all --diff-filter=AD -- '*metadataTypeRegistry*'
git show --stat d601ef693 | grep metadataTypeRegistry     # 加入:apps/console/src/config/…
git show --stat ff9a0d9e9 | grep metadataTypeRegistry     # 删除
git show ff9a0d9e9^:apps/console/src/config/metadataTypeRegistry.ts | head -20   # 内容仍可取

建议的改法(留给认领者裁,本单不改)

把该行的 Verdict 对齐同表其余五行的形态,例如:「Deleted (ff9a0d9e9, "remove studio app and migrate to metadata-admin engine"; added in d601ef693). The real registry is packages/app-shell/src/views/metadata-admin/registry.ts.」

注意同表下一行「MetadataTypeConfig, registerMetadataType, … No such API anywhere in the repo (zero hits)」措辞是准确的 —— 它说的是「今天全仓零命中」,不是「从未存在」,不必动。本单只钉「Never existed」这一句。

关联

已就关键词(Never existedmetadataTypeRegistryconsole-development.mdRetired names)搜过本仓开放 issue:除 #3738 与上述三单外无同源单。

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions