accordproject / markdown-transform / 26807109843

79%

push

github

feat: tighten TypeScript type declarations — replace `any` with concrete types (#669)

* feat: tighten TypeScript type declarations — replace `any` with concrete types

Update JSDoc @param and @returns annotations on the priority public API
methods across four packages so that generated .d.ts files no longer
use `any` where a more specific type is known:

- CommonMarkTransformer: toMarkdown, removeFormatting (object input),
  toTokens (object[] return), fromTokens (object[] param, object return),
  getSerializer (Serializer return)
- CiceroMarkTransformer: getClauseText, fromCiceroEdit, fromCommonMark,
  toMarkdown, toCommonMark, toCiceroMarkUnwrapped (object I/O),
  toTokens/fromTokens (object[]/object), getSerializer (Serializer)
- HtmlTransformer: toHtml (object input), toCiceroMark (object return)
- TemplateMarkTransformer: getSerializer (object return)

Regenerated .d.ts files in each package with `tsc`.

Closes #668

Signed-off-by: Matt Roberts <matt@rbrts.uk>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Matt Roberts <code@rbrts.uk>

* feat: tighten types for ToMarkdownVisitor and TransformEngine

- ToMarkdownVisitor.toMarkdown: {*} input → {object}
- TransformEngine.transformToDestination/transform: source {*} → {object|string},
  returns {*}/{Promise} → {Promise<object|string>}
- TransformEngine.registerTransformation: transform {*} → {Function}
- TransformEngine.registerExtension: extension {*} → {object}
- transform.js module exports: add JSDoc to formatDescriptor, transform,
  generateTransformationDiagram, and builtinEngine so tsc can emit
  typed declarations rather than any

Regenerated .d.ts files in markdown-common and markdown-transform.

Signed-off-by: Matt Roberts <matt@rbrts.uk>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Matt Roberts <code@rbrts.uk>

* feat(markdown-common): generate TypeScript model interfaces from CTO schemas

Add a codegen script that runs TypescriptVisit... (continued)

771 of 1164 branches covered (66.24%)

Branch coverage included in aggregate %.

1978 of 2633 relevant lines covered (75.12%)

971.51 hits per line