Skip to content

Commit 8196005

Browse files
authored
Release v2
Release v2
2 parents 144a454 + 60a188c commit 8196005

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+3252
-2698
lines changed

.eslintrc.json

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,36 @@
11
{
2-
"extends": "standard",
2+
"extends": [
3+
"airbnb-base"
4+
],
35
"env": {
46
"es6": true,
57
"node": true,
6-
"jest": true
8+
"jest": true,
9+
"cypress/globals": true
10+
},
11+
"plugins": [
12+
"cypress"
13+
],
14+
"settings": {
15+
"import/core-modules": [
16+
"jsdoc/env"
17+
]
18+
},
19+
"rules": {
20+
"no-param-reassign": ["error", {
21+
"props": true,
22+
"ignorePropertyModificationsFor": [
23+
"doclet", // _isVueFile, ...
24+
"e" // for e.doclet
25+
]
26+
}],
27+
"no-underscore-dangle": ["error", {
28+
"allow": [
29+
"_isVueDoc",
30+
"_vueProps",
31+
"_vueData",
32+
"_vueComputed"
33+
]
34+
}]
735
}
8-
}
36+
}

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,6 @@ typings/
5757
# dotenv environment variables file
5858
.env
5959

60-
/example/docs/
61-
coverage
60+
example/docs*
61+
cypress/screenshots/
62+
cypress/videos/

.travis.yml

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,39 @@
1+
sudo: false
2+
dist: trusty
3+
14
language: node_js
25
node_js:
3-
- "8"
4-
- "7"
56
- "6"
7+
- "8"
8+
- "9"
9+
- "10"
10+
11+
cache:
12+
yarn: true
13+
directories:
14+
- node_modules
15+
- example/node_modules
16+
- ~/.cache
617

718
before_install:
8-
- curl -o- -L https://yarnpkg.com/install.sh | bash
9-
- export PATH="$HOME/.yarn/bin:$PATH"
19+
- npm i -g yarn
1020

1121
install:
1222
- yarn
1323
- cd example && yarn && cd ..
24+
- yarn cypress install
1425

1526
before_script:
16-
- cd example && yarn docs && cd ..
27+
- export DISPLAY=:99.0
28+
- sh -e /etc/init.d/xvfb start
29+
- cd example
30+
- yarn docs
31+
- yarn docs:docstrap
32+
- yarn docs:minami
33+
- yarn docs:tui
34+
- cd ..
1735

1836
script:
1937
- yarn lint
20-
- yarn test
21-
22-
after_success: cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
38+
- yarn test -i && yarn codecov
39+
- yarn cypress run --browser chrome --config watchForFileChanges=false

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Changelog
2+
3+
## 2.0.0
4+
5+
### Features
6+
7+
- Added `@vue-prop` tag (#59)
8+
- Added `@vue-data` tag (#59)
9+
- Added `@vue-computed` tag (#59)
10+
- Added rendering system to support more JSDoc templates (#59)
11+
- Rewrote default renderer (#64)
12+
- Added [docstrap](https://github.com/docstrap/docstrap) renderer (#65)
13+
- Added [tui](https://github.com/nhnent/tui.jsdoc-template) renderer (#66)
14+
- Added [minami](https://github.com/nijikokun/minami) renderer (#67)
15+
16+
### Removals
17+
18+
- Removed `followImports` config (#53)
19+
- Removed configuration system (#53)
20+
- Removed source transformation (Babel) (#55)
21+
- Removed Vue component script evaluation (#57)
22+
- Removed Vue lifecycle hooks listing (#59)
23+
- Removed `@vue` tag (#59)
24+
25+
### Internals
26+
27+
- Use [Cypress](https://cypress.io) for E2E testing (#59)

0 commit comments

Comments
 (0)