Skip to content

docs: document --stableTypeOrdering impact on packaging tests #54

Description

@martyy-code

Description

Document the impact of TypeScript 6's --stableTypeOrdering flag on packaging tests (publint, attw). When stableTypeOrdering is enabled, union types and object keys are emitted in a deterministic order, which affects declaration emit and can cause attw to fail unexpectedly.

Why

TypeScript 6 introduces --stableTypeOrdering to normalize declaration output. When enabled, union order in .d.ts files becomes predictable. attw resolves types under node16/nodenext/bundler and can flag these as differences. Without documentation, consumers will hit mysterious CI failures.

Acceptance criteria

  • Document the stableTypeOrdering flag and its effect on declaration emit
  • Document how it interacts with publint and attw
  • Provide a workaround or config if order matters

Risks

  • None. Pure documentation.

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:buildPackaging, exports map, tsconfigarea:docsREADME, JSDoc, docsdocumentationImprovements or additions to documentation

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions