chore: config api-extractor

.gitignore

@@ -104,3 +104,4 @@ dist
 .tern-port
 
 lib
+temp

api-extractor.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "./lib/index.d.ts",
+  "bundledPackages": [ ],
+  // 生成 api 报告，生成的还没 .d.ts 看的舒服，关了
+  "apiReport": {
+    "enabled": false,
+    "reportFolder": "./lib/"
+  },
+  "docModel": {
+    "enabled": true
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "./lib/index.d.ts"
+  }
+}

package.json

@@ -15,11 +15,13 @@
   "homepage": "https://github.com/simonwong/fly-helper#readme",
   "scripts": {
     "test": "jest --coverage --verbose -u",
+    "api": "api-extractor run",
     "lint": "eslint --ext .js,.ts ./src",
     "lint:fix": "eslint --fix --ext .js,.ts ./src"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.7.7",
+    "@microsoft/api-extractor": "^7.7.0",
     "@types/jest": "^24.0.24",
     "@typescript-eslint/eslint-plugin": "^2.13.0",
     "@typescript-eslint/parser": "^2.13.0",

src/add.ts

@@ -0,0 +1,11 @@
+/**
+ * 1 + 1
+ * @returns 2
+ * @example
+ * ```ts
+ * add() => 2
+ * ```
+ *
+ * @beta
+ */
+export const add = () => 1 + 1

src/hello.ts

@@ -0,0 +1,12 @@
+/**
+ * 返回 hello 开头的字符串
+ * @param str - input string
+ * @returns 'hello xxx'
+ * @example
+ * ```ts
+ * hello('ts') => 'hello ts'
+ * ```
+ *
+ * @beta
+ */
+export const hello = (str: string) => `hello ${str}`

src/index.ts

@@ -1,3 +1,2 @@
-export default function myFirstFunc (str: string) {
-  return `hello ${str}`
-}
+export * from './hello'
+export * from './add'

test/add.test.ts

@@ -0,0 +1,13 @@
+import assert from 'assert'
+import { add } from '../src/add'
+
+describe('validate:', () => {
+  /**
+   * add
+   */
+  describe('add', () => {
+    test(' return 2 ', () => {
+      assert.strictEqual(add(), 2)
+    })
+  })
+})

test/hello.test.ts

@@ -0,0 +1,13 @@
+import assert from 'assert'
+import { hello } from '../src/hello'
+
+describe('validate:', () => {
+  /**
+   * hello
+   */
+  describe('hello', () => {
+    test(' return hello rollup ', () => {
+      assert.strictEqual(hello('rollup'), 'hello rollup')
+    })
+  })
+})