chore: bundle typing into single d.ts file (#368)

Author: antfu

.gitignore

@@ -8,3 +8,4 @@ lib
 .idea
 .rpt2_cache
 TODO.md
+typings

package.json

@@ -26,7 +26,7 @@
   ],
   "scripts": {
     "start": "cross-env TARGET=es rollup -c -w",
-    "build": "rollup -c",
+    "build": "rimraf dist typings && tsc --emitDeclarationOnly && rollup -c",
     "lint": "prettier --write --parser typescript \"{src,test,test-dts}/*.ts?(x)\" && prettier --write \"{src,test}/*.js\"",
     "test": "cross-env NODE_ENV=test jest",
     "test-dts": "tsc -p ./test-dts/tsconfig.json && npm run build && tsc -p ./test-dts/tsconfig.build.json",
@@ -46,7 +46,9 @@
     "jest": "^26.0.1",
     "lint-staged": "^10.2.7",
     "prettier": "^2.0.5",
+    "rimraf": "^3.0.2",
     "rollup": "^2.12.0",
+    "rollup-plugin-dts": "^1.4.7",
     "rollup-plugin-terser": "^6.1.0",
     "rollup-plugin-typescript2": "^0.27.1",
     "ts-jest": "^26.1.0",

rollup.config.js

@@ -1,9 +1,9 @@
-import * as path from 'path';
-// import filesize from 'rollup-plugin-filesize';
-import typescript from 'rollup-plugin-typescript2';
-import resolve from '@rollup/plugin-node-resolve';
-import { terser } from 'rollup-plugin-terser';
-import replace from '@rollup/plugin-replace';
+import * as path from 'path'
+import typescript from 'rollup-plugin-typescript2'
+import resolve from '@rollup/plugin-node-resolve'
+import { terser } from 'rollup-plugin-terser'
+import replace from '@rollup/plugin-replace'
+import dts from 'rollup-plugin-dts'
 
 const builds = {
   'cjs-dev': {
@@ -31,14 +31,20 @@ const builds = {
     format: 'es',
     mode: 'development',
   },
-};
+}
+
+function onwarn(msg, warn) {
+  if (!/Circular/.test(msg)) {
+    warn(msg)
+  }
+}
 
 function getAllBuilds() {
-  return Object.keys(builds).map((key) => genConfig(builds[key]));
+  return Object.keys(builds).map((key) => genConfig(builds[key]))
 }
 
 function genConfig({ outFile, format, mode }) {
-  const isProd = mode === 'production';
+  const isProd = mode === 'production'
   return {
     input: './src/index.ts',
     output: {
@@ -51,18 +57,21 @@ function genConfig({ outFile, format, mode }) {
       name: format === 'umd' ? 'vueCompositionApi' : undefined,
     },
     external: ['vue'],
-    onwarn: (msg, warn) => {
-      if (!/Circular/.test(msg)) {
-        warn(msg);
-      }
-    },
+    onwarn,
     plugins: [
       typescript({
-        typescript: require('typescript'),
+        tsconfigOverride: {
+          declaration: false,
+          declarationDir: null,
+          emitDeclarationOnly: false,
+        },
+        useTsconfigDeclarationDir: true,
       }),
       resolve(),
       replace({
-        'process.env.NODE_ENV': JSON.stringify(isProd ? 'production' : 'development'),
+        'process.env.NODE_ENV': JSON.stringify(
+          isProd ? 'production' : 'development'
+        ),
         __DEV__:
           format === 'es'
             ? // preserve to be handled by bundlers
@@ -72,15 +81,26 @@ function genConfig({ outFile, format, mode }) {
       }),
       isProd && terser(),
     ].filter(Boolean),
-  };
+  }
 }
 
-let buildConfig;
+let buildConfig
 
 if (process.env.TARGET) {
-  buildConfig = genConfig(builds[process.env.TARGET]);
+  buildConfig = genConfig(builds[process.env.TARGET])
 } else {
-  buildConfig = getAllBuilds();
+  buildConfig = getAllBuilds()
 }
 
-export default buildConfig;
+// bundle typings
+buildConfig.push({
+  input: 'typings/index.d.ts',
+  output: {
+    file: 'dist/index.d.ts',
+    format: 'es',
+  },
+  onwarn,
+  plugins: [dts()],
+})
+
+export default buildConfig

tsconfig.json

@@ -3,6 +3,7 @@
     "target": "es5",
     "lib": ["dom", "esnext"],
     "declaration": true,
+    "declarationDir": "./typings",
     "module": "esnext",
     "moduleResolution": "node",
     "skipLibCheck": true,
@@ -19,5 +20,6 @@
     "downlevelIteration": true,
     "noUnusedLocals": true
   },
-  "include": ["src"]
+  "include": ["src"],
+  "exclude": ["typings"]
 }

yarn.lock

@@ -3406,13 +3406,20 @@ ret@~0.1.10:
   resolved "https://registry.yarnpkg.com/ret/-/ret-0.1.15.tgz#b8a4825d5bdb1fc3f6f53c2bc33f81388681c7bc"
   integrity sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==
 
-rimraf@^3.0.0:
+rimraf@^3.0.0, rimraf@^3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a"
   integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==
   dependencies:
     glob "^7.1.3"
 
+rollup-plugin-dts@^1.4.7:
+  version "1.4.7"
+  resolved "https://registry.yarnpkg.com/rollup-plugin-dts/-/rollup-plugin-dts-1.4.7.tgz#6255147ac777314c0725a1efcb42df10fe282243"
+  integrity sha512-QkunbJ96yUNkW95k/Vd6SdTjCbWSG0rMVUtpHSCwfg078Z7vbDaBnfz/gkSqR5h8WFMxoccBT4aodHm6387Jvg==
+  optionalDependencies:
+    "@babel/code-frame" "^7.8.3"
+
 rollup-plugin-terser@^6.1.0:
   version "6.1.0"
   resolved "https://registry.yarnpkg.com/rollup-plugin-terser/-/rollup-plugin-terser-6.1.0.tgz#071866585aea104bfbb9dd1019ac523e63c81e45"