TypeScript React组件库文档的属性

时间:2018-12-03 22:55:41

标签: reactjs typescript storybook

我有一个结构为monorepo的组件库。每个组件都是一个独立的程序包,文档生成也是一个独立的程序包。

我正在使用docz创建我的文档,该文档使用react-docgen-typescript创建属性文档。我的问题是我无法获取属性的文档,并尝试了两种方法

  1. 如果我将组件package.json指向TypeScript,它不会将源识别为TypeScript并引发异常:(
  2. 如果我将组件package.json指向已编译的版本,则由于我不使用PropTypes,所以不会填充属性

如何生成属性文档?有没有办法从类型声明文件中提取它?

1 个答案:

答案 0 :(得分:0)

您的tsconfig.json中应该有offset。通过这种方式

  • .js文件(包含declaration: true
  • .d.ts文件(由TypeScript识别)。