Skip to content

Commit db92787

Browse files
committed
build: align scripts with core
1 parent 3595d41 commit db92787

File tree

6 files changed

+213
-194
lines changed

6 files changed

+213
-194
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
/docs/.vuepress/dist
66
/docs/node_modules
77
/node_modules
8+
/temp
89
.idea/*
910
.vscode/*
1011
yarn-error.log

api-extractor.json

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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": false
17+
},
18+
19+
"tsdocMetadata": {
20+
"enabled": false
21+
},
22+
23+
"messages": {
24+
"compilerMessageReporting": {
25+
"default": {
26+
"logLevel": "warning"
27+
}
28+
},
29+
30+
"extractorMessageReporting": {
31+
"default": {
32+
"logLevel": "warning",
33+
"addToApiReportFile": true
34+
},
35+
36+
"ae-missing-release-tag": {
37+
"logLevel": "none"
38+
}
39+
},
40+
41+
"tsdocMessageReporting": {
42+
"default": {
43+
"logLevel": "warning"
44+
}
45+
}
46+
}
47+
}

package.json

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,27 @@
33
"version": "0.9.2",
44
"description": "Vuex ORM plugin for adding smooth integration with axios.",
55
"main": "dist/vuex-orm-axios.cjs.js",
6-
"browser": "dist/vuex-orm-axios.esm.js",
6+
"browser": "dist/vuex-orm-axios.esm-browser.js",
77
"module": "dist/vuex-orm-axios.esm-bundler.js",
88
"unpkg": "dist/vuex-orm-axios.global.js",
9+
"jsdelivr": "dist/vuex-orm-axios.global.js",
910
"typings": "dist/src/index.d.ts",
1011
"files": [
1112
"dist"
1213
],
1314
"scripts": {
1415
"build": "node scripts/build.js",
15-
"clean": "rm -rf dist coverage .nyc_output .tmp",
16-
"lint": "prettier --write --parser typescript \"{src,test}/**/*.ts\"",
16+
"build:dts": "api-extractor run --local --verbose",
17+
"clean": "rm -rf dist coverage temp .nyc_output .tmp",
18+
"lint": "prettier --check --write --parser typescript \"{src,test}/**/*.ts\"",
1719
"lint:fail": "prettier --check --parser typescript \"{src,test}/**/*.ts\"",
1820
"test": "jest",
1921
"test:watch": "jest --watch",
2022
"coverage": "jest --collect-coverage",
2123
"docs": "vuepress dev docs",
22-
"docs:build": "vuepress build docs",
24+
"docs:build": "yarn docs:build:guide && yarn docs:build:api",
25+
"docs:build:guide": "vuepress build docs",
26+
"docs:build:api": "yarn build && api-documenter markdown --input-folder temp --output-folder docs-api",
2327
"docs:deploy": "bash ./docs/deploy.sh",
2428
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
2529
"release": "node scripts/release.js"
@@ -48,6 +52,8 @@
4852
"axios": "^0.19.2"
4953
},
5054
"devDependencies": {
55+
"@microsoft/api-documenter": "^7.7.18",
56+
"@microsoft/api-extractor": "^7.7.13",
5157
"@rollup/plugin-commonjs": "^11.0.2",
5258
"@rollup/plugin-node-resolve": "^7.1.1",
5359
"@rollup/plugin-replace": "^2.3.1",

rollup.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import ts from 'rollup-plugin-typescript2'
66
import { terser } from 'rollup-plugin-terser'
77

88
const configs = [
9-
{ input: 'src/index.ts', file: 'dist/vuex-orm-axios.esm.js', format: 'es', browser: true, env: 'development' },
10-
{ input: 'src/index.ts', file: 'dist/vuex-orm-axios.esm.prod.js', format: 'es', browser: true, env: 'production' },
9+
{ input: 'src/index.ts', file: 'dist/vuex-orm-axios.esm-browser.js', format: 'es', browser: true, env: 'development' },
10+
{ input: 'src/index.ts', file: 'dist/vuex-orm-axios.esm-browser.prod.js', format: 'es', browser: true, env: 'production' },
1111
{ input: 'src/index.ts', file: 'dist/vuex-orm-axios.esm-bundler.js', format: 'es', env: 'development' },
1212
{ input: 'src/index.cjs.ts', file: 'dist/vuex-orm-axios.global.js', format: 'iife', env: 'development' },
1313
{ input: 'src/index.cjs.ts', file: 'dist/vuex-orm-axios.global.prod.js', format: 'iife', minify: true, env: 'production' },

scripts/build.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ const { gzipSync } = require('zlib')
55
const { compress } = require('brotli')
66

77
const files = [
8-
'dist/vuex-orm-axios.esm.js',
9-
'dist/vuex-orm-axios.esm.prod.js',
8+
'dist/vuex-orm-axios.esm-browser.js',
9+
'dist/vuex-orm-axios.esm-browser.prod.js',
1010
'dist/vuex-orm-axios.esm-bundler.js',
1111
'dist/vuex-orm-axios.global.js',
1212
'dist/vuex-orm-axios.global.prod.js',
@@ -16,6 +16,7 @@ const files = [
1616
async function run() {
1717
await build()
1818
checkAllSizes()
19+
generateApiDocs()
1920
}
2021

2122
async function build() {
@@ -44,4 +45,8 @@ function checkSize(file) {
4445
)
4546
}
4647

48+
async function generateApiDocs() {
49+
await execa('yarn', ['build:dts'], { stdio: 'inherit' })
50+
}
51+
4752
run()

0 commit comments

Comments
 (0)