@joshwooding/vite-plugin-react-docgen-typescript

Releases

1. ▸▾0.9.07 Sept 2026Deprecated

   8505fc5 : Deprecate fileSystemCache and annotate its options interface with @deprecated . Remove fileSystemCache from configuration or set it to false…

   Minor Changes

   • 0ef782f: Add an experimental docgenMode: "native" backend for TypeScript 7.1's
     typescript/unstable/sync API, including imported-prop HMR and project-reference
     support. Native requests are batched and project/path state is reused across
     transforms. TypeScript 7.0 remains unsupported.

     In the 6 September 2026 CI run,
     the 188-component fixture used seven projects, ten shared-type edits and two
     fresh processes per backend. Compared with ProjectService in that run, native
     reduced total cold time by 48% on Linux and 26% on Windows, and edit p50 by 31%
     and 11%, respectively. Post-edit retained RSS, including the native engine
     process, was 13% and 14% lower. Both platforms produced exact metadata agreement
     for all 188 components.

     Results depend on the workload: in the separate 24-file fixture, native's full
     session was 29% shorter on Linux but 35% longer on Windows. Cache-bypassed
     reanalysis was about four times slower on native on both platforms. These CI
     measurements are diagnostic and do not establish a speedup for every project.

   Patch Changes

   • 8505fc5: Track complete component dependencies through cyclic imports regardless of transform order, so edits to shared types refresh every affected component's docgen metadata.

     Follow the compiler's resolved declaration targets and import/require modes, including referenced-project path mappings and unresolved conditional targets.

     Include existing global declarations, UMD namespaces, module augmentations, and their imported types in dependency tracking so live edits and offline edits invalidate cached metadata while ordinary modules retain selective invalidation.

   • 8505fc5: Validate persistent docgen cache entries against the current TypeScript program before reuse, so newly included declarations, global types, and module augmentations invalidate stale metadata after a restart.

     Register existing external type dependencies with Vite's watcher so edits refresh affected components, including dependencies in referenced projects. External type files that are absent when the server starts remain a known watch limitation.

   • 8505fc5: Deprecate fileSystemCache and annotate its options interface with @deprecated.
     Remove fileSystemCache from configuration or set it to false. In-memory
     transform caching and TypeScript program reuse continue. Existing boolean and
     object configurations, including custom directories, still work; the default
     remains false.

     A 60-run recheck on two Windows fixtures across both stable modes found
     insufficient startup benefit and slower edit processing with disk persistence.
     These results support simplifying the feature, without promising a speedup for
     every consumer.

     Removal is intended for a later breaking release, after at least one published
     compatible release carrying this notice. No removal version or date is set.

   • 8505fc5: Reuse canonical dependency paths produced by the backend to avoid repeated filesystem resolution during analysis and persistent-cache validation.

   • 8505fc5: Reuse canonical dependency paths during transforms to avoid repeated filesystem path resolution, while preserving physical path aliases and cache freshness checks.

   • 8505fc5: Invalidate cached docgen metadata when a TypeScript config changes after loading persistent cache entries, including before the compiler backend starts.

     Register cached config paths with Vite's watcher so edits to custom configs and extended configs outside the Vite root trigger invalidation.