- #1586
1ecc082a
Thanks @sawmurai! - Add initial support for external types in defineProps and defineEmits
- #1580
67ba3b0b
Thanks @elevatebart! - handle type as unknown as PropType
- #1576
3f1d9216
Thanks @elevatebart! - parse the defineOptions object for values
- #1573
d4c2deca
Thanks @thibaudszy! - improve performance of the path resolution
b05be722
Thanks @elevatebart! - export-all should not skip all extensions
- #1558
14bdb1dd
Thanks @elevatebart! - fix valid extends
- #1550
979c7fdc
Thanks @elevatebart! - allow documentation of implicit slot bindings
- #1547
8d22c833
Thanks @elevatebart! - feat: expose some utils functions
- #1546
51123822
Thanks @elevatebart! - fix: protect invalid pattern
- Updated dependencies [
d86476bd
]:- vue-inbrowser-compiler-independent-utils@4.69.0
- #1536
68cd825a
Thanks @elevatebart! - feat: export an esm version of the api
-
#1536
68cd825a
Thanks @elevatebart! - vue-docgen-api to parse type TSInstantiationExpression -
#1537
7a7d5c41
Thanks @elevatebart! - fix: update recast and ast-types to accept latest syntax
-
#1512
7310095c
Thanks @elevatebart! - fix: mixin-error-with-default -
#1513
1b178cad
Thanks @elevatebart! - fix preprocessing of script setup -
Updated dependencies [
1b178cad
]:- vue-inbrowser-compiler-independent-utils@4.64.1
- #1511
fa34e5cf
Thanks @elevatebart! - feat: track dependencies of components in vue-docgen-cli
-
#1510
e8902a1a
Thanks @elevatebart! - Update LRU cache dependency to version 8.x -
Updated dependencies [
fa34e5cf
]:- vue-inbrowser-compiler-independent-utils@4.64.0
049306d1
Thanks @elevatebart! - fix(vue-docgen-api): Catch error for model if not literal object
- #1461
cd7cc3f4
Thanks @chakAs3! - fix(docgen-api) fix issue when Props passed as Reference to Local Type
-
#1449
f2cf6fcc
Thanks @elevatebart! - 1447 lack of support for defineexpose in script setup synthax -
#1448
fbd5fe71
Thanks @elevatebart! - fix: defineEmits can use quote string as key -
Updated dependencies [
f2cf6fcc
]:- vue-inbrowser-compiler-independent-utils@4.56.2
- #1374
c38b94a3
Thanks @elevatebart! - Split utils package to avoid dependency for docgen
- Updated dependencies [
c38b94a3
]:- vue-inbrowser-compiler-independent-utils@4.52.0
6308307b
Thanks @elevatebart! - - fixdefineExposed
intodefineExpose
- add the exposed member to the documentation
- Updated dependencies [
6308307b
]:- vue-inbrowser-compiler-utils@4.50.0
- #1362
368df13f
Thanks @chenjuneking! - - fixdefineExposed
intodefineExpose
- add the exposed member to the documentation
- Updated dependencies [
bbc09354
]:- vue-inbrowser-compiler-utils@4.47.0
- #1328
c2a1c793
Thanks @elevatebart! - Allow multiple fire tags on the same method
e8c154eb
Thanks @elevatebart! - fix #1326 allow scriptHandler and addScriptHandler to be specified at the same time
-
#1318
9b1ec66f
Thanks @elevatebart! -@example
tags can now understand multiline examplesEvery tag can now contain multiple lines except for the following:
@slot
@ignore
@private
@public
If one of those tags is placed at the beginning of the TSDocs block, the next lines are still picked up as the description.
All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.
4.45.0 (2022-04-29)
4.44.23 (2022-03-25)
4.44.22 (2022-03-18)
Note: Version bump only for package vue-docgen-api
4.44.21 (2022-03-18)
Note: Version bump only for package vue-docgen-api
4.44.20 (2022-03-18)
Note: Version bump only for package vue-docgen-api
4.44.18 (2022-03-10)
4.44.17 (2022-02-28)
Note: Version bump only for package vue-docgen-api
4.44.16 (2022-02-22)
- display richer complex types in setup (2254598)
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
Note: Version bump only for package vue-docgen-api
4.44.3 (2022-01-31)
- display richer complex types in setup (2254598)
4.44.2 (2022-01-18)
- docgen: parse TypeScript types / setup syntax (2346b64)
4.44.1 (2022-01-18)
- docgen: parse withDefaults() for defaults (3ac0759)
4.44.0 (2022-01-17)
- docgen: typings for tests (bf59f31)
4.43.3 (2022-01-13)
4.43.2 (2022-01-03)
Note: Version bump only for package vue-docgen-api
4.43.1 (2021-12-23)
- docgen: parse bindings with a dash in jsdoc (b7b0d30), closes #1229
- have both script & setup in a SFC ignores (3593171)
4.43.0 (2021-11-21)
4.42.0 (2021-11-18)
Note: Version bump only for package vue-docgen-api
4.41.2 (2021-09-09)
Note: Version bump only for package vue-docgen-api
4.41.1 (2021-08-17)
Note: Version bump only for package vue-docgen-api
4.41.0 (2021-08-13)
- docgen: add support for arrays in aliases (df76397)
4.40.0 (2021-06-07)
4.39.0 (2021-05-24)
- allow extension of component in a local file (1663977)
- resolve local global variable for mixins (58305f3)
4.38.3 (2021-05-24)
4.38.2 (2021-05-11)
- allow for @Emit to be parsed (b1c7285)
4.38.1 (2021-04-13)
4.38.0 (2021-04-10)
4.37.0 (2021-04-05)
4.36.1 (2021-03-20)
4.36.0 (2021-03-18)
- updrade react-stypeguidist (4823bd2)
- docgen: ensure pug renders template using html doctype (2f3512b)
- docgen: html doctype as a default rather than a force (01c921f)
- docgen: allow slots to be defined by composition API render functions (63f2f35)
4.35.0 (2021-01-26)
- docgen: use the pathResolver from utils (3b77a82)
- resolve #1042 add basic support for aliases in external src (6d8b5c5)
4.34.2 (2020-12-05)
- docgen: SFC with lang='tsx' support (bd21931)
4.34.1 (2020-11-27)
4.34.0 (2020-11-25)
4.33.9 (2020-11-16)
Note: Version bump only for package vue-docgen-api
4.33.7 (2020-11-15)
- docgen: allow Mixins from vue-p-decorator (314686a)
4.33.6 (2020-11-05)
Note: Version bump only for package vue-docgen-api
4.33.4 (2020-10-22)
Note: Version bump only for package vue-docgen-api
4.33.2 (2020-10-19)
Note: Version bump only for package vue-docgen-api
4.33.1 (2020-10-14)
- docgen: allow
as const
in default (d3f070d)
4.33.0 (2020-10-12)
4.32.4 (2020-09-24)
4.32.1 (2020-09-08)
Note: Version bump only for package vue-docgen-api
4.32.0 (2020-09-08)
4.31.2 (2020-08-23)
Note: Version bump only for package vue-docgen-api
4.31.1 (2020-08-20)
4.31.0 (2020-08-15)
- docgen: allow destructured children in func (1f9d9b6)
- docgen: undetecteable slots definition (be867bd)
4.30.0 (2020-08-08)
- slot handler with vue 3 (cec6a54)
- docgen: make props detector work WIP
- figure out the move to vue 3 WIP
4.29.1 (2020-07-30)
Note: Version bump only for package vue-docgen-api
4.28.1 (2020-07-27)
- delegated component exports (046f96b)
4.28.0 (2020-07-21)
- docgen: priority to documented values (696bd87)
- docgen: detect values in validator (8d681a6)
4.23.1 (2020-05-15)
4.23.0 (2020-05-15)
- docgen: allow to have more than 1 values tag (3e84005)
4.22.3 (2020-05-12)
4.22.2 (2020-05-12)
- docgen: error when parsing default prop (1fe3dfe)
4.22.1 (2020-05-12)
- docgen: object Methods should return regular functions (79a7fa2)
- avoid error when multiple return in a default (3e4c53d)
- docgen: correctly extract default values (349ad81)
4.21.0 (2020-05-09)
4.20.0 (2020-05-06)
- docgen: make values work for class type (c003176)
- docgen: record @type values (452ccb5)
- docgen: resolve values in as types (7648a4e)
4.19.2 (2020-04-29)
- docgen: allow functional render slots (2b36e38), closes #837
- docgen: scoped slots bindings can spread (d0a939c), closes #833
4.19.1 (2020-04-28)
4.19.0 (2020-04-24)
- tag titles are no longer filtered out (2a91b3e)
- docgen: accept named typescript exports (b256b17), closes #813
- docgen: deal with index as filename (61d28f5)
4.18.0 (2020-04-17)
- docgen: fix ts array, intersection type print (4ca38bf)
- docgen: accept pug options for the template (c318521)
- docgen: extract type values properly (6ffd571)
4.16.0 (2020-04-09)
4.15.1 (2020-03-30)
- docgen: allow single slots to not documented (34381d1)
4.15.0 (2020-03-29)
- docgen: parse the throws tag (2f70045)
4.14.0 (2020-03-18)
- expose typescript types for theming (3110fb5)
4.13.1 (2020-03-03)
- docgen: export iev var names (c02268b)
- docgen: handlers expressions with multiline (8e7c66c), closes #772
- multiple exports in parse export default (7bb82dd)
- sort docs when all promises are resolved (dbaa82e)
4.12.0 (2020-02-25)
- docgen: methods returned by other methods (95e648c), closes #765
- detect when example file loaded twice (e4b1a48)
4.11.0 (2020-02-22)
- only show required props on default examples (0f6bc11)
- give default examples a variable geometry (535e347)
4.9.0 (2020-02-16)
4.27.1 (2020-07-19)
4.27.0 (2020-07-17)
- docgen: resolve dynamic mixins (0dbe049)
4.26.0 (2020-06-29)
Note: Version bump only for package vue-docgen-api
4.25.0 (2020-06-19)
- docgen: allow other forms of validation (dd2400c)
4.24.0 (2020-05-28)
- docgen: priority to documented values (696bd87)
- docgen: detect values in validator (8d681a6)
4.23.1 (2020-05-15)
Note: Version bump only for package vue-docgen-api
4.23.0 (2020-05-15)
- docgen: allow to have more than 1 values tag (3e84005)
4.22.3 (2020-05-12)
4.22.2 (2020-05-12)
- docgen: error when parsing default prop (1fe3dfe)
4.22.1 (2020-05-12)
- docgen: correctly extract default values (349ad81)
- avoid error when multiple return in a default (3e4c53d)
- docgen: object Methods should return regular functions (79a7fa2)
4.21.0 (2020-05-09)
4.20.0 (2020-05-06)
- docgen: make values work for class type (c003176)
- docgen: record @type values (452ccb5)
- docgen: resolve values in as types (7648a4e)
4.19.2 (2020-04-29)
- docgen: allow functional render slots (2b36e38), closes #837
- docgen: scoped slots bindings can spread (d0a939c), closes #833
4.19.1 (2020-04-28)
Note: Version bump only for package vue-docgen-api
4.19.0 (2020-04-24)
- docgen: accept named typescript exports (b256b17), closes #813
- tag titles are no longer filtered out (2a91b3e)
- docgen: deal with index as filename (61d28f5)
4.18.0 (2020-04-17)
- docgen: fix ts array, intersection type print (4ca38bf)
- docgen: extract type values properly (6ffd571)
4.16.0 (2020-04-09)
4.15.1 (2020-03-30)
- docgen: allow single slots to not documented (34381d1)
4.15.0 (2020-03-29)
- docgen: parse the throws tag (2f70045)
4.14.0 (2020-03-18)
- expose typescript types for theming (3110fb5)
4.13.1 (2020-03-03)
- multiple exports in parse export default (7bb82dd)
- sort docs when all promises are resolved (dbaa82e)
- docgen: export iev var names (c02268b)
- docgen: handlers expressions with multiline (8e7c66c), closes #772
4.12.0 (2020-02-25)
- detect when example file loaded twice (e4b1a48)
- docgen: methods returned by other methods (95e648c), closes #765
4.11.0 (2020-02-22)
- only show required props on default examples (0f6bc11)
- give default examples a variable geometry (535e347)
4.9.0 (2020-02-16)
- stop rendering bad event properties (26fccd9)
- origin column on props event methods & slots (8b0650f)
4.8.1 (2020-02-13)
4.8.0 (2020-02-12)
- add tags to slots (dcbddf8)
4.7.7 (2020-02-10)
- import of named mixins failing (185fb22)
- docgen: use webpack modules when resolving paths (6b5b87f), closes #743
4.7.6 (2020-01-23)
4.7.5 (2020-01-23)
4.7.4 (2020-01-22)
- docgen: allow multi line root comment (c6eacf7)
- docgen: docs only vue components (fcc28f6), closes #731
- docgen: make events parsed in template (e361bef)
4.7.0 (2020-01-20)
4.6.0 (2020-01-19)
- parse should export default cmp if available (753dea4)
4.5.2 (2020-01-17)
4.5.0 (2020-01-15)
Note: Version bump only for package vue-docgen-api
4.4.3 (2020-01-11)
Note: Version bump only for package vue-docgen-api
4.4.2 (2020-01-10)
4.4.0 (2020-01-09)
- docgen: add vuetify exported component (932e2ec)
4.3.0 (2020-01-08)
- docgen: resolve pass through components (07d183f)
4.2.2 (2019-12-18)
- docgen: make sure optional prop are optional (3695ed6)
4.2.0 (2019-12-10)
4.1.2 (2019-12-08)
Note: Version bump only for package vue-docgen-api
4.1.1 (2019-12-05)
Note: Version bump only for package vue-docgen-api
4.1.0 (2019-12-04)
- docgen: multi-components in a file (3790837)
4.0.7 (2019-12-01)
- docgen: avoid incorrect of getting nested '}' param type (5df05e0)
4.0.5 (2019-11-20)
- docgen: ensure custom handlers are actually run (7a0ac62)
4.0.4 (2019-11-19)
- docgen: fixed description extraction on non-SFC components (85626fc)
4.0.1 (2019-11-15)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.20 (2019-11-15)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.17 (2019-11-14)
4.0.0-beta.15 (2019-11-13)
- docgen: avoid setting exportName to deps (230e1e3)
- use @values tag in props (cb2fc74), closes #345
- docgen: accept more tags for event params (cc55f58)
- docgen: add exportName to CompoentDoc (9466105)
4.0.0-beta.12 (2019-11-06)
- cli: expose docgen-cli config interfaces (25f0744)
4.0.0-beta.10 (2019-10-30)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.8 (2019-10-28)
- docgen: avoid outputing empty array (51d42bf)
- emit types for vue-styleguidist (f0af958)
4.0.0-beta.7 (2019-10-25)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.6 (2019-10-24)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.5 (2019-10-24)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.3 (2019-10-24)
Note: Version bump only for package vue-docgen-api
4.0.0-beta.1 (2019-10-23)
Note: Version bump only for package vue-docgen-api
3.25.1-beta.1 (2019-10-23)
- docgen: make docgen output arrays only (d456c6c)
- docgen: props, events, methods and slots are now all arrays
Co-authored-by: Sébastien D. demsking@gmail.com
- docgen: required for props is never a string anymore
- docgen: docgen becomes async, so do all of the handlers
3.25.1-beta.0 (2019-10-23)
3.26.0 (2019-10-25)
- docgen: allow for multiple times the same tag (68a0204)
3.25.0 (2019-10-15)
- docgen: add origin to documentation object (31e2fe2), closes #594
- docgen: allow wrap export in if (5744801)
3.24.2 (2019-09-26)
3.24.1 (2019-09-26)
- docgen: allow default to be a method (40ec2ae)
3.23.1 (2019-09-20)
- docgen: allow default to be a string key (1fa756f), closes #581
- extend quoting to methods and props (10e2b3e)
3.22.3 (2019-09-12)
- look at statements for description (71969bf)
3.22.0 (2019-08-19)
3.20.0 (2019-08-10)
- docgen: expose docs block in dogen-api (4565559)
3.19.5 (2019-08-07)
Note: Version bump only for package vue-docgen-api
3.19.3 (2019-08-06)
Note: Version bump only for package vue-docgen-api
3.17.0 (2019-07-23)
3.16.3 (2019-07-19)
- slot scoped parsing (9685ba2)
3.16.0 (2019-07-15)
3.15.4 (2019-07-07)
- allow importing non component files (5aa59a6), closes #436
- transform error into warning when NOENT (296e1cd)
- docgen: avoid parse files that are'nt potential components (4b1e43b), closes #436
- docgen: resolve es6 modules properly (1b4eb0a), closes #478
3.15.3 (2019-07-02)
3.15.2 (2019-07-02)
- add simple bindings detection (31a3fca)
- make (Vue as VueConstructor) resolved (b7ed624)
- docgen: adapt method handler to default params (4f67f4e), closes #476
- docgen: make v-bind have a separate treatment (cee2a9b), closes #469
3.15.0 (2019-06-19)
- docgen: fix template parsing expressions (56a2e05)
- docgen: add external proptypes parsing for docgen (eaa4748), closes #465
- docgen: support ts prop types (c57c243), closes #413
3.14.5 (2019-06-14)
3.14.4 (2019-06-14)
- update dependencies to re-enable HMR (860e3bc)
- docgen: get slot and scoped slot description in render without JSX (33086cf)
3.13.8 (2019-05-29)
Note: Version bump only for package vue-docgen-api
3.13.5 (2019-05-22)
- Additionally try absolute require.resolve in resolvePathFrom (d1be583)
- Look through all roots. (3641e4c)
3.13.4 (2019-05-15)
- docgen: fix node_modules mixins parsing (a4eed84), closes #416
- make sure node_module resolved path ignored (7a1092a)
3.12.0 (2019-04-25)
- docgen: add jsx option to docgen (0ce2a9e)
3.11.6 (2019-04-23)
3.11.4 (2019-04-03)
3.11.3 (2019-04-01)
3.11.2 (2019-03-28)
Note: Version bump only for package vue-docgen-api
3.11.1 (2019-03-28)
3.11.0 (2019-03-26)
Note: Version bump only for package vue-docgen-api