CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

4.23.1 (2020-05-15)

Note: Version bump only for package vue-docgen-api

4.23.0 (2020-05-15)

Features

• docgen: allow to have more than 1 values tag (3e84005)

4.22.3 (2020-05-12)

Bug Fixes

• docgen: fix default parsing for @type props (1fc4b03), closes #866

4.22.2 (2020-05-12)

Bug Fixes

• docgen: error when parsing default prop (1fe3dfe)

4.22.1 (2020-05-12)

Bug Fixes

• 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)

Features

• docgen: allow to force events definitions (#854) (7a2105c)

4.20.0 (2020-05-06)

Features

• 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)

Bug Fixes

• 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)

Bug Fixes

• docgen: accept named typescript exports (b256b17), closes #813
• tag titles are no longer filtered out (2a91b3e)

Features

• docgen: deal with index as filename (61d28f5)

4.18.0 (2020-04-17)

Bug Fixes

• docgen: fix ts array, intersection type print (4ca38bf)

Features

• docgen: extract type values properly (6ffd571)

4.16.0 (2020-04-09)

Features

• Document composite components (#815) (a6a3d11), closes #809

4.15.1 (2020-03-30)

Bug Fixes

• docgen: allow single slots to not documented (34381d1)

4.15.0 (2020-03-29)

Bug Fixes

• docgen: remove TSUnionType (2f32e5f), closes #796

Features

• docgen: parse the throws tag (2f70045)

4.14.0 (2020-03-18)

Features

• expose typescript types for theming (3110fb5)

4.13.1 (2020-03-03)

Bug Fixes

• 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)

Bug Fixes

• docgen: take mixin order into account (626337e), closes #761

Features

• detect when example file loaded twice (e4b1a48)
• docgen: methods returned by other methods (95e648c), closes #765

4.11.0 (2020-02-22)

Bug Fixes

• only show required props on default examples (0f6bc11)

Features

• give default examples a variable geometry (535e347)

4.9.0 (2020-02-16)

Bug Fixes

• stop rendering bad event properties (26fccd9)

Features

• origin column on props event methods & slots (8b0650f)

4.8.1 (2020-02-13)

Bug Fixes

• protect slots in if statements (1d3d29e), closes #753

4.8.0 (2020-02-12)

Bug Fixes

• docgen: protect empty comments before slots (6484a10), closes #749

Features

• add tags to slots (dcbddf8)

4.7.7 (2020-02-10)

Bug Fixes

• import of named mixins failing (185fb22)
• docgen: use webpack modules when resolving paths (6b5b87f), closes #743

4.7.6 (2020-01-23)

Bug Fixes

• docgen: handle empty handler (f811ed3), closes #738

4.7.5 (2020-01-23)

Bug Fixes

• docgen: filter components more clearly (09b15e9), closes #735

4.7.4 (2020-01-22)

Bug Fixes

• 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)

Features

• detect events in template (327b54e)
• parse $emit in templates (21d5eca), closes #725

4.6.0 (2020-01-19)

Bug Fixes

• parse should export default cmp if available (753dea4)

Features

• allow iev as valid component (21c4874), closes #713

4.5.2 (2020-01-17)

Bug Fixes

• multiple exports in vue files (56fcdd8), closes #717

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)

Bug Fixes

• resolve immediately exported vars recursively (7b27480)
• docgen: origin never cleared (0dc4251)

Performance Improvements

• avoid looking at node_modules in IEV (55e29e3)
• use await for reading file async (cf254c0)

4.4.0 (2020-01-09)

Bug Fixes

• resolve conflicts (ff45137)
• update error management in docgen loader (f23f267)

Features

• docgen: add vuetify exported component (932e2ec)

4.3.0 (2020-01-08)

Features

• docgen: resolve pass through components (07d183f)

4.2.2 (2019-12-18)

Performance Improvements

• docgen: make sure optional prop are optional (3695ed6)

4.2.0 (2019-12-10)

Features

• detect model property (1c28167), closes #654
• docgen: allow to customize validExtends (eb966c5)

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)

Bug Fixes

• docgen: support @values on classPropHandler (4b7f8b6)

Features

• docgen: multi-components in a file (3790837)

4.0.7 (2019-12-01)

Bug Fixes

• docgen: avoid incorrect of getting nested '}' param type (5df05e0)

4.0.5 (2019-11-20)

Bug Fixes

• docgen: ensure custom handlers are actually run (7a0ac62)

4.0.4 (2019-11-19)

Bug Fixes

• 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)

Features

• docgen: refactor bindings (b501f82)
• use bindings comments in styleguidist (4fb6551)

4.0.0-beta.15 (2019-11-13)

Bug Fixes

• docgen: avoid setting exportName to deps (230e1e3)

Features

• 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)

Features

• 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)

Bug Fixes

• docgen: avoid outputing empty array (51d42bf)

Features

• 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)

Bug Fixes

• docgen: make docgen output arrays only (d456c6c)

Code Refactoring

• docgen: make function docgen.parse async (e17680b)
• docgen: make required always a boolean (03bc88e)

BREAKING CHANGES

• docgen: props, events, methods and slots are now all arrays

Co-authored-by: Sébastien D. [email protected]

• 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)

Bug Fixes

• docgen: allow for multiple times the same tag (68a0204)

3.25.0 (2019-10-15)

Features

• docgen: add origin to documentation object (31e2fe2), closes #594
• docgen: allow wrap export in if (5744801)

3.24.2 (2019-09-26)

Bug Fixes

• docgen: detetct scopedSlots in render() (5e7015d), closes #586

3.24.1 (2019-09-26)

Bug Fixes

• docgen: allow default to be a method (40ec2ae)

3.23.1 (2019-09-20)

Bug Fixes

• docgen: allow default to be a string key (1fa756f), closes #581
• extend quoting to methods and props (10e2b3e)

3.22.3 (2019-09-12)

Bug Fixes

• look at statements for description (71969bf)

3.22.0 (2019-08-19)

Features

• docgen: class event @emit (4483168), closes #305

3.20.0 (2019-08-10)

Features

• 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)

Bug Fixes

• docgen: allow document scopedSlots in render (31a7e07), closes #174

3.16.3 (2019-07-19)

Bug Fixes

• slot scoped parsing (9685ba2)

3.16.0 (2019-07-15)

Bug Fixes

• docgen: allow for v-model in functional components (8884e62), closes #493

3.15.4 (2019-07-07)

Bug Fixes

• 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)

Bug Fixes

• docgen: make aliases only path parts instead of letters (b83e235), closes #478

3.15.2 (2019-07-02)

Bug Fixes

• 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)

Bug Fixes

• docgen: fix template parsing expressions (56a2e05)

Features

• docgen: add external proptypes parsing for docgen (eaa4748), closes #465
• docgen: support ts prop types (c57c243), closes #413

3.14.5 (2019-06-14)

Bug Fixes

• docgen: fixed multiple use of same event needing desc (329f66a), closes #459

3.14.4 (2019-06-14)

Bug Fixes

• 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)

Bug Fixes

• Additionally try absolute require.resolve in resolvePathFrom (d1be583)
• Look through all roots. (3641e4c)

3.13.4 (2019-05-15)

Bug Fixes

• docgen: fix node_modules mixins parsing (a4eed84), closes #416
• make sure node_module resolved path ignored (7a1092a)

3.12.0 (2019-04-25)

Bug Fixes

• docgen: allow for not parsing jsx (8b669f3)
• docgen: give better error message lines (9b04cc4)

Features

• docgen: add jsx option to docgen (0ce2a9e)

3.11.6 (2019-04-23)

Bug Fixes

• make @arg and @argument accepted (1b0ddca)
• docgen: update method for unpassing tests (4f5c6cd)

3.11.4 (2019-04-03)

Bug Fixes

• add vue-class-component management (#371) (d1aced1)

3.11.3 (2019-04-01)

Bug Fixes

• docgen: protect uresolved events (09d970f), closes #363

3.11.2 (2019-03-28)

Note: Version bump only for package vue-docgen-api

3.11.1 (2019-03-28)

Bug Fixes

• docgen: make displayName tag work (#358) (c3e12ce), closes #357

3.11.0 (2019-03-26)

Note: Version bump only for package vue-docgen-api