Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supports Vue3 and the switch to compiler-sfc #440

Merged
merged 9 commits into from
Jul 8, 2021
Merged

Supports Vue3 and the switch to compiler-sfc #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
15084d7
Update vueScriptExtractor.js
DaveTorrey Jul 5, 2021
41a860e
added compiler-sfc
djtorrey Jul 5, 2021
d0a7771
fixed for vue3
djtorrey Jul 5, 2021
0aa7ae8
Update README.md
DaveTorrey Jul 5, 2021
ba3da7d
Update README.md
DaveTorrey Jul 5, 2021
9798670
adjusted packagejson
djtorrey Jul 5, 2021
e0a5b60
Merge branch 'master' of github.com:InvenTorrey/jsdoc-vuejs
djtorrey Jul 5, 2021
0ae4571
Update README.md
DaveTorrey Jul 8, 2021
df5138d
chore: cleanup
Kocal Jul 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,27 @@ JSDoc for VueJS
[![codecov](https://codecov.io/gh/Kocal/jsdoc-vuejs/branch/master/graph/badge.svg)](https://codecov.io/gh/Kocal/jsdoc-vuejs)
[![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)

> A JSDoc plugin for listing props, data, computed data, and methods from *.vue files.
A JSDoc plugin for listing props, data, computed data, and methods from `.vue` files.

: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).

---

## Requirements

- Node 10+
- Vue 2
- Vue 3

## Installation

```bash
$ npm install --save-dev jsdoc jsdoc-vuejs
```

You also need to install `vue-template-compiler` that match your Vue version:
You also need to install `@vue/compiler-sfc` that match your Vue version:

```bash
# if you use Vue 2.5.21
$ npm install --save-dev [email protected]
$ npm install --save-dev @vue/compiler-sfc
```

## Usage
Expand Down
Loading