SoftwareBrothers / better-docs

Beautiful toolbox for jsdoc generated documentation - with 'typescript', `category` and `component` plugins
MIT License
858 stars 127 forks source link

feat: Vue 3 Support #109

Open crutch12 opened 4 years ago

crutch12 commented 4 years ago

Add vue 3 support

crutch12 commented 4 years ago

1) To support vue3 we have to update vue-docgen-api version to latest (4.33.0)

vueDocs.parse is async function now so it requires to rewrite code with async functions

abulka commented 2 years ago

Also, I'm unable to use @component with my vue 3 project. When I run jsdoc with the @component plugin enabled, I get the error:

Vue packages version mismatch:

- vue@3.2.33 (/Volumes/SSD/Data/Devel/midi-play/chordjammer/node_modules/vue/index.js)
- vue-template-compiler@2.6.14 (/Volumes/SSD/Data/Devel/midi-play/chordjammer/node_modules/vue-template-compiler/package.json)

This may cause things to work incorrectly. Make sure to use the same version for both.
If you are using vue-loader@>=10.0, simply update vue-template-compiler.
If you are using vue-loader@<10.0 or vueify, re-installing vue-loader/vueify should bump vue-template-compiler to the latest.

Looks like another thing that has to be fixed for vue 3 support.

RaphaelMcledger commented 1 year ago

Also, I'm unable to use @component with my vue 3 project. When I run jsdoc with the @component plugin enabled, I get the error:

Vue packages version mismatch:

- vue@3.2.33 (/Volumes/SSD/Data/Devel/midi-play/chordjammer/node_modules/vue/index.js)
- vue-template-compiler@2.6.14 (/Volumes/SSD/Data/Devel/midi-play/chordjammer/node_modules/vue-template-compiler/package.json)

This may cause things to work incorrectly. Make sure to use the same version for both.
If you are using vue-loader@>=10.0, simply update vue-template-compiler.
If you are using vue-loader@<10.0 or vueify, re-installing vue-loader/vueify should bump vue-template-compiler to the latest.

Looks like another thing that has to be fixed for vue 3 support.

Me too, no solution ?