@storybook/addon-docs 6.5.0-alpha.6 → 6.5.0-alpha.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (532) hide show
  1. package/README.md +4 -13
  2. package/angular/README.md +0 -6
  3. package/angular/index.d.ts +1 -1
  4. package/angular/index.js +7 -1
  5. package/dist/cjs/blocks/Anchor.js +1 -1
  6. package/dist/cjs/blocks/ArgsTable.js +49 -13
  7. package/dist/cjs/blocks/Canvas.js +13 -11
  8. package/dist/cjs/blocks/Description.js +10 -10
  9. package/dist/cjs/blocks/DocsContainer.js +8 -6
  10. package/dist/cjs/blocks/DocsContext.js +2 -2
  11. package/dist/cjs/blocks/Heading.js +2 -2
  12. package/dist/cjs/blocks/Meta.js +8 -6
  13. package/dist/cjs/blocks/Primary.js +7 -7
  14. package/dist/cjs/blocks/Source.js +23 -10
  15. package/dist/cjs/blocks/SourceContainer.js +28 -18
  16. package/dist/cjs/blocks/Stories.js +14 -7
  17. package/dist/cjs/blocks/Story.js +12 -30
  18. package/dist/cjs/blocks/Subheading.js +2 -2
  19. package/dist/cjs/blocks/Subtitle.js +5 -5
  20. package/dist/cjs/blocks/Title.js +8 -8
  21. package/dist/cjs/blocks/enhanceSource.js +5 -5
  22. package/dist/cjs/blocks/index.js +6 -4
  23. package/dist/cjs/blocks/mdx.js +18 -10
  24. package/dist/cjs/blocks/useStory.js +8 -6
  25. package/dist/cjs/blocks/utils.js +3 -3
  26. package/dist/cjs/index.js +2 -0
  27. package/dist/cjs/{register.js → manager.js} +0 -0
  28. package/dist/cjs/preset.js +226 -0
  29. package/dist/cjs/{frameworks/common/config.js → preview.js} +11 -17
  30. package/dist/esm/blocks/ArgsTable.js +39 -6
  31. package/dist/esm/blocks/Canvas.js +5 -3
  32. package/dist/esm/blocks/Description.js +1 -1
  33. package/dist/esm/blocks/DocsContainer.js +3 -2
  34. package/dist/esm/blocks/DocsContext.js +2 -2
  35. package/dist/esm/blocks/Heading.js +1 -1
  36. package/dist/esm/blocks/Meta.js +3 -2
  37. package/dist/esm/blocks/Primary.js +1 -0
  38. package/dist/esm/blocks/Source.js +16 -2
  39. package/dist/esm/blocks/SourceContainer.js +22 -13
  40. package/dist/esm/blocks/Stories.js +7 -0
  41. package/dist/esm/blocks/Story.js +6 -25
  42. package/dist/esm/blocks/Subheading.js +1 -1
  43. package/dist/esm/blocks/Title.js +1 -1
  44. package/dist/esm/blocks/enhanceSource.js +3 -3
  45. package/dist/esm/blocks/mdx.js +16 -9
  46. package/dist/esm/blocks/useStory.js +15 -15
  47. package/dist/esm/blocks/utils.js +1 -1
  48. package/dist/esm/{register.js → manager.js} +0 -0
  49. package/dist/esm/preset.js +197 -0
  50. package/dist/esm/{frameworks/common/config.js → preview.js} +5 -9
  51. package/dist/modern/blocks/ArgsTable.js +24 -3
  52. package/dist/modern/blocks/Canvas.js +3 -1
  53. package/dist/modern/blocks/Description.js +1 -1
  54. package/dist/modern/blocks/DocsContext.js +2 -2
  55. package/dist/modern/blocks/Source.js +17 -2
  56. package/dist/modern/blocks/SourceContainer.js +18 -12
  57. package/dist/modern/blocks/Stories.js +5 -0
  58. package/dist/modern/blocks/Story.js +2 -24
  59. package/dist/modern/blocks/mdx.js +13 -8
  60. package/dist/modern/{register.js → manager.js} +0 -0
  61. package/dist/modern/{frameworks/common/preset.js → preset.js} +16 -17
  62. package/dist/modern/preview.js +6 -0
  63. package/dist/ts3.4/blocks/Source.d.ts +5 -3
  64. package/dist/ts3.4/blocks/SourceContainer.d.ts +5 -1
  65. package/dist/ts3.4/{register.d.ts → manager.d.ts} +0 -0
  66. package/dist/ts3.4/preset.d.ts +11 -0
  67. package/dist/ts3.4/preview.d.ts +6 -0
  68. package/dist/ts3.9/blocks/DocsContext.d.ts +2 -2
  69. package/dist/ts3.9/blocks/Source.d.ts +5 -3
  70. package/dist/ts3.9/blocks/SourceContainer.d.ts +6 -2
  71. package/dist/ts3.9/blocks/enhanceSource.d.ts +2 -2
  72. package/dist/ts3.9/blocks/useStory.d.ts +2 -2
  73. package/dist/ts3.9/{register.d.ts → manager.d.ts} +0 -0
  74. package/dist/ts3.9/preset.d.ts +11 -0
  75. package/dist/ts3.9/preview.d.ts +6 -0
  76. package/ember/index.js +6 -1
  77. package/jest-transform-mdx.js +2 -5
  78. package/manager.js +1 -0
  79. package/mdx-compiler-plugin.js +1 -1
  80. package/package.json +24 -118
  81. package/preset.js +1 -16
  82. package/preview.js +1 -0
  83. package/register.js +6 -1
  84. package/{dist/cjs/frameworks/svelte → svelte}/HOC.svelte +0 -0
  85. package/common-preset.js +0 -19
  86. package/dist/cjs/frameworks/angular/compodoc.js +0 -397
  87. package/dist/cjs/frameworks/angular/config.js +0 -31
  88. package/dist/cjs/frameworks/angular/index.js +0 -22
  89. package/dist/cjs/frameworks/angular/prepareForInline.js +0 -96
  90. package/dist/cjs/frameworks/angular/sourceDecorator.js +0 -159
  91. package/dist/cjs/frameworks/angular/types.js +0 -1
  92. package/dist/cjs/frameworks/common/enhanceArgTypes.js +0 -21
  93. package/dist/cjs/frameworks/common/preset.js +0 -187
  94. package/dist/cjs/frameworks/ember/config.js +0 -17
  95. package/dist/cjs/frameworks/ember/index.js +0 -13
  96. package/dist/cjs/frameworks/ember/jsondoc.js +0 -87
  97. package/dist/cjs/frameworks/html/config.js +0 -26
  98. package/dist/cjs/frameworks/html/prepareForInline.js +0 -29
  99. package/dist/cjs/frameworks/html/sourceDecorator.js +0 -67
  100. package/dist/cjs/frameworks/react/config.js +0 -27
  101. package/dist/cjs/frameworks/react/extractArgTypes.js +0 -52
  102. package/dist/cjs/frameworks/react/extractProps.js +0 -77
  103. package/dist/cjs/frameworks/react/jsxDecorator.js +0 -277
  104. package/dist/cjs/frameworks/react/lib/captions.js +0 -18
  105. package/dist/cjs/frameworks/react/lib/componentTypes.js +0 -24
  106. package/dist/cjs/frameworks/react/lib/defaultValues/createDefaultValue.js +0 -81
  107. package/dist/cjs/frameworks/react/lib/defaultValues/createFromRawDefaultProp.js +0 -225
  108. package/dist/cjs/frameworks/react/lib/defaultValues/generateArray.js +0 -29
  109. package/dist/cjs/frameworks/react/lib/defaultValues/generateObject.js +0 -29
  110. package/dist/cjs/frameworks/react/lib/defaultValues/index.js +0 -35
  111. package/dist/cjs/frameworks/react/lib/defaultValues/prettyIdentifier.js +0 -34
  112. package/dist/cjs/frameworks/react/lib/generateCode.js +0 -89
  113. package/dist/cjs/frameworks/react/lib/index.js +0 -61
  114. package/dist/cjs/frameworks/react/lib/inspection/acornParser.js +0 -254
  115. package/dist/cjs/frameworks/react/lib/inspection/index.js +0 -35
  116. package/dist/cjs/frameworks/react/lib/inspection/inspectValue.js +0 -26
  117. package/dist/cjs/frameworks/react/lib/inspection/types.js +0 -19
  118. package/dist/cjs/frameworks/react/lib/isHtmlTag.js +0 -18
  119. package/dist/cjs/frameworks/react/propTypes/createType.js +0 -467
  120. package/dist/cjs/frameworks/react/propTypes/generateFuncSignature.js +0 -78
  121. package/dist/cjs/frameworks/react/propTypes/handleProp.js +0 -54
  122. package/dist/cjs/frameworks/react/propTypes/rawDefaultPropResolvers.js +0 -47
  123. package/dist/cjs/frameworks/react/propTypes/sortProps.js +0 -35
  124. package/dist/cjs/frameworks/react/react-argtypes.stories.js +0 -153
  125. package/dist/cjs/frameworks/react/typeScript/handleProp.js +0 -38
  126. package/dist/cjs/frameworks/svelte/config.js +0 -26
  127. package/dist/cjs/frameworks/svelte/extractArgTypes.js +0 -159
  128. package/dist/cjs/frameworks/svelte/extractComponentDescription.js +0 -21
  129. package/dist/cjs/frameworks/svelte/prepareForInline.js +0 -35
  130. package/dist/cjs/frameworks/svelte/preset.js +0 -54
  131. package/dist/cjs/frameworks/svelte/sample/MockButton.svelte +0 -45
  132. package/dist/cjs/frameworks/svelte/sourceDecorator.js +0 -262
  133. package/dist/cjs/frameworks/svelte/svelte-docgen-loader.js +0 -191
  134. package/dist/cjs/frameworks/vue/config.js +0 -26
  135. package/dist/cjs/frameworks/vue/extractArgTypes.js +0 -153
  136. package/dist/cjs/frameworks/vue/prepareForInline.js +0 -56
  137. package/dist/cjs/frameworks/vue/preset.js +0 -43
  138. package/dist/cjs/frameworks/vue/sourceDecorator.js +0 -343
  139. package/dist/cjs/frameworks/vue3/config.js +0 -22
  140. package/dist/cjs/frameworks/vue3/extractArgTypes.js +0 -62
  141. package/dist/cjs/frameworks/vue3/prepareForInline.js +0 -61
  142. package/dist/cjs/frameworks/vue3/preset.js +0 -43
  143. package/dist/cjs/frameworks/web-components/config.js +0 -30
  144. package/dist/cjs/frameworks/web-components/custom-elements.js +0 -163
  145. package/dist/cjs/frameworks/web-components/prepareForInline.js +0 -96
  146. package/dist/cjs/frameworks/web-components/sourceDecorator.js +0 -60
  147. package/dist/cjs/lib/convert/flow/convert.js +0 -112
  148. package/dist/cjs/lib/convert/flow/index.js +0 -35
  149. package/dist/cjs/lib/convert/flow/types.js +0 -1
  150. package/dist/cjs/lib/convert/index.js +0 -24
  151. package/dist/cjs/lib/convert/proptypes/convert.js +0 -135
  152. package/dist/cjs/lib/convert/proptypes/index.js +0 -35
  153. package/dist/cjs/lib/convert/proptypes/types.js +0 -1
  154. package/dist/cjs/lib/convert/typescript/convert.js +0 -82
  155. package/dist/cjs/lib/convert/typescript/index.js +0 -35
  156. package/dist/cjs/lib/convert/typescript/types.js +0 -1
  157. package/dist/cjs/lib/convert/utils.js +0 -18
  158. package/dist/cjs/lib/docgen/PropDef.js +0 -1
  159. package/dist/cjs/lib/docgen/createPropDef.js +0 -171
  160. package/dist/cjs/lib/docgen/extractDocgenProps.js +0 -113
  161. package/dist/cjs/lib/docgen/flow/createDefaultValue.js +0 -24
  162. package/dist/cjs/lib/docgen/flow/createPropDef.js +0 -30
  163. package/dist/cjs/lib/docgen/flow/createType.js +0 -119
  164. package/dist/cjs/lib/docgen/index.js +0 -48
  165. package/dist/cjs/lib/docgen/typeScript/createDefaultValue.js +0 -24
  166. package/dist/cjs/lib/docgen/typeScript/createPropDef.js +0 -28
  167. package/dist/cjs/lib/docgen/typeScript/createType.js +0 -30
  168. package/dist/cjs/lib/docgen/types.js +0 -17
  169. package/dist/cjs/lib/docgen/utils/defaultValue.js +0 -13
  170. package/dist/cjs/lib/docgen/utils/docgenInfo.js +0 -34
  171. package/dist/cjs/lib/docgen/utils/index.js +0 -48
  172. package/dist/cjs/lib/docgen/utils/string.js +0 -20
  173. package/dist/cjs/lib/index.js +0 -22
  174. package/dist/cjs/lib/jsdocParser.js +0 -229
  175. package/dist/cjs/lib/utils.js +0 -45
  176. package/dist/cjs/typings.d.js +0 -1
  177. package/dist/esm/frameworks/angular/compodoc.js +0 -347
  178. package/dist/esm/frameworks/angular/config.js +0 -18
  179. package/dist/esm/frameworks/angular/index.js +0 -1
  180. package/dist/esm/frameworks/angular/prepareForInline.js +0 -75
  181. package/dist/esm/frameworks/angular/sourceDecorator.js +0 -116
  182. package/dist/esm/frameworks/angular/types.js +0 -0
  183. package/dist/esm/frameworks/common/enhanceArgTypes.js +0 -11
  184. package/dist/esm/frameworks/common/preset.js +0 -161
  185. package/dist/esm/frameworks/ember/config.js +0 -8
  186. package/dist/esm/frameworks/ember/index.js +0 -1
  187. package/dist/esm/frameworks/ember/jsondoc.js +0 -66
  188. package/dist/esm/frameworks/html/config.js +0 -14
  189. package/dist/esm/frameworks/html/prepareForInline.js +0 -19
  190. package/dist/esm/frameworks/html/sourceDecorator.js +0 -56
  191. package/dist/esm/frameworks/react/config.js +0 -15
  192. package/dist/esm/frameworks/react/extractArgTypes.js +0 -38
  193. package/dist/esm/frameworks/react/extractProps.js +0 -53
  194. package/dist/esm/frameworks/react/jsxDecorator.js +0 -218
  195. package/dist/esm/frameworks/react/lib/captions.js +0 -6
  196. package/dist/esm/frameworks/react/lib/componentTypes.js +0 -9
  197. package/dist/esm/frameworks/react/lib/defaultValues/createDefaultValue.js +0 -67
  198. package/dist/esm/frameworks/react/lib/defaultValues/createFromRawDefaultProp.js +0 -191
  199. package/dist/esm/frameworks/react/lib/defaultValues/generateArray.js +0 -19
  200. package/dist/esm/frameworks/react/lib/defaultValues/generateObject.js +0 -19
  201. package/dist/esm/frameworks/react/lib/defaultValues/index.js +0 -2
  202. package/dist/esm/frameworks/react/lib/defaultValues/prettyIdentifier.js +0 -22
  203. package/dist/esm/frameworks/react/lib/generateCode.js +0 -68
  204. package/dist/esm/frameworks/react/lib/index.js +0 -4
  205. package/dist/esm/frameworks/react/lib/inspection/acornParser.js +0 -213
  206. package/dist/esm/frameworks/react/lib/inspection/index.js +0 -2
  207. package/dist/esm/frameworks/react/lib/inspection/inspectValue.js +0 -16
  208. package/dist/esm/frameworks/react/lib/inspection/types.js +0 -12
  209. package/dist/esm/frameworks/react/lib/isHtmlTag.js +0 -6
  210. package/dist/esm/frameworks/react/propTypes/createType.js +0 -448
  211. package/dist/esm/frameworks/react/propTypes/generateFuncSignature.js +0 -62
  212. package/dist/esm/frameworks/react/propTypes/handleProp.js +0 -39
  213. package/dist/esm/frameworks/react/propTypes/rawDefaultPropResolvers.js +0 -32
  214. package/dist/esm/frameworks/react/propTypes/sortProps.js +0 -23
  215. package/dist/esm/frameworks/react/react-argtypes.stories.js +0 -122
  216. package/dist/esm/frameworks/react/typeScript/handleProp.js +0 -27
  217. package/dist/esm/frameworks/svelte/HOC.svelte +0 -7
  218. package/dist/esm/frameworks/svelte/config.js +0 -13
  219. package/dist/esm/frameworks/svelte/extractArgTypes.js +0 -138
  220. package/dist/esm/frameworks/svelte/extractComponentDescription.js +0 -12
  221. package/dist/esm/frameworks/svelte/prepareForInline.js +0 -20
  222. package/dist/esm/frameworks/svelte/preset.js +0 -42
  223. package/dist/esm/frameworks/svelte/sample/MockButton.svelte +0 -45
  224. package/dist/esm/frameworks/svelte/sourceDecorator.js +0 -232
  225. package/dist/esm/frameworks/svelte/svelte-docgen-loader.js +0 -142
  226. package/dist/esm/frameworks/vue/config.js +0 -13
  227. package/dist/esm/frameworks/vue/extractArgTypes.js +0 -128
  228. package/dist/esm/frameworks/vue/prepareForInline.js +0 -39
  229. package/dist/esm/frameworks/vue/preset.js +0 -31
  230. package/dist/esm/frameworks/vue/sourceDecorator.js +0 -292
  231. package/dist/esm/frameworks/vue3/config.js +0 -11
  232. package/dist/esm/frameworks/vue3/extractArgTypes.js +0 -45
  233. package/dist/esm/frameworks/vue3/prepareForInline.js +0 -22
  234. package/dist/esm/frameworks/vue3/preset.js +0 -31
  235. package/dist/esm/frameworks/web-components/config.js +0 -17
  236. package/dist/esm/frameworks/web-components/custom-elements.js +0 -139
  237. package/dist/esm/frameworks/web-components/prepareForInline.js +0 -74
  238. package/dist/esm/frameworks/web-components/sourceDecorator.js +0 -50
  239. package/dist/esm/lib/convert/flow/convert.js +0 -98
  240. package/dist/esm/lib/convert/flow/index.js +0 -2
  241. package/dist/esm/lib/convert/flow/types.js +0 -0
  242. package/dist/esm/lib/convert/index.js +0 -12
  243. package/dist/esm/lib/convert/proptypes/convert.js +0 -116
  244. package/dist/esm/lib/convert/proptypes/index.js +0 -2
  245. package/dist/esm/lib/convert/proptypes/types.js +0 -0
  246. package/dist/esm/lib/convert/typescript/convert.js +0 -70
  247. package/dist/esm/lib/convert/typescript/index.js +0 -2
  248. package/dist/esm/lib/convert/typescript/types.js +0 -0
  249. package/dist/esm/lib/convert/utils.js +0 -6
  250. package/dist/esm/lib/docgen/PropDef.js +0 -0
  251. package/dist/esm/lib/docgen/createPropDef.js +0 -141
  252. package/dist/esm/lib/docgen/extractDocgenProps.js +0 -87
  253. package/dist/esm/lib/docgen/flow/createDefaultValue.js +0 -14
  254. package/dist/esm/lib/docgen/flow/createPropDef.js +0 -17
  255. package/dist/esm/lib/docgen/flow/createType.js +0 -106
  256. package/dist/esm/lib/docgen/index.js +0 -3
  257. package/dist/esm/lib/docgen/typeScript/createDefaultValue.js +0 -15
  258. package/dist/esm/lib/docgen/typeScript/createPropDef.js +0 -15
  259. package/dist/esm/lib/docgen/typeScript/createType.js +0 -19
  260. package/dist/esm/lib/docgen/types.js +0 -10
  261. package/dist/esm/lib/docgen/utils/defaultValue.js +0 -6
  262. package/dist/esm/lib/docgen/utils/docgenInfo.js +0 -18
  263. package/dist/esm/lib/docgen/utils/index.js +0 -3
  264. package/dist/esm/lib/docgen/utils/string.js +0 -11
  265. package/dist/esm/lib/index.js +0 -1
  266. package/dist/esm/lib/jsdocParser.js +0 -207
  267. package/dist/esm/lib/utils.js +0 -25
  268. package/dist/esm/typings.d.js +0 -0
  269. package/dist/modern/frameworks/angular/compodoc.js +0 -296
  270. package/dist/modern/frameworks/angular/config.js +0 -18
  271. package/dist/modern/frameworks/angular/index.js +0 -1
  272. package/dist/modern/frameworks/angular/prepareForInline.js +0 -36
  273. package/dist/modern/frameworks/angular/sourceDecorator.js +0 -81
  274. package/dist/modern/frameworks/angular/types.js +0 -0
  275. package/dist/modern/frameworks/common/config.js +0 -10
  276. package/dist/modern/frameworks/common/enhanceArgTypes.js +0 -16
  277. package/dist/modern/frameworks/ember/config.js +0 -8
  278. package/dist/modern/frameworks/ember/index.js +0 -1
  279. package/dist/modern/frameworks/ember/jsondoc.js +0 -57
  280. package/dist/modern/frameworks/html/config.js +0 -14
  281. package/dist/modern/frameworks/html/prepareForInline.js +0 -17
  282. package/dist/modern/frameworks/html/sourceDecorator.js +0 -56
  283. package/dist/modern/frameworks/react/config.js +0 -13
  284. package/dist/modern/frameworks/react/extractArgTypes.js +0 -38
  285. package/dist/modern/frameworks/react/extractProps.js +0 -41
  286. package/dist/modern/frameworks/react/jsxDecorator.js +0 -176
  287. package/dist/modern/frameworks/react/lib/captions.js +0 -6
  288. package/dist/modern/frameworks/react/lib/componentTypes.js +0 -2
  289. package/dist/modern/frameworks/react/lib/defaultValues/createDefaultValue.js +0 -72
  290. package/dist/modern/frameworks/react/lib/defaultValues/createFromRawDefaultProp.js +0 -181
  291. package/dist/modern/frameworks/react/lib/defaultValues/generateArray.js +0 -21
  292. package/dist/modern/frameworks/react/lib/defaultValues/generateObject.js +0 -21
  293. package/dist/modern/frameworks/react/lib/defaultValues/index.js +0 -2
  294. package/dist/modern/frameworks/react/lib/defaultValues/prettyIdentifier.js +0 -24
  295. package/dist/modern/frameworks/react/lib/generateCode.js +0 -59
  296. package/dist/modern/frameworks/react/lib/index.js +0 -4
  297. package/dist/modern/frameworks/react/lib/inspection/acornParser.js +0 -212
  298. package/dist/modern/frameworks/react/lib/inspection/index.js +0 -2
  299. package/dist/modern/frameworks/react/lib/inspection/inspectValue.js +0 -15
  300. package/dist/modern/frameworks/react/lib/inspection/types.js +0 -12
  301. package/dist/modern/frameworks/react/lib/isHtmlTag.js +0 -4
  302. package/dist/modern/frameworks/react/propTypes/createType.js +0 -446
  303. package/dist/modern/frameworks/react/propTypes/generateFuncSignature.js +0 -57
  304. package/dist/modern/frameworks/react/propTypes/handleProp.js +0 -39
  305. package/dist/modern/frameworks/react/propTypes/rawDefaultPropResolvers.js +0 -31
  306. package/dist/modern/frameworks/react/propTypes/sortProps.js +0 -14
  307. package/dist/modern/frameworks/react/react-argtypes.stories.js +0 -78
  308. package/dist/modern/frameworks/react/typeScript/handleProp.js +0 -28
  309. package/dist/modern/frameworks/svelte/HOC.svelte +0 -7
  310. package/dist/modern/frameworks/svelte/config.js +0 -13
  311. package/dist/modern/frameworks/svelte/extractArgTypes.js +0 -118
  312. package/dist/modern/frameworks/svelte/extractComponentDescription.js +0 -10
  313. package/dist/modern/frameworks/svelte/prepareForInline.js +0 -18
  314. package/dist/modern/frameworks/svelte/preset.js +0 -11
  315. package/dist/modern/frameworks/svelte/sample/MockButton.svelte +0 -45
  316. package/dist/modern/frameworks/svelte/sourceDecorator.js +0 -187
  317. package/dist/modern/frameworks/svelte/svelte-docgen-loader.js +0 -89
  318. package/dist/modern/frameworks/vue/config.js +0 -13
  319. package/dist/modern/frameworks/vue/extractArgTypes.js +0 -103
  320. package/dist/modern/frameworks/vue/prepareForInline.js +0 -40
  321. package/dist/modern/frameworks/vue/preset.js +0 -24
  322. package/dist/modern/frameworks/vue/sourceDecorator.js +0 -195
  323. package/dist/modern/frameworks/vue3/config.js +0 -11
  324. package/dist/modern/frameworks/vue3/extractArgTypes.js +0 -43
  325. package/dist/modern/frameworks/vue3/prepareForInline.js +0 -22
  326. package/dist/modern/frameworks/vue3/preset.js +0 -24
  327. package/dist/modern/frameworks/web-components/config.js +0 -17
  328. package/dist/modern/frameworks/web-components/custom-elements.js +0 -125
  329. package/dist/modern/frameworks/web-components/prepareForInline.js +0 -23
  330. package/dist/modern/frameworks/web-components/sourceDecorator.js +0 -47
  331. package/dist/modern/lib/convert/flow/convert.js +0 -89
  332. package/dist/modern/lib/convert/flow/index.js +0 -2
  333. package/dist/modern/lib/convert/flow/types.js +0 -0
  334. package/dist/modern/lib/convert/index.js +0 -14
  335. package/dist/modern/lib/convert/proptypes/convert.js +0 -102
  336. package/dist/modern/lib/convert/proptypes/index.js +0 -2
  337. package/dist/modern/lib/convert/proptypes/types.js +0 -0
  338. package/dist/modern/lib/convert/typescript/convert.js +0 -67
  339. package/dist/modern/lib/convert/typescript/index.js +0 -2
  340. package/dist/modern/lib/convert/typescript/types.js +0 -0
  341. package/dist/modern/lib/convert/utils.js +0 -2
  342. package/dist/modern/lib/docgen/PropDef.js +0 -0
  343. package/dist/modern/lib/docgen/createPropDef.js +0 -142
  344. package/dist/modern/lib/docgen/extractDocgenProps.js +0 -80
  345. package/dist/modern/lib/docgen/flow/createDefaultValue.js +0 -15
  346. package/dist/modern/lib/docgen/flow/createPropDef.js +0 -17
  347. package/dist/modern/lib/docgen/flow/createType.js +0 -103
  348. package/dist/modern/lib/docgen/index.js +0 -3
  349. package/dist/modern/lib/docgen/typeScript/createDefaultValue.js +0 -17
  350. package/dist/modern/lib/docgen/typeScript/createPropDef.js +0 -15
  351. package/dist/modern/lib/docgen/typeScript/createType.js +0 -16
  352. package/dist/modern/lib/docgen/types.js +0 -10
  353. package/dist/modern/lib/docgen/utils/defaultValue.js +0 -4
  354. package/dist/modern/lib/docgen/utils/docgenInfo.js +0 -14
  355. package/dist/modern/lib/docgen/utils/index.js +0 -3
  356. package/dist/modern/lib/docgen/utils/string.js +0 -11
  357. package/dist/modern/lib/index.js +0 -1
  358. package/dist/modern/lib/jsdocParser.js +0 -195
  359. package/dist/modern/lib/utils.js +0 -21
  360. package/dist/modern/typings.d.js +0 -0
  361. package/dist/ts3.4/frameworks/angular/compodoc.d.ts +0 -18
  362. package/dist/ts3.4/frameworks/angular/config.d.ts +0 -15
  363. package/dist/ts3.4/frameworks/angular/index.d.ts +0 -1
  364. package/dist/ts3.4/frameworks/angular/prepareForInline.d.ts +0 -7
  365. package/dist/ts3.4/frameworks/angular/sourceDecorator.d.ts +0 -9
  366. package/dist/ts3.4/frameworks/angular/types.d.ts +0 -102
  367. package/dist/ts3.4/frameworks/common/config.d.ts +0 -10
  368. package/dist/ts3.4/frameworks/common/enhanceArgTypes.d.ts +0 -2
  369. package/dist/ts3.4/frameworks/common/preset.d.ts +0 -1
  370. package/dist/ts3.4/frameworks/html/config.d.ts +0 -14
  371. package/dist/ts3.4/frameworks/html/prepareForInline.d.ts +0 -2
  372. package/dist/ts3.4/frameworks/html/sourceDecorator.d.ts +0 -3
  373. package/dist/ts3.4/frameworks/react/config.d.ts +0 -12
  374. package/dist/ts3.4/frameworks/react/extractArgTypes.d.ts +0 -2
  375. package/dist/ts3.4/frameworks/react/extractProps.d.ts +0 -5
  376. package/dist/ts3.4/frameworks/react/jsxDecorator.d.ts +0 -23
  377. package/dist/ts3.4/frameworks/react/lib/captions.d.ts +0 -6
  378. package/dist/ts3.4/frameworks/react/lib/componentTypes.d.ts +0 -2
  379. package/dist/ts3.4/frameworks/react/lib/defaultValues/createDefaultValue.d.ts +0 -2
  380. package/dist/ts3.4/frameworks/react/lib/defaultValues/createFromRawDefaultProp.d.ts +0 -12
  381. package/dist/ts3.4/frameworks/react/lib/defaultValues/generateArray.d.ts +0 -3
  382. package/dist/ts3.4/frameworks/react/lib/defaultValues/generateObject.d.ts +0 -3
  383. package/dist/ts3.4/frameworks/react/lib/defaultValues/index.d.ts +0 -2
  384. package/dist/ts3.4/frameworks/react/lib/defaultValues/prettyIdentifier.d.ts +0 -4
  385. package/dist/ts3.4/frameworks/react/lib/generateCode.d.ts +0 -3
  386. package/dist/ts3.4/frameworks/react/lib/index.d.ts +0 -4
  387. package/dist/ts3.4/frameworks/react/lib/inspection/acornParser.d.ts +0 -7
  388. package/dist/ts3.4/frameworks/react/lib/inspection/index.d.ts +0 -2
  389. package/dist/ts3.4/frameworks/react/lib/inspection/inspectValue.d.ts +0 -2
  390. package/dist/ts3.4/frameworks/react/lib/inspection/types.d.ts +0 -50
  391. package/dist/ts3.4/frameworks/react/lib/isHtmlTag.d.ts +0 -1
  392. package/dist/ts3.4/frameworks/react/propTypes/createType.d.ts +0 -3
  393. package/dist/ts3.4/frameworks/react/propTypes/generateFuncSignature.d.ts +0 -4
  394. package/dist/ts3.4/frameworks/react/propTypes/handleProp.d.ts +0 -4
  395. package/dist/ts3.4/frameworks/react/propTypes/rawDefaultPropResolvers.d.ts +0 -1
  396. package/dist/ts3.4/frameworks/react/propTypes/sortProps.d.ts +0 -3
  397. package/dist/ts3.4/frameworks/react/typeScript/handleProp.d.ts +0 -3
  398. package/dist/ts3.4/frameworks/svelte/config.d.ts +0 -11
  399. package/dist/ts3.4/frameworks/svelte/extractArgTypes.d.ts +0 -5
  400. package/dist/ts3.4/frameworks/svelte/extractComponentDescription.d.ts +0 -2
  401. package/dist/ts3.4/frameworks/svelte/prepareForInline.d.ts +0 -3
  402. package/dist/ts3.4/frameworks/svelte/preset.d.ts +0 -3
  403. package/dist/ts3.4/frameworks/svelte/sourceDecorator.d.ts +0 -16
  404. package/dist/ts3.4/frameworks/svelte/svelte-docgen-loader.d.ts +0 -5
  405. package/dist/ts3.4/frameworks/vue/config.d.ts +0 -11
  406. package/dist/ts3.4/frameworks/vue/extractArgTypes.d.ts +0 -2
  407. package/dist/ts3.4/frameworks/vue/prepareForInline.d.ts +0 -4
  408. package/dist/ts3.4/frameworks/vue/preset.d.ts +0 -2
  409. package/dist/ts3.4/frameworks/vue/sourceDecorator.d.ts +0 -5
  410. package/dist/ts3.4/frameworks/vue3/config.d.ts +0 -10
  411. package/dist/ts3.4/frameworks/vue3/extractArgTypes.d.ts +0 -2
  412. package/dist/ts3.4/frameworks/vue3/prepareForInline.d.ts +0 -4
  413. package/dist/ts3.4/frameworks/vue3/preset.d.ts +0 -2
  414. package/dist/ts3.4/frameworks/web-components/config.d.ts +0 -18
  415. package/dist/ts3.4/frameworks/web-components/custom-elements.d.ts +0 -36
  416. package/dist/ts3.4/frameworks/web-components/prepareForInline.d.ts +0 -4
  417. package/dist/ts3.4/frameworks/web-components/sourceDecorator.d.ts +0 -3
  418. package/dist/ts3.4/lib/convert/flow/convert.d.ts +0 -3
  419. package/dist/ts3.4/lib/convert/flow/index.d.ts +0 -2
  420. package/dist/ts3.4/lib/convert/flow/types.d.ts +0 -43
  421. package/dist/ts3.4/lib/convert/index.d.ts +0 -2
  422. package/dist/ts3.4/lib/convert/proptypes/convert.d.ts +0 -3
  423. package/dist/ts3.4/lib/convert/proptypes/index.d.ts +0 -2
  424. package/dist/ts3.4/lib/convert/proptypes/types.d.ts +0 -11
  425. package/dist/ts3.4/lib/convert/typescript/convert.d.ts +0 -3
  426. package/dist/ts3.4/lib/convert/typescript/index.d.ts +0 -2
  427. package/dist/ts3.4/lib/convert/typescript/types.d.ts +0 -39
  428. package/dist/ts3.4/lib/convert/utils.d.ts +0 -1
  429. package/dist/ts3.4/lib/docgen/PropDef.d.ts +0 -26
  430. package/dist/ts3.4/lib/docgen/createPropDef.d.ts +0 -8
  431. package/dist/ts3.4/lib/docgen/extractDocgenProps.d.ts +0 -14
  432. package/dist/ts3.4/lib/docgen/flow/createDefaultValue.d.ts +0 -3
  433. package/dist/ts3.4/lib/docgen/flow/createPropDef.d.ts +0 -2
  434. package/dist/ts3.4/lib/docgen/flow/createType.d.ts +0 -3
  435. package/dist/ts3.4/lib/docgen/index.d.ts +0 -3
  436. package/dist/ts3.4/lib/docgen/typeScript/createDefaultValue.d.ts +0 -3
  437. package/dist/ts3.4/lib/docgen/typeScript/createPropDef.d.ts +0 -2
  438. package/dist/ts3.4/lib/docgen/typeScript/createType.d.ts +0 -3
  439. package/dist/ts3.4/lib/docgen/types.d.ts +0 -46
  440. package/dist/ts3.4/lib/docgen/utils/defaultValue.d.ts +0 -1
  441. package/dist/ts3.4/lib/docgen/utils/docgenInfo.d.ts +0 -5
  442. package/dist/ts3.4/lib/docgen/utils/index.d.ts +0 -3
  443. package/dist/ts3.4/lib/docgen/utils/string.d.ts +0 -1
  444. package/dist/ts3.4/lib/index.d.ts +0 -1
  445. package/dist/ts3.4/lib/jsdocParser.d.ts +0 -28
  446. package/dist/ts3.4/lib/utils.d.ts +0 -7
  447. package/dist/ts3.9/frameworks/angular/compodoc.d.ts +0 -18
  448. package/dist/ts3.9/frameworks/angular/config.d.ts +0 -15
  449. package/dist/ts3.9/frameworks/angular/index.d.ts +0 -1
  450. package/dist/ts3.9/frameworks/angular/prepareForInline.d.ts +0 -7
  451. package/dist/ts3.9/frameworks/angular/sourceDecorator.d.ts +0 -9
  452. package/dist/ts3.9/frameworks/angular/types.d.ts +0 -102
  453. package/dist/ts3.9/frameworks/common/config.d.ts +0 -10
  454. package/dist/ts3.9/frameworks/common/enhanceArgTypes.d.ts +0 -2
  455. package/dist/ts3.9/frameworks/common/preset.d.ts +0 -1
  456. package/dist/ts3.9/frameworks/html/config.d.ts +0 -14
  457. package/dist/ts3.9/frameworks/html/prepareForInline.d.ts +0 -2
  458. package/dist/ts3.9/frameworks/html/sourceDecorator.d.ts +0 -3
  459. package/dist/ts3.9/frameworks/react/config.d.ts +0 -12
  460. package/dist/ts3.9/frameworks/react/extractArgTypes.d.ts +0 -2
  461. package/dist/ts3.9/frameworks/react/extractProps.d.ts +0 -5
  462. package/dist/ts3.9/frameworks/react/jsxDecorator.d.ts +0 -23
  463. package/dist/ts3.9/frameworks/react/lib/captions.d.ts +0 -6
  464. package/dist/ts3.9/frameworks/react/lib/componentTypes.d.ts +0 -2
  465. package/dist/ts3.9/frameworks/react/lib/defaultValues/createDefaultValue.d.ts +0 -2
  466. package/dist/ts3.9/frameworks/react/lib/defaultValues/createFromRawDefaultProp.d.ts +0 -12
  467. package/dist/ts3.9/frameworks/react/lib/defaultValues/generateArray.d.ts +0 -3
  468. package/dist/ts3.9/frameworks/react/lib/defaultValues/generateObject.d.ts +0 -3
  469. package/dist/ts3.9/frameworks/react/lib/defaultValues/index.d.ts +0 -2
  470. package/dist/ts3.9/frameworks/react/lib/defaultValues/prettyIdentifier.d.ts +0 -4
  471. package/dist/ts3.9/frameworks/react/lib/generateCode.d.ts +0 -3
  472. package/dist/ts3.9/frameworks/react/lib/index.d.ts +0 -4
  473. package/dist/ts3.9/frameworks/react/lib/inspection/acornParser.d.ts +0 -7
  474. package/dist/ts3.9/frameworks/react/lib/inspection/index.d.ts +0 -2
  475. package/dist/ts3.9/frameworks/react/lib/inspection/inspectValue.d.ts +0 -2
  476. package/dist/ts3.9/frameworks/react/lib/inspection/types.d.ts +0 -50
  477. package/dist/ts3.9/frameworks/react/lib/isHtmlTag.d.ts +0 -1
  478. package/dist/ts3.9/frameworks/react/propTypes/createType.d.ts +0 -3
  479. package/dist/ts3.9/frameworks/react/propTypes/generateFuncSignature.d.ts +0 -4
  480. package/dist/ts3.9/frameworks/react/propTypes/handleProp.d.ts +0 -4
  481. package/dist/ts3.9/frameworks/react/propTypes/rawDefaultPropResolvers.d.ts +0 -1
  482. package/dist/ts3.9/frameworks/react/propTypes/sortProps.d.ts +0 -3
  483. package/dist/ts3.9/frameworks/react/typeScript/handleProp.d.ts +0 -3
  484. package/dist/ts3.9/frameworks/svelte/config.d.ts +0 -11
  485. package/dist/ts3.9/frameworks/svelte/extractArgTypes.d.ts +0 -5
  486. package/dist/ts3.9/frameworks/svelte/extractComponentDescription.d.ts +0 -2
  487. package/dist/ts3.9/frameworks/svelte/prepareForInline.d.ts +0 -3
  488. package/dist/ts3.9/frameworks/svelte/preset.d.ts +0 -3
  489. package/dist/ts3.9/frameworks/svelte/sourceDecorator.d.ts +0 -16
  490. package/dist/ts3.9/frameworks/svelte/svelte-docgen-loader.d.ts +0 -5
  491. package/dist/ts3.9/frameworks/vue/config.d.ts +0 -11
  492. package/dist/ts3.9/frameworks/vue/extractArgTypes.d.ts +0 -2
  493. package/dist/ts3.9/frameworks/vue/prepareForInline.d.ts +0 -4
  494. package/dist/ts3.9/frameworks/vue/preset.d.ts +0 -2
  495. package/dist/ts3.9/frameworks/vue/sourceDecorator.d.ts +0 -5
  496. package/dist/ts3.9/frameworks/vue3/config.d.ts +0 -10
  497. package/dist/ts3.9/frameworks/vue3/extractArgTypes.d.ts +0 -2
  498. package/dist/ts3.9/frameworks/vue3/prepareForInline.d.ts +0 -4
  499. package/dist/ts3.9/frameworks/vue3/preset.d.ts +0 -2
  500. package/dist/ts3.9/frameworks/web-components/config.d.ts +0 -18
  501. package/dist/ts3.9/frameworks/web-components/custom-elements.d.ts +0 -35
  502. package/dist/ts3.9/frameworks/web-components/prepareForInline.d.ts +0 -4
  503. package/dist/ts3.9/frameworks/web-components/sourceDecorator.d.ts +0 -3
  504. package/dist/ts3.9/lib/convert/flow/convert.d.ts +0 -3
  505. package/dist/ts3.9/lib/convert/flow/index.d.ts +0 -2
  506. package/dist/ts3.9/lib/convert/flow/types.d.ts +0 -43
  507. package/dist/ts3.9/lib/convert/index.d.ts +0 -2
  508. package/dist/ts3.9/lib/convert/proptypes/convert.d.ts +0 -3
  509. package/dist/ts3.9/lib/convert/proptypes/index.d.ts +0 -2
  510. package/dist/ts3.9/lib/convert/proptypes/types.d.ts +0 -11
  511. package/dist/ts3.9/lib/convert/typescript/convert.d.ts +0 -3
  512. package/dist/ts3.9/lib/convert/typescript/index.d.ts +0 -2
  513. package/dist/ts3.9/lib/convert/typescript/types.d.ts +0 -39
  514. package/dist/ts3.9/lib/convert/utils.d.ts +0 -1
  515. package/dist/ts3.9/lib/docgen/PropDef.d.ts +0 -26
  516. package/dist/ts3.9/lib/docgen/createPropDef.d.ts +0 -8
  517. package/dist/ts3.9/lib/docgen/extractDocgenProps.d.ts +0 -14
  518. package/dist/ts3.9/lib/docgen/flow/createDefaultValue.d.ts +0 -3
  519. package/dist/ts3.9/lib/docgen/flow/createPropDef.d.ts +0 -2
  520. package/dist/ts3.9/lib/docgen/flow/createType.d.ts +0 -3
  521. package/dist/ts3.9/lib/docgen/index.d.ts +0 -3
  522. package/dist/ts3.9/lib/docgen/typeScript/createDefaultValue.d.ts +0 -3
  523. package/dist/ts3.9/lib/docgen/typeScript/createPropDef.d.ts +0 -2
  524. package/dist/ts3.9/lib/docgen/typeScript/createType.d.ts +0 -3
  525. package/dist/ts3.9/lib/docgen/types.d.ts +0 -46
  526. package/dist/ts3.9/lib/docgen/utils/defaultValue.d.ts +0 -1
  527. package/dist/ts3.9/lib/docgen/utils/docgenInfo.d.ts +0 -5
  528. package/dist/ts3.9/lib/docgen/utils/index.d.ts +0 -3
  529. package/dist/ts3.9/lib/docgen/utils/string.d.ts +0 -1
  530. package/dist/ts3.9/lib/index.d.ts +0 -1
  531. package/dist/ts3.9/lib/jsdocParser.d.ts +0 -28
  532. package/dist/ts3.9/lib/utils.d.ts +0 -7
@@ -1,195 +0,0 @@
1
- import doctrine from 'doctrine';
2
-
3
- function containsJsDoc(value) {
4
- return value != null && value.includes('@');
5
- }
6
-
7
- function parse(content, tags) {
8
- let ast;
9
-
10
- try {
11
- ast = doctrine.parse(content, {
12
- tags,
13
- sloppy: true
14
- });
15
- } catch (e) {
16
- // eslint-disable-next-line no-console
17
- console.error(e);
18
- throw new Error('Cannot parse JSDoc tags.');
19
- }
20
-
21
- return ast;
22
- }
23
-
24
- const DEFAULT_OPTIONS = {
25
- tags: ['param', 'arg', 'argument', 'returns', 'ignore']
26
- };
27
- export const parseJsDoc = (value, options = DEFAULT_OPTIONS) => {
28
- if (!containsJsDoc(value)) {
29
- return {
30
- includesJsDoc: false,
31
- ignore: false
32
- };
33
- }
34
-
35
- const jsDocAst = parse(value, options.tags);
36
- const extractedTags = extractJsDocTags(jsDocAst);
37
-
38
- if (extractedTags.ignore) {
39
- // There is no point in doing other stuff since this prop will not be rendered.
40
- return {
41
- includesJsDoc: true,
42
- ignore: true
43
- };
44
- }
45
-
46
- return {
47
- includesJsDoc: true,
48
- ignore: false,
49
- // Always use the parsed description to ensure JSDoc is removed from the description.
50
- description: jsDocAst.description,
51
- extractedTags
52
- };
53
- };
54
-
55
- function extractJsDocTags(ast) {
56
- const extractedTags = {
57
- params: null,
58
- returns: null,
59
- ignore: false
60
- };
61
-
62
- for (let i = 0; i < ast.tags.length; i += 1) {
63
- const tag = ast.tags[i];
64
-
65
- if (tag.title === 'ignore') {
66
- extractedTags.ignore = true; // Once we reach an @ignore tag, there is no point in parsing the other tags since we will not render the prop.
67
-
68
- break;
69
- } else {
70
- switch (tag.title) {
71
- // arg & argument are aliases for param.
72
- case 'param':
73
- case 'arg':
74
- case 'argument':
75
- {
76
- const paramTag = extractParam(tag);
77
-
78
- if (paramTag != null) {
79
- if (extractedTags.params == null) {
80
- extractedTags.params = [];
81
- }
82
-
83
- extractedTags.params.push(paramTag);
84
- }
85
-
86
- break;
87
- }
88
-
89
- case 'returns':
90
- {
91
- const returnsTag = extractReturns(tag);
92
-
93
- if (returnsTag != null) {
94
- extractedTags.returns = returnsTag;
95
- }
96
-
97
- break;
98
- }
99
-
100
- default:
101
- break;
102
- }
103
- }
104
- }
105
-
106
- return extractedTags;
107
- }
108
-
109
- function extractParam(tag) {
110
- const paramName = tag.name; // When the @param doesn't have a name but have a type and a description, "null-null" is returned.
111
-
112
- if (paramName != null && paramName !== 'null-null') {
113
- return {
114
- name: tag.name,
115
- type: tag.type,
116
- description: tag.description,
117
- getPrettyName: () => {
118
- if (paramName.includes('null')) {
119
- // There is a few cases in which the returned param name contains "null".
120
- // - @param {SyntheticEvent} event- Original SyntheticEvent
121
- // - @param {SyntheticEvent} event.\n@returns {string}
122
- return paramName.replace('-null', '').replace('.null', '');
123
- }
124
-
125
- return tag.name;
126
- },
127
- getTypeName: () => {
128
- return tag.type != null ? extractTypeName(tag.type) : null;
129
- }
130
- };
131
- }
132
-
133
- return null;
134
- }
135
-
136
- function extractReturns(tag) {
137
- if (tag.type != null) {
138
- return {
139
- type: tag.type,
140
- description: tag.description,
141
- getTypeName: () => {
142
- return extractTypeName(tag.type);
143
- }
144
- };
145
- }
146
-
147
- return null;
148
- }
149
-
150
- function extractTypeName(type) {
151
- if (type.type === 'NameExpression') {
152
- return type.name;
153
- }
154
-
155
- if (type.type === 'RecordType') {
156
- const recordFields = type.fields.map(field => {
157
- if (field.value != null) {
158
- const valueTypeName = extractTypeName(field.value);
159
- return `${field.key}: ${valueTypeName}`;
160
- }
161
-
162
- return field.key;
163
- });
164
- return `({${recordFields.join(', ')}})`;
165
- }
166
-
167
- if (type.type === 'UnionType') {
168
- const unionElements = type.elements.map(extractTypeName);
169
- return `(${unionElements.join('|')})`;
170
- } // Only support untyped array: []. Might add more support later if required.
171
-
172
-
173
- if (type.type === 'ArrayType') {
174
- return '[]';
175
- }
176
-
177
- if (type.type === 'TypeApplication') {
178
- if (type.expression != null) {
179
- if (type.expression.name === 'Array') {
180
- const arrayType = extractTypeName(type.applications[0]);
181
- return `${arrayType}[]`;
182
- }
183
- }
184
- }
185
-
186
- if (type.type === 'NullableType' || type.type === 'NonNullableType' || type.type === 'OptionalType') {
187
- return extractTypeName(type.expression);
188
- }
189
-
190
- if (type.type === 'AllLiteral') {
191
- return 'any';
192
- }
193
-
194
- return null;
195
- }
@@ -1,21 +0,0 @@
1
- export const MAX_TYPE_SUMMARY_LENGTH = 90;
2
- export const MAX_DEFAULT_VALUE_SUMMARY_LENGTH = 50;
3
- export function isTooLongForTypeSummary(value) {
4
- return value.length > MAX_TYPE_SUMMARY_LENGTH;
5
- }
6
- export function isTooLongForDefaultValueSummary(value) {
7
- return value.length > MAX_DEFAULT_VALUE_SUMMARY_LENGTH;
8
- }
9
- export function createSummaryValue(summary, detail) {
10
- if (summary === detail) {
11
- return {
12
- summary
13
- };
14
- }
15
-
16
- return {
17
- summary,
18
- detail
19
- };
20
- }
21
- export const normalizeNewlines = string => string.replace(/\\r\\n/g, '\\n');
File without changes
@@ -1,18 +0,0 @@
1
- import { ArgTypes } from '@storybook/api';
2
- import { Class, CompodocJson, Component, Injectable, Method, Pipe, Property, Directive } from './types';
3
- export declare const isMethod: (methodOrProp: Method | Property) => methodOrProp is Method;
4
- export declare const setCompodocJson: (compodocJson: CompodocJson) => void;
5
- export declare const getCompodocJson: () => CompodocJson;
6
- export declare const checkValidComponentOrDirective: (component: Component | Directive) => void;
7
- export declare const checkValidCompodocJson: (compodocJson: CompodocJson) => void;
8
- export declare const findComponentByName: (name: string, compodocJson: CompodocJson) => Class | Injectable | Pipe | Directive;
9
- export declare const extractType: (property: Property, defaultValue: any) => {
10
- name: string;
11
- value?: undefined;
12
- } | {
13
- name: string;
14
- value: any[];
15
- };
16
- export declare const extractArgTypesFromData: (componentData: Class | Directive | Injectable | Pipe) => ArgTypes;
17
- export declare const extractArgTypes: (component: Component | Directive) => ArgTypes;
18
- export declare const extractComponentDescription: (component: Component | Directive) => string;
@@ -1,15 +0,0 @@
1
- /// <reference types="react" />
2
- import { SourceType } from '../../shared';
3
- export declare const parameters: {
4
- docs: {
5
- inlineStories: boolean;
6
- prepareForInline: (storyFn: import("@storybook/csf").PartialStoryFn<import("@storybook/angular").AngularFramework, import("@storybook/csf").Args>, { id, parameters, component }: import("@storybook/angular").StoryContext) => import("react").DetailedReactHTMLElement<import("react").HTMLAttributes<undefined>, undefined>;
7
- extractArgTypes: (component: import("./types").Directive) => import("@storybook/api").ArgTypes;
8
- extractComponentDescription: (component: import("./types").Directive) => string;
9
- source: {
10
- type: SourceType;
11
- language: string;
12
- };
13
- };
14
- };
15
- export declare const decorators: ((storyFn: import("@storybook/csf").PartialStoryFn<import("@storybook/angular").AngularFramework, import("@storybook/csf").Args>, context: import("@storybook/angular").StoryContext) => import("@storybook/angular").IStory)[];
@@ -1 +0,0 @@
1
- export * from './compodoc';
@@ -1,7 +0,0 @@
1
- import React from 'react';
2
- import { AngularFramework, StoryContext } from '@storybook/angular';
3
- import { PartialStoryFn } from '@storybook/csf';
4
- /**
5
- * Uses the angular renderer to generate a story. Uses p-limit to run synchronously
6
- */
7
- export declare const prepareForInline: (storyFn: PartialStoryFn<AngularFramework>, { id, parameters, component }: StoryContext) => React.DetailedReactHTMLElement<React.HTMLAttributes<undefined>, undefined>;
@@ -1,9 +0,0 @@
1
- import { PartialStoryFn } from '@storybook/csf';
2
- import { StoryContext, AngularFramework } from '@storybook/angular';
3
- export declare const skipSourceRender: (context: StoryContext) => any;
4
- /**
5
- * Angular source decorator.
6
- * @param storyFn Fn
7
- * @param context StoryContext
8
- */
9
- export declare const sourceDecorator: (storyFn: PartialStoryFn<AngularFramework>, context: StoryContext) => import("@storybook/angular").IStory;
@@ -1,102 +0,0 @@
1
- export interface Method {
2
- name: string;
3
- args: Argument[];
4
- returnType: string;
5
- decorators?: Decorator[];
6
- description?: string;
7
- rawdescription?: string;
8
- }
9
- export interface JsDocTag {
10
- comment?: string;
11
- tagName?: {
12
- escapedText?: string;
13
- };
14
- }
15
- export interface Property {
16
- name: string;
17
- decorators?: Decorator[];
18
- type: string;
19
- optional: boolean;
20
- defaultValue?: string;
21
- description?: string;
22
- rawdescription?: string;
23
- jsdoctags?: JsDocTag[];
24
- }
25
- export interface Class {
26
- name: string;
27
- ngname: string;
28
- type: 'pipe';
29
- properties: Property[];
30
- methods: Method[];
31
- description?: string;
32
- rawdescription?: string;
33
- }
34
- export interface Injectable {
35
- name: string;
36
- type: 'injectable';
37
- properties: Property[];
38
- methods: Method[];
39
- description?: string;
40
- rawdescription?: string;
41
- }
42
- export interface Pipe {
43
- name: string;
44
- type: 'class';
45
- properties: Property[];
46
- methods: Method[];
47
- description?: string;
48
- rawdescription?: string;
49
- }
50
- export interface Directive {
51
- name: string;
52
- type: 'directive' | 'component';
53
- propertiesClass: Property[];
54
- inputsClass: Property[];
55
- outputsClass: Property[];
56
- methodsClass: Method[];
57
- description?: string;
58
- rawdescription?: string;
59
- }
60
- export declare type Component = Directive;
61
- export interface Argument {
62
- name: string;
63
- type: string;
64
- optional?: boolean;
65
- }
66
- export interface Decorator {
67
- name: string;
68
- }
69
- export interface TypeAlias {
70
- name: string;
71
- ctype: string;
72
- subtype: string;
73
- rawtype: string;
74
- file: string;
75
- kind: number;
76
- description?: string;
77
- rawdescription?: string;
78
- }
79
- export interface EnumType {
80
- name: string;
81
- childs: EnumTypeChild[];
82
- ctype: string;
83
- subtype: string;
84
- file: string;
85
- description?: string;
86
- rawdescription?: string;
87
- }
88
- export interface EnumTypeChild {
89
- name: string;
90
- value?: string;
91
- }
92
- export interface CompodocJson {
93
- directives: Directive[];
94
- components: Component[];
95
- pipes: Pipe[];
96
- injectables: Injectable[];
97
- classes: Class[];
98
- miscellaneous?: {
99
- typealiases?: TypeAlias[];
100
- enumerations?: EnumType[];
101
- };
102
- }
@@ -1,10 +0,0 @@
1
- /// <reference types="react" />
2
- export declare const parameters: {
3
- docs: {
4
- inlineStories: boolean;
5
- getContainer: () => Promise<import("react").FunctionComponent<import("../../blocks").DocsContainerProps<import("@storybook/csf").AnyFramework>>>;
6
- getPage: () => Promise<import("react").FC<{}>>;
7
- iframeHeight: number;
8
- };
9
- };
10
- export declare const argTypesEnhancers: (<TFramework extends import("@storybook/csf").AnyFramework>(context: import("@storybook/csf").StoryContextForEnhancers<TFramework, import("@storybook/csf").Args>) => import("@storybook/csf").StrictArgTypes<import("@storybook/csf").Args> | import("@storybook/addons").Parameters)[];
@@ -1,2 +0,0 @@
1
- import { AnyFramework, StoryContextForEnhancers } from '@storybook/csf';
2
- export declare const enhanceArgTypes: <TFramework extends AnyFramework>(context: StoryContextForEnhancers<TFramework, import("@storybook/csf").Args>) => import("@storybook/csf").StrictArgTypes<import("@storybook/csf").Args> | import("@storybook/addons").Parameters;
@@ -1 +0,0 @@
1
- export declare function webpack(webpackConfig?: any, options?: any): any;
@@ -1,14 +0,0 @@
1
- import { sourceDecorator } from './sourceDecorator';
2
- import { prepareForInline } from './prepareForInline';
3
- import { SourceType } from '../../shared';
4
- export declare const decorators: (typeof sourceDecorator)[];
5
- export declare const parameters: {
6
- docs: {
7
- inlineStories: boolean;
8
- prepareForInline: typeof prepareForInline;
9
- source: {
10
- type: SourceType;
11
- language: string;
12
- };
13
- };
14
- };
@@ -1,2 +0,0 @@
1
- import { PartialStoryFn } from '@storybook/csf';
2
- export declare function prepareForInline(storyFn: PartialStoryFn<any>): JSX.Element;
@@ -1,3 +0,0 @@
1
- import { PartialStoryFn, StoryContext } from '@storybook/csf';
2
- import { HtmlFramework } from '@storybook/html';
3
- export declare function sourceDecorator(storyFn: PartialStoryFn<HtmlFramework>, context: StoryContext<HtmlFramework>): import("@storybook/html/dist/ts3.9/client/preview/types").StoryFnHtmlReturnType;
@@ -1,12 +0,0 @@
1
- import { PartialStoryFn } from '@storybook/csf';
2
- import { ReactFramework } from '@storybook/react';
3
- import { extractComponentDescription } from '../../lib/docgen';
4
- export declare const parameters: {
5
- docs: {
6
- inlineStories: boolean;
7
- prepareForInline: (storyFn: PartialStoryFn<ReactFramework>) => import("@storybook/react/dist/ts3.9/client/preview/types").StoryFnReactReturnType;
8
- extractArgTypes: import("../../lib/docgen").ArgTypesExtractor;
9
- extractComponentDescription: typeof extractComponentDescription;
10
- };
11
- };
12
- export declare const decorators: ((storyFn: PartialStoryFn<ReactFramework, import("@storybook/csf").Args>, context: import("@storybook/csf").StoryContext<ReactFramework, import("@storybook/csf").Args>) => import("@storybook/react/dist/ts3.9/client/preview/types").StoryFnReactReturnType)[];
@@ -1,2 +0,0 @@
1
- import { ArgTypesExtractor } from '../../lib/docgen';
2
- export declare const extractArgTypes: ArgTypesExtractor;
@@ -1,5 +0,0 @@
1
- import { PropDef, PropsExtractor } from '../../lib/docgen';
2
- export interface PropDefMap {
3
- [p: string]: PropDef;
4
- }
5
- export declare const extractProps: PropsExtractor;
@@ -1,23 +0,0 @@
1
- import React, { ReactElement } from 'react';
2
- import { Options } from 'react-element-to-jsx-string';
3
- import { StoryContext, PartialStoryFn } from '@storybook/csf';
4
- import { ReactFramework } from '@storybook/react';
5
- declare type JSXOptions = Options & {
6
- /** How many wrappers to skip when rendering the jsx */
7
- skip?: number;
8
- /** Whether to show the function in the jsx tab */
9
- showFunctions?: boolean;
10
- /** Whether to format HTML or Vue markup */
11
- enableBeautify?: boolean;
12
- /** Override the display name used for a component */
13
- displayName?: string | Options['displayName'];
14
- /** Deprecated: A function ran after the story is rendered */
15
- onBeforeRender?(dom: string): string;
16
- /** A function ran after a story is rendered (prefer this over `onBeforeRender`) */
17
- transformSource?(dom: string, context?: StoryContext<ReactFramework>): string;
18
- };
19
- /** Apply the users parameters and render the jsx for a story */
20
- export declare const renderJsx: (code: React.ReactElement, options: JSXOptions) => string;
21
- export declare const skipJsxRender: (context: StoryContext<ReactFramework>) => any;
22
- export declare const jsxDecorator: (storyFn: PartialStoryFn<ReactFramework>, context: StoryContext<ReactFramework>) => import("@storybook/react/dist/ts3.9/client/preview/types").StoryFnReactReturnType;
23
- export {};
@@ -1,6 +0,0 @@
1
- export declare const CUSTOM_CAPTION = "custom";
2
- export declare const OBJECT_CAPTION = "object";
3
- export declare const ARRAY_CAPTION = "array";
4
- export declare const CLASS_CAPTION = "class";
5
- export declare const FUNCTION_CAPTION = "func";
6
- export declare const ELEMENT_CAPTION = "element";
@@ -1,2 +0,0 @@
1
- export declare const isMemo: (component: any) => boolean;
2
- export declare const isForwardRef: (component: any) => boolean;
@@ -1,2 +0,0 @@
1
- import { PropDefaultValue } from '@storybook/components';
2
- export declare function createDefaultValue(defaultValue: string): PropDefaultValue;
@@ -1,12 +0,0 @@
1
- import { PropDefaultValue } from '@storybook/components';
2
- import { PropDef } from '../../../../lib/docgen';
3
- export declare type TypeResolver = (rawDefaultProp: any, propDef: PropDef) => PropDefaultValue;
4
- export interface TypeResolvers {
5
- string: TypeResolver;
6
- object: TypeResolver;
7
- function: TypeResolver;
8
- default: TypeResolver;
9
- }
10
- export declare function extractFunctionName(func: Function, propName: string): string;
11
- export declare function createTypeResolvers(customResolvers?: Partial<TypeResolvers>): TypeResolvers;
12
- export declare function createDefaultValueFromRawDefaultProp(rawDefaultProp: any, propDef: PropDef, typeResolvers?: TypeResolvers): PropDefaultValue;
@@ -1,3 +0,0 @@
1
- import { PropDefaultValue } from '@storybook/components';
2
- import { InspectionResult } from '../inspection';
3
- export declare function generateArray({ inferredType, ast }: InspectionResult): PropDefaultValue;
@@ -1,3 +0,0 @@
1
- import { PropDefaultValue } from '@storybook/components';
2
- import { InspectionResult } from '../inspection';
3
- export declare function generateObject({ inferredType, ast }: InspectionResult): PropDefaultValue;
@@ -1,2 +0,0 @@
1
- export * from './createDefaultValue';
2
- export * from './createFromRawDefaultProp';
@@ -1,4 +0,0 @@
1
- import { InspectionIdentifiableInferedType } from '../inspection';
2
- export declare function getPrettyIdentifier(inferredType: InspectionIdentifiableInferedType): string;
3
- export declare function getPrettyFuncIdentifier(identifier: string, hasArguments: boolean): string;
4
- export declare function getPrettyElementIdentifier(identifier: string): string;
@@ -1,3 +0,0 @@
1
- export declare function generateCode(ast: any, compact?: boolean): string;
2
- export declare function generateObjectCode(ast: any, compact?: boolean): string;
3
- export declare function generateArrayCode(ast: any, compact?: boolean): string;
@@ -1,4 +0,0 @@
1
- export * from './captions';
2
- export * from './isHtmlTag';
3
- export * from './generateCode';
4
- export * from './componentTypes';
@@ -1,7 +0,0 @@
1
- import { InspectionInferedType } from './types';
2
- interface ParsingResult<T> {
3
- inferredType: T;
4
- ast: any;
5
- }
6
- export declare function parse(value: string): ParsingResult<InspectionInferedType>;
7
- export {};
@@ -1,2 +0,0 @@
1
- export * from './types';
2
- export * from './inspectValue';
@@ -1,2 +0,0 @@
1
- import { InspectionResult } from './types';
2
- export declare function inspectValue(value: string): InspectionResult;
@@ -1,50 +0,0 @@
1
- export declare enum InspectionType {
2
- IDENTIFIER = "Identifier",
3
- LITERAL = "Literal",
4
- OBJECT = "Object",
5
- ARRAY = "Array",
6
- FUNCTION = "Function",
7
- CLASS = "Class",
8
- ELEMENT = "Element",
9
- UNKNOWN = "Unknown"
10
- }
11
- export interface InspectionInferedType {
12
- type: InspectionType;
13
- }
14
- export interface InspectionIdentifier extends InspectionInferedType {
15
- type: InspectionType.IDENTIFIER;
16
- identifier: string;
17
- }
18
- export interface InspectionLiteral extends InspectionInferedType {
19
- type: InspectionType.LITERAL;
20
- }
21
- export interface InspectionObject extends InspectionInferedType {
22
- type: InspectionType.OBJECT;
23
- depth: number;
24
- }
25
- export interface InspectionArray extends InspectionInferedType {
26
- type: InspectionType.ARRAY;
27
- depth: number;
28
- }
29
- export interface InspectionClass extends InspectionInferedType {
30
- type: InspectionType.CLASS;
31
- identifier: string;
32
- }
33
- export interface InspectionFunction extends InspectionInferedType {
34
- type: InspectionType.FUNCTION;
35
- identifier?: string;
36
- params: any[];
37
- hasParams: boolean;
38
- }
39
- export interface InspectionElement extends InspectionInferedType {
40
- type: InspectionType.ELEMENT;
41
- identifier?: string;
42
- }
43
- export interface InspectionUnknown extends InspectionInferedType {
44
- type: InspectionType.UNKNOWN;
45
- }
46
- export declare type InspectionIdentifiableInferedType = InspectionIdentifier | InspectionClass | InspectionFunction | InspectionElement;
47
- export interface InspectionResult {
48
- inferredType: InspectionInferedType;
49
- ast?: any;
50
- }
@@ -1 +0,0 @@
1
- export declare function isHtmlTag(tagName: string): boolean;
@@ -1,3 +0,0 @@
1
- import { PropType } from '@storybook/components';
2
- import { ExtractedProp } from '../../../lib/docgen';
3
- export declare function createType(extractedProp: ExtractedProp): PropType;
@@ -1,4 +0,0 @@
1
- import { ExtractedJsDocParam, ExtractedJsDocReturns } from '../../../lib/jsdocParser';
2
- export declare function generateFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string;
3
- export declare function generateShortFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string;
4
- export declare function toMultilineSignature(signature: string): string;
@@ -1,4 +0,0 @@
1
- import { PropDef, ExtractedProp } from '../../../lib/docgen';
2
- import { Component } from '../../../blocks/types';
3
- export declare function enhancePropTypesProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef;
4
- export declare function enhancePropTypesProps(extractedProps: ExtractedProp[], component: Component): PropDef[];
@@ -1 +0,0 @@
1
- export declare const rawDefaultPropTypeResolvers: import("../lib/defaultValues").TypeResolvers;
@@ -1,3 +0,0 @@
1
- import { PropDef } from '../../../lib/docgen';
2
- import { Component } from '../../../blocks/types';
3
- export declare function keepOriginalDefinitionOrder(extractedProps: PropDef[], component: Component): PropDef[];
@@ -1,3 +0,0 @@
1
- import { PropDef, ExtractedProp } from '../../../lib/docgen';
2
- export declare function enhanceTypeScriptProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef;
3
- export declare function enhanceTypeScriptProps(extractedProps: ExtractedProp[]): PropDef[];
@@ -1,11 +0,0 @@
1
- /// <reference types="react" />
2
- import { extractComponentDescription } from './extractComponentDescription';
3
- export declare const parameters: {
4
- docs: {
5
- inlineStories: boolean;
6
- prepareForInline: (storyFn: import("@storybook/csf").StoryFn<import("@storybook/csf").AnyFramework, import("@storybook/csf").Args>) => import("react").DetailedReactHTMLElement<import("react").HTMLAttributes<any>, any>;
7
- extractArgTypes: import("../../lib/docgen").ArgTypesExtractor;
8
- extractComponentDescription: typeof extractComponentDescription;
9
- };
10
- };
11
- export declare const decorators: ((storyFn: any, context: import("@storybook/csf").StoryContext<import("@storybook/csf").AnyFramework, import("@storybook/csf").Args>) => any)[];