Commit e73bd4f

DaveTorreydjtorreyKocal

committed

Supports Vue3 and the switch to compiler-sfc (#440)

BREAKING CHANGE: Drop Vue 2 support, add Vue 3 support, thanks to @DaveTorrey! Vue 2 support is still available on https://github.com/Kocal/jsdoc-vuejs/tree/3.x branch. Co-authored-by: Dave Torrey <david.j.torrey@gmail.com> Co-authored-by: Hugo Alliaume <hugo@alliau.me>

1 parent 713bc25 commit e73bd4fCopy full SHA for e73bd4f

File tree

5 files changed

+2007

-2115

lines changed

README.md
example
- yarn.lock
lib/core
- vueScriptExtractor.js
package.json
yarn.lock

5 files changed

+2007

-2115

lines changed

`‎README.md`

Lines changed: 8 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -7,24 +7,27 @@ JSDoc for VueJS`
`7`	`7`	`[![codecov](https://codecov.io/gh/Kocal/jsdoc-vuejs/branch/master/graph/badge.svg)](https://codecov.io/gh/Kocal/jsdoc-vuejs)`
`8`	`8`	`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/850b7601f2bf4e8787a6aadbafa8afef)](https://www.codacy.com/app/kocal/jsdoc-vuejs?utm_source=github.com&utm_medium=referral&utm_content=Kocal/jsdoc-vuejs&utm_campaign=Badge_Grade)`
`9`	`9`
`10`		`-> A JSDoc plugin for listing props, data, computed data, and methods from *.vue files.`
	`10`	+A JSDoc plugin for listing props, data, computed data, and methods from `.vue` files.
	`11`	`+`
	`12`	+:warning: This branch is for Vue 3. If you still use Vue 2, please see [`3.x` branch](https://github.com/Kocal/jsdoc-vuejs/tree/3.x).
	`13`	`+`
	`14`	`+---`
`11`	`15`
`12`	`16`	`## Requirements`
`13`	`17`
`14`	`18`	`- Node 10+`
`15`		`-- Vue 2`
	`19`	`+- Vue 3`
`16`	`20`
`17`	`21`	`## Installation`
`18`	`22`
`19`	`23`	```bash
`20`	`24`	`$ npm install --save-dev jsdoc jsdoc-vuejs`
`21`	`25`	```
`22`	`26`
`23`		-You also need to install `vue-template-compiler` that match your Vue version:
	`27`	+You also need to install `@vue/compiler-sfc` that match your Vue version:
`24`	`28`
`25`	`29`	```bash
`26`		`-# if you use Vue 2.5.21`
`27`		`-$ npm install --save-dev vue-template-compiler@2.5.21`
	`30`	`+$ npm install --save-dev @vue/compiler-sfc`
`28`	`31`	```
`29`	`32`
`30`	`33`	`## Usage`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit e73bd4f

File tree

5 files changed

5 files changed

`‎README.md`

0 commit comments