fix(types): 生成两份声明文件[lib/esm]

Author: zhaozhiwen

README.md

@@ -1,6 +1,7 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+**Table of Contents** _generated with [DocToc](https://github.com/thlorenz/doctoc)_
 
 - [概览](#%E6%A6%82%E8%A7%88)
 - [准备工作](#%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C)
@@ -727,24 +728,28 @@ exports.onCreateWebpackConfig = args => {
 
 ```json
 {
-  "typings": "types/index.d.ts", // 定义类型入口文件
+  "typings": "lib/index.d.ts", // 定义类型入口文件
   "scripts": {
-    "build:types": "tsc -p tsconfig.build.json" // 执行tsc命令生成类型声明文件
+    "build:types": "tsc -p tsconfig.build.json && cpr lib esm" // 执行tsc命令生成类型声明文件
   }
 }
 ```
 
+> 值得注意的是：此处使用`cpr`(需要手动安装)将`lib`的声明文件拷贝了一份，并将文件夹重命名为`esm`，用于后面存放 ES module 形式的组件。这样做的原因是保证用户手动按需引入组件时依旧可以获取自动提示。
+
+> 最开始的方式是将声明文件单独存放在`types`文件夹，但这样只有通过'happy-ui'引入才可以获取提示，而'happy-ui/esm/xxx'和'happy-ui/lib/xxx'就无法获取提示。
+
 **tsconfig.build.json**
 
 ```json
 {
   "extends": "./tsconfig.json",
   "compilerOptions": { "emitDeclarationOnly": true }, // 只生成声明文件
-  "exclude": ["**/__tests__/**", "**/demo/**", "node_modules", "lib", "esm", "types"] // 排除示例、测试以及打包好的文件夹
+  "exclude": ["**/__tests__/**", "**/demo/**", "node_modules", "lib", "esm"] // 排除示例、测试以及打包好的文件夹
 }
 ```
 
-执行`yarn build:types`，可以发现根目录下已经生成了`lib`文件夹（`tsconfig.json`中定义的`outDir`字段），目录结构与`components`文件夹保持一致，如下：
+执行`yarn build:types`，可以发现根目录下已经生成了`lib`文件夹（`tsconfig.json`中定义的`declarationDir`字段），目录结构与`components`文件夹保持一致，如下：
 
 **types**
 
@@ -900,7 +905,7 @@ exports.default = build;
 + "main": "lib/index.js",
   "scripts": {
     ...
-+   "clean": "rimraf types lib esm dist",
++   "clean": "rimraf lib esm dist",
 +   "build": "npm run clean && npm run build:types && gulp",
     ...
   },
@@ -1038,7 +1043,7 @@ const build = gulp.parallel(buildScripts);
 // ...
 ```
 
-执行`yarn build`，可以发现生成了`types`/`lib`/`esm`三个文件夹，观察`esm`目录，结构同`lib`/`types`一致，js 文件都是以`ES module`模块形式导入导出。
+执行`yarn build`，可以发现生成了`lib`/`esm`三个文件夹，观察`esm`目录，结构同`lib`一致，js 文件都是以`ES module`模块形式导入导出。
 
 **esm/alert/alert.js**
 

articles/chapter-1.md

@@ -2,7 +2,7 @@
   "name": "happy-ui",
   "version": "1.0.0",
   "description": "A React UI Library.",
-  "typings": "types/index.d.ts",
+  "typings": "lib/index.d.ts",
   "main": "lib/index.js",
   "module": "esm/index.js",
   "sideEffects": [
@@ -16,8 +16,8 @@
     "start": "npm run dev",
     "build:doc": "rimraf doc-site && docz build",
     "preview:doc": "docz serve",
-    "clean": "rimraf types lib esm dist",
-    "build:types": "tsc -p tsconfig.build.json",
+    "clean": "rimraf lib esm dist",
+    "build:types": "tsc -p tsconfig.build.json && cpr lib esm",
     "build": "npm run clean && npm run build:types && gulp",
     "release": "ts-node ./scripts/release.ts",
     "commit": "git-cz",
@@ -62,6 +62,7 @@
     "@umijs/fabric": "^1.2.12",
     "chalk": "^3.0.0",
     "commitizen": "^4.0.3",
+    "cpr": "^3.0.1",
     "cz-conventional-changelog": "^3.0.2",
     "doctoc": "^1.4.0",
     "docz": "^2.3.2-alpha.0",

articles/chapter-2.md

@@ -1,5 +1,5 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": { "emitDeclarationOnly": true },
-  "exclude": ["**/__tests__/**", "**/demo/**", "types", "node_modules", "lib", "esm"]
+  "exclude": ["**/__tests__/**", "**/demo/**", "node_modules", "lib", "esm"]
 }

articles/chapter-3.md

@@ -4736,6 +4736,16 @@ cosmiconfig@^6.0.0:
     path-type "^4.0.0"
     yaml "^1.7.2"
 
+cpr@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.npm.taobao.org/cpr/download/cpr-3.0.1.tgz#b9a55038b7cd81a35c17b9761895bd8496aef1e5"
+  integrity sha1-uaVQOLfNgaNcF7l2GJW9hJau8eU=
+  dependencies:
+    graceful-fs "^4.1.5"
+    minimist "^1.2.0"
+    mkdirp "~0.5.1"
+    rimraf "^2.5.4"
+
 create-ecdh@^4.0.0:
   version "4.0.3"
   resolved "https://registry.npm.taobao.org/create-ecdh/download/create-ecdh-4.0.3.tgz#c9111b6f33045c4697f144787f9254cdc77c45ff"
@@ -8110,6 +8120,11 @@ graceful-fs@^4.0.0, graceful-fs@^4.1.11, graceful-fs@^4.1.15, graceful-fs@^4.1.2
   resolved "https://registry.npm.taobao.org/graceful-fs/download/graceful-fs-4.2.3.tgz#4a12ff1b60376ef09862c2093edd908328be8423"
   integrity sha1-ShL/G2A3bvCYYsIJPt2Qgyi+hCM=
 
+graceful-fs@^4.1.5:
+  version "4.2.4"
+  resolved "https://registry.npm.taobao.org/graceful-fs/download/graceful-fs-4.2.4.tgz?cache=0&sync_timestamp=1588086876757&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fgraceful-fs%2Fdownload%2Fgraceful-fs-4.2.4.tgz#2256bde14d3632958c465ebc96dc467ca07a29fb"
+  integrity sha1-Ila94U02MpWMRl68ltxGfKB6Kfs=
+
 graphql-compose@^6.3.7:
   version "6.3.7"
   resolved "https://registry.npm.taobao.org/graphql-compose/download/graphql-compose-6.3.7.tgz#a252076818260d861bc01d5a8d1fcfc90cda3eff"