All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.
4.24.1 (2020-06-05)
- repair codesplit false (c42b522)
4.24.0 (2020-05-28)
- adjust structure of examples (b80a86c)
- classname and style were ignored (563b313)
- docgen: priority to documented values (696bd87)
- docgen: detect values in validator (8d681a6)
4.23.3 (2020-05-20)
- dependency update for security (e227276)
- utils: protect docgen-cli when in SSG (af269f6), closes #876
4.23.2 (2020-05-18)
- protect async config against parsing error (95c6c09)
4.23.1 (2020-05-15)
- only collapse subcomponents when > 3 (76b4331)
4.23.0 (2020-05-15)
- default editor font-family (909a47f)
- issues with deprecated and requires (efa53c9), closes #870 #871
- docgen: allow to have more than 1 values tag (3e84005)
4.22.3 (2020-05-12)
- docgen: fix default parsing for @type props (1fc4b03), closes #866
- throw when errors in promise (7b534df)
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)
- allow default example with custom format (7ac7f57)
- avoid error when multiple return in a default (3e4c53d)
- only display warning when file exists (cfe1f9f)
- protect editor for null code (8c428a4)
- docgen: object Methods should return regular functions (79a7fa2)
4.22.0 (2020-05-11)
- allow for config to be an async function (fb16a67)
4.21.0 (2020-05-09)
4.20.0 (2020-05-06)
- loader: use emit error to thow parsing errors (8978f54)
- add vue docgen simple laoder (6d7e8f4)
- docgen: make values work for class type (c003176)
- docgen: record @type values (452ccb5)
- docgen: resolve values in as types (7648a4e)
4.19.5 (2020-05-02)
Note: Version bump only for package vue-styleguidist
4.19.4 (2020-05-01)
- plugin: use a custom loader to deal with docs (57abe6e)
4.19.3 (2020-04-30)
- plugin: update null-loader + avoid conflicts (07f6a98)
4.19.2 (2020-04-29)
- show - instead of undefined for untyped props (f5a3e82), closes #831
- 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-styleguidist
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: extract type values properly (6ffd571)
- allow change padding of prism based editor (d09b546)
- render complex types properly (a756455)
4.17.0 (2020-04-12)
- enable indpdt HMR on sub-components (3626933)
4.16.0 (2020-04-09)
4.15.2 (2020-03-31)
- allow ignoreWithoutExamples to work with docs (f5bbc41)
4.15.1 (2020-03-30)
- docgen: allow single slots to not documented (34381d1)
- default example parser with alias (361051c), closes #806
- proper highlihght for pseudo JSX (ed6e16f)
4.15.0 (2020-03-29)
- display show code when only events (aeea160), closes #801
- docgen: remove TSUnionType (2f32e5f), closes #796
- docgen: parse the throws tag (2f70045)
- display @throws in the JsDoc tags of methods (8325f86), closes #795
4.14.0 (2020-03-18)
- docs: Correct netlify build command (92dc3be)
- allow webpackConfig functions to return alias (5a6b6a3), closes #793
- make interface for codetabbutton exported (ccd52d8)
- expose typescript types for theming (3110fb5)
4.13.1 (2020-03-03)
- an SFC example can contain JSX (deb2dc7)
- 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.13.0 (2020-03-02)
- allow mutiple extra example files (d06283b)
4.12.2 (2020-03-02)
- plugin: pass cli options down to vsg (6765aee), closes #771
- allow examples start with < & pure template (3860129)
- avoid progress bar when verbose (75f77d0)
- bring back the full power of verbose option (210bae2)
- hot reload default examples (295cfe5)
4.12.1 (2020-02-26)
- remove annoying warning about double use (1dce586)
4.12.0 (2020-02-25)
- allow to ignore some example file lookup (7104271)
- 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.10.1 (2020-02-17)
- update Prism theming & docs (70514b9)
4.10.0 (2020-02-17)
- allow usage of prism themes (921dbd5)
- Revert "refactor: avoid converting events and slots" (d8e4d4d)
4.9.1 (2020-02-16)
4.9.0 (2020-02-16)
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.3 (2020-01-21)
- Revert "fix: avoid cors issue on codesandbox" (20696ad)
- Revert "fix: make library compatible with codesandbox" (ed32d73)
4.7.2 (2020-01-20)
- avoid cors issue on codesandbox (26450b2)
4.7.1 (2020-01-20)
- make library compatible with codesandbox (c4b531d)
4.7.0 (2020-01-20)
4.6.1 (2020-01-19)
4.6.0 (2020-01-19)
- parse should export default cmp if available (753dea4)
4.5.2 (2020-01-17)
4.5.1 (2020-01-16)
4.5.0 (2020-01-15)
- typings automated template (711b14b)
- update rsg with new theming (af0ceb2)
4.4.3 (2020-01-11)
4.4.2 (2020-01-10)
4.4.1 (2020-01-09)
- collapsible sections tocMode (e5f7bfd)
4.4.0 (2020-01-09)
- resolve conflicts (ff45137)
- update error management in docgen loader (f23f267)
- warning when documenting return of a method (0a74e3b)
- docgen: add vuetify exported component (932e2ec)
4.3.0 (2020-01-08)
4.2.3 (2019-12-23)
4.2.2 (2019-12-18)
- docgen: make sure optional prop are optional (3695ed6)
4.2.1 (2019-12-11)
4.2.0 (2019-12-10)
- detect model property (1c28167), closes #654
- docgen: allow to customize validExtends (eb966c5)
- pass validExtends to styleguide.config.js (c22f7d5)
4.1.2 (2019-12-08)
Note: Version bump only for package vue-styleguidist
4.1.1 (2019-12-05)
Note: Version bump only for package vue-styleguidist
4.1.0 (2019-12-04)
- docgen: multi-components in a file (3790837)
4.0.8 (2019-12-02)
- make sections without examples pre-compile (56d675d)
4.0.7 (2019-12-01)
- docgen: avoid incorrect of getting nested '}' param type (5df05e0)
- destroy Vue component in Preview when replacing it or unmounting (00b7658)
4.0.6 (2019-11-21)
- plugin: avoid fork-ts success notification (9ac7a09)
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.3 (2019-11-19)
4.0.2 (2019-11-18)
- import issue conflicts with babel (f1ac618), closes #635
- plugin: default custom components (9c45104)
4.0.1 (2019-11-15)
- mixed scoped and non-scoped slots render (4161ff2)
- plugin: es6 requires fix in plugin (205f7a1)
- warning when unnamed event param (df587dd)
- render event types as properties (48fc5e7)
- docgen: avoid setting exportName to deps (230e1e3)
- plugin: load styleguidist right (d4c6f6d)
- section depth needs too be taken (b663f1e)
- wrongly filtered and typed props array (3495840)
- avoid double progressBar (e39878e)
- move the build files to the right folder (9944972), closes #615
- publish templates with vsg (f8df33f)
- passing a webpackConfig should prioitize (683f3dc)
- split compiler & utils - efficient code split (9ef9d06)
- docgen: make docgen output arrays only (d456c6c)
- docgen: avoid outputing empty array (51d42bf)
- publish templates with vsg (f8df33f)
- review the style of default functions (98ae04c)
- plugin: better default config for (9a19cc4)
- make arrow functions default cleaner (f16b424)
- docgen: refactor bindings (b501f82)
- use bindings comments in styleguidist (4fb6551)
- review design of all props output (cc80bd5)
- use @values tag in props (cb2fc74), closes #345
- docgen: accept more tags for event params (cc55f58)
- docgen: add exportName to CompoentDoc (9466105)
- add option to disable progress bar (6ec4e9d)
- cli: expose docgen-cli config interfaces (25f0744)
- add plugin for docgen cli (a545aa5), closes #614
- add progress bar while compiling (f16b901)
- emit types for vue-styleguidist (f0af958)
- cli: use writeStream for better performance (25da08c)
- cli: use writeStream for better performance (25da08c)
- emit types for vue-styleguidist (f0af958)
- use the functional tag in docgen cli (c6f8725)
- add progress bar while compiling (f16b901)
- change defaults for codeSplit & simpleEditor (810bf1c)
- 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
- change defaults for
simpleEditormean thateditorConfigwill not work withoutsimpleEditor: false - compiler now exports compiler function as default
- isCodeVueSfc, styleScoper and adaptCreateElement are now their own package
3.26.2 (2019-10-30)
- move the build files to the right folder (9944972), closes #615
- make sure defaults are there for the plugin (eb9ef4c), closes #615
- make sure defaults are there for the plugin (00a05ac), closes #615
3.26.1 (2019-10-30)
- passing a webpackConfig should prioitize (683f3dc)
- split compiler & utils - efficient code split (9ef9d06)
- docgen: make docgen output arrays only (d456c6c)
- change defaults for codeSplit & simpleEditor (810bf1c)
- 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
- change defaults for
simpleEditormean thateditorConfigwill not work withoutsimpleEditor: false - compiler now exports compiler function as default
- isCodeVueSfc, styleScoper and adaptCreateElement are now their own package
- move the build files to the right folder (3b5aea1), closes #615
3.26.0 (2019-10-25)
- readable css class for JsDoc results (a56f341), closes #602
- use the functional tag in docgen cli (c6f8725)
3.25.0 (2019-10-15)
- docgen: add origin to documentation object (31e2fe2), closes #594
- docgen: allow wrap export in if (5744801)
- add sponsor button (59c7731)
3.24.2 (2019-09-26)
3.24.1 (2019-09-26)
- docgen: allow default to be a method (40ec2ae)
3.24.0 (2019-09-25)
- vue-docgen-cli if getDestFile should not create md file (55da63e)
3.23.2 (2019-09-24)
- add .vue to extension array in webpack config (65da41b)
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.23.0 (2019-09-19)
- compiler: styleScoper deals with deep (ff89890)
3.22.3 (2019-09-12)
- look at statements for description (71969bf)
3.22.2 (2019-08-24)
- Fix bad links to docs (a5a8978)
3.22.1 (2019-08-19)
- cli: take cwd param into account (7935956)
- compiler: avoid conflict, rollup buble+acorn (8c6d23a)
- if cwd is specified in cmd use to find config (2bf97a1)
3.22.0 (2019-08-19)
- update react styleguidist to fix menu (00ec66a), closes #561
- update react styleguidist to fix menu (2) (dba9fbf), closes #561
3.21.0 (2019-08-17)
- add defaultExamples config (52d7d90)
3.20.5 (2019-08-16)
Note: Version bump only for package vue-styleguidist
3.20.4 (2019-08-12)
- watcher looking at md files (536157d)
3.20.3 (2019-08-12)
- watch when input md changes (54ff5ac)
3.20.2 (2019-08-11)
- pages infinite lioop (9e5acad)
3.20.1 (2019-08-10)
- avoid defaulting outDir if outFile (8a2a282)
- avoid the squiggles in main menu (5cc8f93)
- protect pipe character in templates (0a0befc)
- cache compiled md in single file mode (b867235)
3.20.0 (2019-08-10)
- docgen: expose docs block in dogen-api (4565559)
- vue-docgen CLI to generate markdown files (b05d7d3)
3.19.5 (2019-08-07)
- EditorWithToolbar naming case (595a077)
- only precompile example for prod (b7aeb58)
3.19.4 (2019-08-06)
- webpack dependency for yarn + storybook (e4c5d2e)
3.19.3 (2019-08-06)
- add webpack peerDependency (16b1fa7)
- remove multiple dependencies (0927e85)
3.19.2 (2019-08-05)
- avoid dependency to webpack (63ee996)
3.19.1 (2019-08-04)
3.19.0 (2019-08-02)
- combining new Vue and imports was impossible (d37359c)
- default example only appear when no doc (b3b4156)
- webpackConfig has priority on publicPath (a06c1c6), closes #529
- wrong propTypes for playgroundAsync (3fffa13)
3.18.1 (2019-07-30)
- editor should update when changing page (35d0c3f)
3.18.0 (2019-07-28)
- add copyCodeButton option (90767af)
3.17.2 (2019-07-26)
- make codeSplit comptible with jsxInExamples (83c0bf6)
3.17.1 (2019-07-26)
- avoid skipping comps documented inline (6ee0dff)
3.17.0 (2019-07-23)
- make sure code split works with prism (51e7660)
- docgen: allow document scopedSlots in render (31a7e07), closes #174
- plugin: custom webpack config (2cf491c)
3.16.3 (2019-07-19)
- evaluation was failing (467949f)
- accept multiple style parts (9a6b031)
- slot scoped parsing (9685ba2)
- use style normalize sfc component (fcae13c)
3.16.2 (2019-07-17)
- compiler: make the jsx spread work vue style (27dd670)
- make regexp more precise (29ba8b5)
- use the spread in styleguidist (fd464a8)
- avoid loading pragma without jsx (5b5012b)
3.16.1 (2019-07-16)
3.16.0 (2019-07-15)
- docgen: allow for v-model in functional components (8884e62), closes #493
- bump clipboard-copy version (b3c86d9), closes #500
- rename createElement (429dd96)
- add Higher order funciton to Compile pragmas (5783eb4)
- allow compiler to render/compile JSX (5084a39)
- use styleguidePublicPath in server (bd5e3ec)
- use the JSX capabilities of compiler (a6db6cb)
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)
- codemirror: allow for mulitple words in cm themes (6168883), closes #480
- docgen: make aliases only path parts instead of letters (b83e235), closes #478
3.15.2 (2019-07-02)
- add simple bindings detection (31a3fca)
- make (Vue as VueConstructor) resolved (b7ed624)
- render default value empty string (f41869d)
- docgen: adapt method handler to default params (4f67f4e), closes #476
- docgen: make v-bind have a separate treatment (cee2a9b), closes #469
3.15.1 (2019-06-27)
- make sure imported variables are declared (bc50ab1)
- compiler: make sure files with the same name wont conflict (98a1b76), closes #471
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)
- compiler: re-enable compilation in vue SFC (5bb99c3), closes #456
- docgen: get slot and scoped slot description in render without JSX (33086cf)
3.14.3 (2019-06-10)
- reorder aliases to allow Styleguide overrides (9195772)
3.14.2 (2019-06-06)
- docgen: make sure v-slot templates are understood too (e9ab6d5)
3.14.1 (2019-06-05)
3.14.0 (2019-06-05)
- bring back last version of acorn (1f7ee42)
- add minimize options (93ad5d3)
3.13.10 (2019-06-04)
- detect pure template no script as sfc (e2a0a48)
- downgrade acorn (40b60cb)
- re-use the react hmr plugin (2dfc5ad)
3.13.9 (2019-05-29)
- preview: fix style scope mismatch (830abf8), closes #437
- preview: gracefully fail when Vue breaks (1152600), closes #435
3.13.8 (2019-05-29)
- remove useless ignores (043e4cc)
- editor: make sure when url changes editor is repainted (2dcbaac), closes #404
3.13.7 (2019-05-24)
- make hidden components work again (4898fee)
3.13.6 (2019-05-23)
3.13.5 (2019-05-22)
- Additionally try absolute require.resolve in resolvePathFrom (d1be583)
- Look through all roots. (3641e4c)
- core: remove self require in readme (b6408af), closes #407
3.13.4 (2019-05-15)
- docgen: fix node_modules mixins parsing (a4eed84), closes #416
- make sure node_module resolved path ignored (7a1092a)
3.13.3 (2019-05-14)
3.13.2 (2019-05-13)
3.13.1 (2019-04-29)
3.13.0 (2019-04-28)
3.12.0 (2019-04-25)
- docgen: add jsx option to docgen (0ce2a9e)
- main: add jsxInComponents option (27b4257)
- plugin: reference jsxInComponents in vueui (a9646ef)
3.11.7 (2019-04-23)
- keep dashes in component names (3ec75ed), closes #391
- make sure we detect all variables (118f1a8)
- parse es6 imports with vsg format (8f5ff19)
- remove getVars blocking imports (1066123)
3.11.6 (2019-04-23)
- ignored errors (#177) (#316) (298f462)
- make @arg and @argument accepted (1b0ddca)
- docgen: update method for unpassing tests (4f5c6cd)
3.11.5 (2019-04-20)
Note: Version bump only for package vue-styleguidist
3.11.4 (2019-04-03)
3.11.3 (2019-04-01)
- docgen: protect uresolved events (09d970f), closes #363
- options: allow two words in displayName (7b72603)
- plugin: add the whole package to eslintignore (3b13ccf)
- plugin: issue with babel (afbf21a)
- safety: update css-loader (0b074b8)
3.11.2 (2019-03-28)
Note: Version bump only for package vue-styleguidist