chore: introduce api-extractor

ktsn · ktsn · commit 692362833332 · 2020-05-06T02:01:43.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,4 @@ node_modules
 example/build.js
 example/build.js.map
 docs/.vuepress/dist
-test/test.build.js
 lib
diff --git a/api-extractor.json b/api-extractor.json
@@ -0,0 +1,56 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+
+  "apiReport": {
+    "enabled": false
+  },
+
+  "docModel": {
+    "enabled": false
+  },
+
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+  },
+
+  "tsdocMetadata": {
+    "enabled": false
+  },
+
+  "newlineKind": "lf",
+
+  /**
+   * Configures how API Extractor reports error and warning messages produced during analysis.
+   *
+   * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
+   */
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      }
+    },
+
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "main": "dist/vue-class-component.common.js",
   "module": "dist/vue-class-component.esm.js",
   "unpkg": "dist/vue-class-component.js",
-  "typings": "lib/index.d.ts",
+  "typings": "dist/vue-class-component.d.ts",
   "files": [
     "dist",
     "lib",
@@ -53,6 +53,7 @@
     "@babel/plugin-proposal-decorators": "^7.7.4",
     "@babel/preset-env": "^7.7.7",
     "@babel/preset-typescript": "^7.8.3",
+    "@microsoft/api-extractor": "^7.7.13",
     "@types/jest": "^25.1.3",
     "@types/node": "^13.1.6",
     "@vue/compiler-sfc": "^3.0.0-beta.4",
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -37,21 +37,21 @@ export function createDecorator(
   }
 }
 
-interface PropsMixin {
+export interface PropsMixin {
   new <Props = unknown>(...args: any[]): {
     $props: Props
   }
 }
 
-type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
   k: infer I
 ) => void
   ? I
   : never
 
-type ExtractInstance<T> = T extends VueMixin<infer V> ? V : never
+export type ExtractInstance<T> = T extends VueMixin<infer V> ? V : never
 
-type MixedVueBase<Mixins extends VueMixin[]> = Mixins extends (infer T)[]
+export type MixedVueBase<Mixins extends VueMixin[]> = Mixins extends (infer T)[]
   ? VueBase<UnionToIntersection<ExtractInstance<T>> & Vue> & PropsMixin
   : never
 
diff --git a/src/index.ts b/src/index.ts
@@ -1,8 +1,21 @@
-export { Vue } from './vue'
+/**
+ * Public APIs
+ */
+
+export { Vue, ClassComponentHooks } from './vue'
+
+export { Options, createDecorator, mixins, setup } from './helpers'
+
+/**
+ * Other types
+ */
+
+export { VueBase, VueMixin, VueStatic } from './vue'
+
 export {
-  Options,
   VueDecorator,
-  createDecorator,
-  mixins,
-  setup,
+  MixedVueBase,
+  UnionToIntersection,
+  ExtractInstance,
+  PropsMixin,
 } from './helpers'
diff --git a/src/vue.ts b/src/vue.ts
@@ -39,11 +39,11 @@ function getSuperOptions(Ctor: Function): ComponentOptions | undefined {
   return Super.__vccOpts
 }
 
-interface ClassComponentHooks {
+export interface ClassComponentHooks {
   /* To be extended on user land */
 }
 
-type VueStatic = {
+export type VueStatic = {
   [K in keyof typeof Vue]: typeof Vue[K]
 }
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,12 +9,13 @@
     "moduleResolution": "node",
     "outDir": "lib",
     "declaration": true,
+    "sourceMap": true,
+    "declarationMap": true,
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true
   },
   "include": [
     "src/**/*.ts"
-  ],
-  "compileOnSave": false
+  ]
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -37,21 +37,21 @@ export function createDecorator(`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`-interface PropsMixin {`
	`40`	`+export interface PropsMixin {`
`41`	`41`	`new <Props = unknown>(...args: any[]): {`
`42`	`42`	`$props: Props`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`-type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (`
	`46`	`+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (`
`47`	`47`	`k: infer I`
`48`	`48`	`) => void`
`49`	`49`	`? I`
`50`	`50`	`: never`
`51`	`51`
`52`		`-type ExtractInstance<T> = T extends VueMixin<infer V> ? V : never`
	`52`	`+export type ExtractInstance<T> = T extends VueMixin<infer V> ? V : never`
`53`	`53`
`54`		`-type MixedVueBase<Mixins extends VueMixin[]> = Mixins extends (infer T)[]`
	`54`	`+export type MixedVueBase<Mixins extends VueMixin[]> = Mixins extends (infer T)[]`
`55`	`55`	`? VueBase<UnionToIntersection<ExtractInstance<T>> & Vue> & PropsMixin`
`56`	`56`	`: never`
`57`	`57`
Original file line number	Diff line number	Diff line change
`@@ -39,11 +39,11 @@ function getSuperOptions(Ctor: Function): ComponentOptions \| undefined {`
`39`	`39`	`return Super.__vccOpts`
`40`	`40`	`}`
`41`	`41`
`42`		`-interface ClassComponentHooks {`
	`42`	`+export interface ClassComponentHooks {`
`43`	`43`	`/* To be extended on user land */`
`44`	`44`	`}`
`45`	`45`
`46`		`-type VueStatic = {`
	`46`	`+export type VueStatic = {`
`47`	`47`	`[K in keyof typeof Vue]: typeof Vue[K]`
`48`	`48`	`}`
`49`	`49`