Skip to content

Commit b2bf86c

Browse files
committed
Release 4.0.0-beta8
2 parents a91653b + ea93aca commit b2bf86c

File tree

242 files changed

+13279
-4102
lines changed

Some content is hidden

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

242 files changed

+13279
-4102
lines changed

.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
test/MethodParser.spec.js
22
test/issues.spec.js
3+
test/examples
4+
test/tutorial
35
jest.config.js
46
sample.js

.eslintrc.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,13 @@ rules:
134134
- anonymous: never
135135
named: never
136136
asyncArrow: always
137+
overrides:
138+
- files:
139+
- '**/test/**'
140+
env:
141+
jest: true
142+
rules:
143+
max-len: 'off'
144+
indent: 'off'
145+
no-template-curly-in-string: 'off'
146+
no-underscore-dangle: 'off'

.gitlab-ci.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ tests & coverage:
3131
paths:
3232
- coverage/
3333

34-
dependencies check:
34+
security audit:
3535
stage: security
3636
needs: &tests-jobs
3737
- code quality
3838
- dependencies outdated
3939
- tests & coverage
4040
script:
41-
- yarn audit --production
41+
- yarn audit --level high --groups dependencies
4242

4343
sast:
4444
stage: security
@@ -48,7 +48,7 @@ pages:
4848
stage: publish
4949
needs: &security-jobs
5050
- tests & coverage
51-
- dependencies check
51+
- security audit
5252
dependencies:
5353
- tests & coverage
5454
script:

CHANGELOG.md

+46
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,49 @@
1+
## Vuedoc Parser 4.0.0-beta8
2+
3+
This release comes with breaking changes and important new features.
4+
5+
### Important Features
6+
7+
- Handle Vue 3 syntax
8+
- Handle Vue Composition API
9+
10+
### Breaking Changes
11+
12+
- **Pure ESM package**
13+
14+
Vuedoc Parser 4.0.0 is now [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
15+
This means that Node 16+ is needed to use it and it must be imported instead of
16+
required.
17+
18+
Please see [this](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) for migration guide.
19+
20+
- **Rename `exports.parse()` to `exports.parseComponent()`**
21+
22+
`exports.parse()` has been renamed to `exports.parseComponent()`.
23+
24+
Please see [usage on documentation](https://gitlab.com/vuedoc/parser/-/tree/main#usage).
25+
26+
- **Add TypeScript definitions**
27+
28+
This release now includes [TypeScript definition](https://gitlab.com/vuedoc/parser/blob/main/index.d.ts).
29+
30+
- **Standardize extracted types**
31+
32+
All extracted types has been standardized to be TypeScript-like. This means:
33+
* Type `String` is now parsed as `string`
34+
* Type `Number` is now parsed as `number`
35+
* Type `Boolean` is now parsed as `boolean`
36+
* Type `Array` is now parsed as `array`
37+
* Type `Object` is now parsed as `object`
38+
* Type `Function` is now parsed as `function`
39+
* Type `Symbol` is now parsed as `symbol`
40+
41+
- **Remove deprecated `@model` tag**
42+
43+
Tag deprecated `@model` was removed. You now need to use the Vue standard way
44+
to define `v-model`.
45+
Please see [official documentation about annotating a `v-model` prop](https://gitlab.com/vuedoc/parser/-/tree/main#annotate-a-v-model-prop)
46+
147
## Vuedoc Parser v3.4.0
248

349
This release fixes some parsing issues and upgrades `@babel/parser` to

0 commit comments

Comments
 (0)