Документация библиотеки компонентов TypeScript React для свойств - PullRequest
0 голосов
/ 04 декабря 2018

У меня есть библиотека компонентов, которая структурирована как монорепо.Каждый компонент является независимым пакетом, а создание документации также является отдельным пакетом.

Я использую docz для создания своей документации, которая используетact-docgen-typcript для создания документации свойств.У меня проблема в том, что я не могу получить документацию для свойств и попробовал два подхода

  1. Если я сделаю так, чтобы мой компонент package.json указывал на TypeScript, он не распознает источник как TypeScript ивызывает исключение: (
  2. Если я заставлю свой компонент package.json указать на перенесенную версию, свойства не будут заполнены, так как я не использую PropTypes

Как мне перейтио создании документации по свойствам? Есть ли способ извлечь ее из файлов объявлений типов?

1 Ответ

0 голосов
/ 04 декабря 2018

В вашем файле tsconfig.json должно быть declaration: true.Таким образом вы получаете файлы

  • .js (содержит PropTypes)
  • .d.ts файлов (распознается TypeScript).
...