Skip to content

[P2] dx: @objectstack/spec/state-machine import path mismatch with docs #1313

Description

@xuyushun441-sys

来源:docs/PLATFORM_GAPS_FROM_TEMPLATES.md 第 13 条(P2)。

现象

文档(包括 README / DX_ROADMAP)指引开发者从 @objectstack/spec/state-machine 导入状态机类型 / 工具,但实际导出路径不一致

  • 真实路径在 @objectstack/spec/objects/state-machine 或别的
  • 新人按文档写法导入会 TS 报错,30 分钟才发现是文档误导

复现

// 按文档:import{defineStateMachine}from'@objectstack/spec/state-machine';// ❌// 真实:import{defineStateMachine}from'@objectstack/spec';// 或别处

建议范围

M1:统一导出

  • 重新 export 出 @objectstack/spec/state-machine 子路径,与文档对齐
  • 或者:修文档与代码现状一致,但至少两边相同

M2:新人 onboarding 检查表

  • 模板作者 README 顶部加一段「常见导入坑列表」
  • TS 错误信息更友好

验收

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority:p2Medium: important, M3

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions