docs(typescript): add solution for typescript compile error

chengpeiquan · Apr 6, 2024 · fbf944a · fbf944a
1 parent 3ea85f9
commit fbf944a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/.vitepress/theme/styles/custom.css b/.vitepress/theme/styles/custom.css
@@ -10,3 +10,7 @@ body {
 .vp-doc li + li {
   text-align: justify;
 }
+
+.vp-doc .custom-block a {
+  text-decoration: underline;
+}
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -8,6 +8,12 @@ outline: 'deep'
 
 考虑到后面还会不定期更新内容，所以翻了一下之前跟朋友的微信聊天记录整理了前期的更新记录，之后当文档有再次更新的时候也会继续整理更新记录，方便读者们查阅。
 
+## 2024-04-06
+
+在 [快速上手 TypeScript](typescript.md) 一章里的 “如何编译为 JavaScript 代码” 一节，对 build script 中新增了一个选项 `--skipLibCheck` ，关于这个改动请见 [干净的 TypeScript 项目在编译时报错 Cannot find module 'undici-types' 的原因和解决](https://chengpeiquan.com/article/typescript-error-cannot-find-module-undici-types.html) 一文。
+
+感谢 [@rainmonG](https://github.com/rainmonG) 在 [#193 (comment)](https://github.com/chengpeiquan/learning-vue3/issues/193#issuecomment-2036541817) 的反馈。
+
 ## 2024-02-20
 
 在 [单组件的编写](component.md) 、 [路由的使用](router.md) 、 [插件的开发和使用](plugin.md) 、 [组件之间的通信](communication.md) 、 [全局状态管理](pinia.md) 这几张内容的最前面，补充了一个阅读提示，解答近期收到的读者反馈的一些疑惑。
@@ -40,7 +46,7 @@ outline: 'deep'
 
 ## 2022-11-17
 
-更新了 “用 ES Module 设计模块” 中关于 [命名导出和导入](guide.md#命名导出和导入-1) 的讲解，减少在理解上的歧义，感谢 [@Yeshan-Taoist](https://github.com/Yeshan-Taoist) 在 [#163 (commont)](https://github.com/chengpeiquan/learning-vue3/issues/163#issuecomment-1317193359) 的反馈。
+更新了 “用 ES Module 设计模块” 中关于 [命名导出和导入](guide.md#命名导出和导入-1) 的讲解，减少在理解上的歧义，感谢 [@Yeshan-Taoist](https://github.com/Yeshan-Taoist) 在 [#163 (comment)](https://github.com/chengpeiquan/learning-vue3/issues/163#issuecomment-1317193359) 的反馈。
 
 ## 2022-11-12
 

diff --git a/docs/typescript.md b/docs/typescript.md
@@ -1179,7 +1179,7 @@ foo = true // true
     "dev:cjs": "node src/cjs/index.cjs",
     "dev:esm": "node src/esm/index.mjs",
     "dev:ts": "ts-node src/ts/index.ts",
-    "build": "tsc src/ts/index.ts --outDir dist",
+    "build": "tsc src/ts/index.ts --skipLibCheck --outDir dist",
     "compile": "babel src/babel --out-dir compiled",
     "serve": "node server/index.js"
   },
@@ -1201,6 +1201,10 @@ foo = true // true
 
 其中 `tsc` 是 TypeScript 用来编译文件的命令， `--outDir` 是它的一个选项，用来指定输出目录，如果不指定，则默认生成到源文件所在的目录下面。
 
+:::tip
+笔者 2024-04-06 注：在 build script 中新增了一个选项 `--skipLibCheck` ，关于这个改动请见 [干净的 TypeScript 项目在编译时报错 Cannot find module 'undici-types' 的原因和解决](https://chengpeiquan.com/article/typescript-error-cannot-find-module-undici-types.html) 一文。
+:::
+
 把之前在 [函数的重载](#函数的重载) 用过的这个例子放到 `src/ts/index.ts` 文件里，因为它是一段比较典型的、包含了多个知识点的 TypeScript 代码：
 
 ```ts
@@ -1381,7 +1385,7 @@ Welcome, Petter!
   // ...
   "scripts": {
     // ...
-    "build": "tsc src/ts/index.ts --outDir dist --target es6"
+    "build": "tsc src/ts/index.ts --skipLibCheck --outDir dist --target es6"
   }
   // ...
 }