Changelog¤

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

0.1.0 - 2025-03-09¤

Compare with first commit

Build¤

• Require Python 3.10 minimum (for dataclasses keyword-only arguments) (8a53b41 by Timothée Mazzucotelli).

Features¤

• Support link inline tags and cross-references (b1cbf2d by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#5
• Implement prototype loader (38e203b by Timothée Mazzucotelli).
• Generate project with gh:pawamoy/copier-pdm Copier template (84c4e44 by Timothée Mazzucotelli).

Bug Fixes¤

• Support root module and project when getting source filepath (0031ad3 by Timothée Mazzucotelli). Issue-mkdocstrings-typescript-25
• Prevent index error when fetching source (5fdf085 by Timothée Mazzucotelli). Issue-24
• Add mapped type kind, support parameter, parameter_type and template_type fields in Type class (f9d3818 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#21
• Support signatures field in Interface class (3a6e4f4 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#20
• Support inherited_from field in GetSignature, SetSignature and Accessor classes (776eccf by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#19
• Support index_signatures field in TypeLiteral class (e4dff88 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#18
• Support type_parameters field in various classes (9d48161 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#17
• Support various additional fields in various classes (23d5367 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#16
• Support implementation_of field in SetSignature class (f287a22 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#15
• Support implementation_of field in GetSignature, Accessor and Property classes (7332871 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#14
• Support more fields (4633158 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#13
• Add inherited_from fields to Constructor, Method, CallSignature and ConstructorSignature classes (ce5ff98 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#11, Issue-mkdocstrings/typescript#12
• Support implemented_by, implemented_types and implementation_of fields in Class, Interface, Method and CallSignature reflections (9d9fa8f by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#9
• Support overwrites field in Constructor, ConstructorSignature, CallSignature and Method reflections, as well as extended_types and extended_by fields in Class reflection (921512e by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#10
• Add "operator" type kind and same field on types (2012f6d by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#6
• Support parameters in constructor signatures (70626a4 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#8
• Support prefer_values and query type (faa6a9f by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#7
• Support type on all reflections, support signatures on constructors (78bd842 by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#3, Issue-mkdocstrings/typescript#4
• Support files attribute on projects (89d46be by Timothée Mazzucotelli). Issue-2
• Be yet more robust when parsing typedoc's output (23d4619 by Timothée Mazzucotelli).
• Don't crash when log level can't be matched in typedoc's output (032a400 by Timothée Mazzucotelli).
• Support readme field in module classes (fef7f54 by Timothée Mazzucotelli).

Code Refactoring¤

• Expose public objects in top-level module (34a637c by Timothée Mazzucotelli).
• Rename dataclasses module to models (2d00279 by Timothée Mazzucotelli).
• Move modules into internal folder (a9c1d44 by Timothée Mazzucotelli).
• Only use dataclasses keyword-only argument on Python 3.10 (c17530b by Timothée Mazzucotelli).
• Improve getting object file path thanks to file registry (e63a4d5 by Timothée Mazzucotelli).
• Attach parent to more objects (a103967 by Timothée Mazzucotelli).