refactor(root): 添加 typescript

Author: suanmei

.babelrc

@@ -1,14 +1,4 @@
 {
-  "presets": [
-    [
-      "env",
-      {
-        "modules": false
-      }
-    ]
-  ],
-  "plugins": [
-    "transform-runtime"
-  ]
+  "presets": ["@babel/env", "@babel/typescript"],
+  "plugins": ["@babel/proposal-class-properties", "@babel/proposal-object-rest-spread"]
 }
-

.eslintcache

@@ -0,0 +1 @@
+[{"/Users/shiyi/github/callapp-lib/src/browser.ts":"1","/Users/shiyi/github/callapp-lib/src/evoke.ts":"2","/Users/shiyi/github/callapp-lib/src/generate.ts":"3","/Users/shiyi/github/callapp-lib/src/index.ts":"4","/Users/shiyi/github/callapp-lib/src/types.ts":"5"},{"size":1364,"mtime":1591692519227,"results":"6","hashOfConfig":"7"},{"size":2322,"mtime":1591692519227,"results":"8","hashOfConfig":"7"},{"size":2818,"mtime":1591692519227,"results":"9","hashOfConfig":"7"},{"size":3568,"mtime":1591692986922,"results":"10","hashOfConfig":"7"},{"size":916,"mtime":1591692519228,"results":"11","hashOfConfig":"7"},{"filePath":"12","messages":"13","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1k5k9j8",{"filePath":"14","messages":"15","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"16","messages":"17","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"18","messages":"19","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"20","messages":"21","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/shiyi/github/callapp-lib/src/browser.ts",[],"/Users/shiyi/github/callapp-lib/src/evoke.ts",[],"/Users/shiyi/github/callapp-lib/src/generate.ts",[],"/Users/shiyi/github/callapp-lib/src/index.ts",[],"/Users/shiyi/github/callapp-lib/src/types.ts",[]]

.eslintrc.js

@@ -1,11 +1,31 @@
 module.exports = {
-  "env": {
-    "browser": true,
+  extends: ['airbnb-base', 'plugin:import/typescript', 'plugin:unicorn/recommended', 'prettier'],
+  plugins: ['prettier', 'unicorn'],
+  env: {
+    node: true,
+    browser: true,
   },
-  "extends": "airbnb-base",
-  'rules': {
-    "import/no-extraneous-dependencies": ["error", {
-      "devDependencies": true,
-    }],
-  }
-};
+  rules: {
+    'import/no-extraneous-dependencies': ['error', { peerDependencies: true }],
+    'prettier/prettier': 'error',
+    'unicorn/prevent-abbreviations': 'off',
+  },
+  overrides: [
+    {
+      files: ['*.ts'],
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint'],
+      extends: [
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended',
+        'prettier/@typescript-eslint',
+      ],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        'no-param-reassign': 'off',
+        // airbnb 配置导致 tsx 文件引用一直报错
+        'import/extensions': ['error', 'ignorePackages', { ts: 'never' }],
+      },
+    },
+  ],
+};

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "endOfLine": "lf",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "printWidth": 100,
+  "trailingComma": "es5"
+}

README.md

@@ -1,32 +1,32 @@
-## callapp-lib
+# callapp-lib
 
 callapp-lib 是一个 H5 唤起 APP 的解决方案，能够满足大部分唤起客户端的场景，也预留了扩展口，帮你实现一些定制化的功能。
 
-如果你想了解一些唤端的原理知识，或者阅读下面的文档有不理解的名词，可以访问这篇博客 [H5唤起APP指南](https://suanmei.github.io/2018/08/23/h5_call_app/) 。
+如果你想了解一些唤端的原理知识，或者阅读下面的文档有不理解的名词，可以访问这篇博客 [H5 唤起 APP 指南](https://suanmei.github.io/2018/08/23/h5_call_app/) 。
 
-如果你在使用 callapp-lib 的过程中，有好的想法或者发现了bug，提 Issue 就行，作者会及时跟进。
+如果你在使用 callapp-lib 的过程中，有好的想法或者发现了 bug，提 Issue 就行，作者会及时跟进。
 
 ## Install
 
 Install with [npm](https://www.npmjs.com/):
 
-``` sh
-$ npm install --save callapp-lib
+```sh
+npm install --save callapp-lib
 ```
 
 ## Usage
 
-``` js
+```js
 const CallApp = require('callapp-lib');
 
-or
+or;
 
 import CallApp from 'callapp-lib';
 ```
 
-callapp-lib 同样支持 `script` 加载，你可以使用下面的 **cdn文件（地址在下面的示例中）**，也可以下载 `dist/index.umd.js` 到你的项目中，`index.umd.js` 会暴露一个全局变量 `CallApp` ，这个全局变量和上面 `commonjs` 导入的 `CallApp` 内容是一致的，使用方法也是一致的。
+callapp-lib 同样支持 `script` 加载，你可以使用下面的 **cdn 文件（地址在下面的示例中）**，也可以下载 `dist/index.umd.js` 到你的项目中，`index.umd.js` 会暴露一个全局变量 `CallApp` ，这个全局变量和上面 `commonjs` 导入的 `CallApp` 内容是一致的，使用方法也是一致的。
 
-``` html
+```html
 <!-- 及时下载未压缩的最新版本 Js -->
 <script src="https://unpkg.com/callapp-lib"></script>
 
@@ -43,22 +43,22 @@ or
 
 callapp-lib 中传递出来的是一个类，你需要将它实例化，然后才能去调用实例对象的方法。
 
-``` js
+```js
 const options = {
   key1: 'xxx',
-  key2: 'xxx'
+  key2: 'xxx',
 };
 const callLib = new CallApp(options);
 
 callLib.open({
   param: {},
-  path: 'xxx'
+  path: 'xxx',
 });
 ```
 
 ## Demo
 
-请访问[demo页面](https://raw.githack.com/suanmei/callapp-lib/master/example/index.html)，或访问[demo文件](https://github.com/suanmei/callapp-lib/blob/master/example/index.html)
+请访问[demo 页面](https://raw.githack.com/suanmei/callapp-lib/master/example/index.html)，或访问[demo 文件](https://github.com/suanmei/callapp-lib/blob/master/example/index.html)
 
 如果你在使用移动端，可以扫描下方二维码:
 
@@ -75,30 +75,30 @@ callLib.open({
 类型: `object`  
 必填: ✅
 
-用来配置 URL Scheme 所必须的那些v字段。
+用来配置 URL Scheme 所必须的那些 v 字段。
 
-+ protocol 
+- protocol
 
   类型: `string`  
   必填: ✅
 
   APP 协议，URL Scheme 的 scheme 字段，就是你要打开的 APP 的标识。
 
-+ host
+- host
 
   类型: `string`  
   必填: ❎
 
   URL Scheme 的 host 字段。
 
-+ port
+- port
 
   类型: `string` | `number`  
   必填: ❎
 
   URL Scheme 的 port 字段。
 
-### <s>protocol</s> 
+### protocol
 
 callapp-lib 2.0.0 版本已移除，原先的 protocol 移入到新增的 scheme 属性中
 
@@ -111,45 +111,45 @@ callapp-lib 2.0.0 版本已移除，原先的 protocol 移入到新增的 scheme
 
 例：`youku://ykshortvideo?url=xxx`
 
-+ protocol (2.0.0 版本由原先的 protocal 修改为 protocol，原先的 protocal 是拼写错误)
+- protocol (2.0.0 版本由原先的 protocal 修改为 protocol，原先的 protocal 是拼写错误)
 
   同 URL Scheme 的 scheme 字段，在你的 APP 就和上面的 protocol 属性值相同，在其他 APP 打开就传该 APP 的 scheme 标识。
 
-+ path
+- path
 
   参考 URL Scheme 的 path 字段，它代表了该 APP 的具体的某个功页面（功能），这里的 path 就是对应的中间页。
 
-+ key
+- key
 
   既然只是中间页，它自然要打开我们真正要打开的页面，所以我们需要把要打开的页面的 URL Scheme 传递过去。就像前端从 URL 的 query 字符串里面取值一样，客户端也是从 URL Scheme 里面来取。至于参数 key 定成什么，大家自己去协商吧，上面的示例中 `url` 也只是一个示例。
 
 ### intent
 
 类型: `object`  
-必填: ❎   
+必填: ❎
 
 安卓原生谷歌浏览器必须传递 Intent 协议地址，才能唤起 APP。
 
 它支持以下五个属性，其中 scheme 和 上面的 protocal 一样，其他四个都是 apk 相关信息，其中 package 和 scheme 必传：
 
-  + package
-  + action
-  + category
-  + component
-  + scheme
+- package
+- action
+- category
+- component
+- scheme
 
 ### universal
 
 类型: `object`  
 必填: ❎
 
-如果你们的 ios 工程师没有做相应的配置来让 APP 支持 Universal Link，你可以不用传递， *callap-lib* 将会使用 URL Scheme 来替代它。
+如果你们的 ios 工程师没有做相应的配置来让 APP 支持 Universal Link，你可以不用传递， _callap-lib_ 将会使用 URL Scheme 来替代它。
 
-+ host
+- host
 
   你的 Universal Link 的域名，`apple-app-site-association` 文件就放在这个域名对应的服务器上。
 
-+ pathKey
+- pathKey
 
   pathKey 就和前面 Intent 的 key 属性一样，只是这里的 pathKey 是客户端用来提取 path 信息的，以便知道调用的是 APP 的哪个页面。这个值也是需要你和 ios 童鞋协商定下来的。
 
@@ -200,41 +200,41 @@ url scheme 自定义拼接函数，内置的 buildScheme 函数是按照 uri 规
 
 ### open
 
-唤端功能。接收一个对象作为参数，该对象支持以下属性：  
+唤端功能。接收一个对象作为参数，该对象支持以下属性：
+
+- path
 
-+ path
+  类型: `string`
+  必填: ✅
 
-  类型: `string` 
-  必填: ✅  
+  需要打开的页面对应的值，URL Scheme 中的 path 部分，参照 [H5 唤起 APP 指南](https://suanmei.github.io/2018/08/23/h5_call_app/) 一文中的解释。
 
-  需要打开的页面对应的值，URL Scheme 中的 path 部分，参照 [H5唤起APP指南](https://suanmei.github.io/2018/08/23/h5_call_app/) 一文中的解释。
-  
   只想要直接打开 app ，不需要打开特定页面，path 传空字符串 `''` 就可以。
 
-+ param
+- param
 
   类型: `object`  
-  必填: ❎   
+  必填: ❎
 
   打开 APP 某个页面，它需要接收的参数。
 
-+ callback 
-  必填: ❎  
+- callback
+  必填: ❎
 
-  类型: `function`  
+  类型: `function`
 
-  自定义唤端失败回调函数。传递 `callback` 会覆盖 *callapp-lib* 库中默认的唤端失败处理逻辑。
+  自定义唤端失败回调函数。传递 `callback` 会覆盖 _callapp-lib_ 库中默认的唤端失败处理逻辑。
 
 ### generateScheme
 
 接收一个对象作为参数，该对象包含以下属性：
 
-+ path
-+ param
+- path
+- param
 
 属性含义和 `open` 方法参数的属性一致。
 
-返回 URL Scheme。如果你觉得 *callapp-lib* 的唤端处理方式不符合你的需求，但你又不想费心费力的自己去拼凑 URL Scheme，可以利用这个方法直接生成。
+返回 URL Scheme。如果你觉得 _callapp-lib_ 的唤端处理方式不符合你的需求，但你又不想费心费力的自己去拼凑 URL Scheme，可以利用这个方法直接生成。
 
 ### generateIntent