Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

Commit d03e522

Browse files
committed
feat(types): added automatic declaration types
BREAKING CHANGE: Declaration types are now generated using Microsoft api-extractor
1 parent 8193733 commit d03e522

File tree

7 files changed

+275
-3
lines changed

7 files changed

+275
-3
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
branches:
66
- master
7+
- next
78
- dev
89

910
jobs:

.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ jobs:
1818
run: npm ci
1919
- name: Build Library
2020
run: npm run build
21+
- name: Build Types Declarations
22+
run: npm run build:dts
2123
- name: Run tests
2224
run: npm run test
2325
- name: Release

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ node_modules
66
/coverage
77
/tests/e2e/videos/
88
/tests/e2e/screenshots/
9-
9+
/temp
1010
# local env files
1111
.env.local
1212
.env.*.local

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ yarn.lock
1919
/coverage
2020
/.vscode
2121
/tests
22+
/temp

api-extractor.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
4+
"mainEntryPointFilePath": "./dist/src/index.d.ts",
5+
6+
"apiReport": {
7+
"enabled": true,
8+
"reportFolder": "<projectFolder>/temp/"
9+
},
10+
11+
"docModel": {
12+
"enabled": true
13+
},
14+
15+
"dtsRollup": {
16+
"enabled": true,
17+
"untrimmedFilePath": "./dist/as-dynamics-form.d.ts"
18+
},
19+
20+
"tsdocMetadata": {
21+
"enabled": false
22+
},
23+
24+
"messages": {
25+
"compilerMessageReporting": {
26+
"default": {
27+
"logLevel": "warning"
28+
}
29+
},
30+
31+
"extractorMessageReporting": {
32+
"default": {
33+
"logLevel": "warning",
34+
"addToApiReportFile": true
35+
},
36+
37+
"ae-missing-release-tag": {
38+
"logLevel": "none"
39+
}
40+
},
41+
42+
"tsdocMessageReporting": {
43+
"default": {
44+
"logLevel": "warning"
45+
}
46+
}
47+
}
48+
}

package-lock.json

Lines changed: 215 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,15 @@
1515
"access": "public"
1616
},
1717
"release": {
18-
"branches": ["master", "next"]
18+
"branches": [
19+
"master",
20+
"next"
21+
]
1922
},
2023
"scripts": {
2124
"serve": "vue-cli-service serve",
2225
"build": "rollup -c rollup.config.js",
26+
"build:dts": "api-extractor run --local --verbose && tail -n +7 >> dist/as-dynamic-forms.d.ts",
2327
"lint": "vue-cli-service lint",
2428
"test:watch": "vue-cli-service test:unit --verbose --no-cache --watchAll",
2529
"test": "vue-cli-service test:unit",
@@ -37,7 +41,7 @@
3741
"vue": "^3.0.0-rc.10"
3842
},
3943
"devDependencies": {
40-
"vue": "^3.0.0-rc.10",
44+
"@microsoft/api-extractor": "^7.9.15",
4145
"@rollup/plugin-buble": "^0.21.3",
4246
"@rollup/plugin-commonjs": "^15.0.0",
4347
"@rollup/plugin-node-resolve": "^9.0.0",
@@ -71,6 +75,7 @@
7175
"tailwindcss": "^1.8.10",
7276
"ts-node": "^9.0.0",
7377
"typescript": "~4.0.2",
78+
"vue": "^3.0.0-rc.10",
7479
"vue-select": "3.10.8",
7580
"vue-template-compiler": "2.6.12",
7681
"vuepress": "1.5.4"

0 commit comments

Comments
 (0)