Skip to content

Commit 229756f

Browse files
authored
fix(deps): make vue-template-compiler a peer dependency (#158)
Close #157
1 parent 853d003 commit 229756f

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ JSDoc for VueJS
1515
$ npm install --save-dev jsdoc-vuejs
1616
```
1717

18+
You also need to install `vue-template-compiler` that match your Vue version:
19+
20+
```bash
21+
# if you use Vue 2.5.21
22+
$ npm install --save-dev vue-template-compiler@2.5.21
23+
```
24+
1825
## Usage
1926

2027
Your should update your JSDoc configuration to enable JSDoc-VueJS:

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@
3131
"homepage": "https://github.com/Kocal/jsdoc-vuejs#readme",
3232
"dependencies": {
3333
"ejs": "^2.6.1",
34-
"jsdoc": "^3.5.5",
35-
"vue-template-compiler": "^2.5.16"
34+
"jsdoc": "^3.5.5"
35+
},
36+
"peerDependencies": {
37+
"vue-template-compiler": ">= 2.0.0"
3638
},
3739
"devDependencies": {
3840
"@kocal/semantic-release-preset": "^1.1.0",
@@ -44,6 +46,7 @@
4446
"eslint-plugin-cypress": "^2.0.1",
4547
"eslint-plugin-import": "^2.13.0",
4648
"jest": "^23.4.2",
47-
"semantic-release": "^15.12.1"
49+
"semantic-release": "^15.12.1",
50+
"vue-template-compiler": "^2.5.21"
4851
}
4952
}

yarn.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3048,9 +3048,9 @@ has@^1.0.1:
30483048
function-bind "^1.1.1"
30493049

30503050
he@^1.1.0:
3051-
version "1.1.1"
3052-
resolved "https://registry.yarnpkg.com/he/-/he-1.1.1.tgz#93410fd21b009735151f8868c2f271f3427e23fd"
3053-
integrity sha1-k0EP0hsAlzUVH4howvJx80J+I/0=
3051+
version "1.2.0"
3052+
resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f"
3053+
integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==
30543054

30553055
home-or-tmp@^2.0.0:
30563056
version "2.0.0"
@@ -7662,10 +7662,10 @@ verror@1.10.0:
76627662
core-util-is "1.0.2"
76637663
extsprintf "^1.2.0"
76647664

7665-
vue-template-compiler@^2.5.16:
7666-
version "2.5.19"
7667-
resolved "https://registry.yarnpkg.com/vue-template-compiler/-/vue-template-compiler-2.5.19.tgz#c23fcbea22fe6c116814141d2e6680023d6456f2"
7668-
integrity sha512-SIoE8gvl0UjZ/wccwHhj0HUqL+kLkJNy/8v7TXElz6rqxqKOKLoAynVV4L78qHZOHhLoyRl5BOmUFQPPdcD5qw==
7665+
vue-template-compiler@^2.5.21:
7666+
version "2.5.21"
7667+
resolved "https://registry.yarnpkg.com/vue-template-compiler/-/vue-template-compiler-2.5.21.tgz#a57ceb903177e8f643560a8d639a0f8db647054a"
7668+
integrity sha512-Vmk5Cv7UcmI99B9nXJEkaK262IQNnHp5rJYo+EwYpe2epTAXqcVyExhV6pk8jTkxQK2vRc8v8KmZBAwdmUZvvw==
76697669
dependencies:
76707670
de-indent "^1.0.2"
76717671
he "^1.1.0"

0 commit comments

Comments
 (0)