TypeScript Academy · 课时

开始迁移:allowJs 与 checkJs

在 JavaScript 项目中启用 TypeScript 检查

第 1 / 4 课13 个步骤

开始迁移:allowJs 与 checkJs 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 4 节课。

迁移挑战

一次性将大型 JavaScript 代码库迁移到 TypeScript 存在风险。渐进式路径是逐步启用 TypeScript,按文件进行迁移,同时保持项目正常运行。

# Key compiler flags for gradual migration:
# allowJs — allow .js files in the compilation
# checkJs — type-check .js files with JSDoc types

第 1 步:安装 TypeScript

将 TypeScript 添加到项目中,并先创建一个初始不启用严格模式的最小 tsconfig。

npm install --save-dev typescript
npx tsc --init
# Edit tsconfig.json to set allowJs: true

allowJs: true

启用 allowJs: true 后,TypeScript 会将 .js 文件纳入编译范围。类型检查较为宽松——大多数 JavaScript 代码都能在不产生错误的情况下完成编译。

{
  "compilerOptions": {
    "allowJs": true,
    "outDir": "./dist",
    "target": "ES2020"
  },
  "include": ["src"]
}

checkJs: true

checkJs: true 会使用推断出的类型和 JSDoc 注释为 JavaScript 文件启用类型检查。这样无需转换为 .ts 文件,就能发现明显的错误。

{
  "compilerOptions": {
    "allowJs": true,
    "checkJs": true
  }
}

使用 @ts-nocheck 抑制错误

在有问题的 JS 文件顶部添加 // @ts-nocheck,即可在逐步进行迁移时抑制所有 TypeScript 错误。

// @ts-nocheck
// This file is not yet migrated — errors suppressed
function legacyUtil(x) { return x.foo.bar; }

按行抑制错误

使用 // @ts-ignore 抑制单行错误,而不必禁用整个文件的检查。

const result = legacyFn(value); // @ts-ignore
// Only this line's error is suppressed

maxNodeModuleJsDepth

默认情况下,TypeScript 只会检查项目中的 JS 文件。设置 maxNodeModuleJsDepth 可以控制它在 node_modules 中检查 JS 的深度。

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 1 // Check 1 level deep in node_modules
  }
}

将 JS 编译到 Dist

启用 allowJs 后,TypeScript 编译器也可以转译 JS 文件,这对于统一应用 polyfill 并面向较旧的运行环境很有用。

tsc
# Compiles both .ts and .js files to dist/

衡量进度

通过统计 .js 文件和 .ts 文件的数量来跟踪迁移进度。为每个迭代设定一个转换百分比目标。

find src -name "*.ts" | wc -l   # TypeScript files
find src -name "*.js" | wc -l   # JavaScript files remaining

避免类型回归

初始阶段保持 noImplicitAny: false,这样现有的 JS 文件就不会产生大量错误。将每个文件转换为 TypeScript 后,再启用它。

{
  "compilerOptions": {
    "allowJs": true,
    "noImplicitAny": false // Relax for JS files; enable per .ts file
  }
}

回顾:开始迁移

使用 allowJs: true 和 checkJs: true 开始迁移;对于尚未准备好的文件,使用 @ts-nocheck;并按文件数量跟踪进度。这种方式可以让项目在逐步转换文件的同时持续通过编译。

快速检查

checkJs: true 的作用是什么,同时又不要求将 .js 转换为 .ts?

您学到的内容

使用 allowJs: true,以及可选的 checkJs: true,开始 JS→TS 迁移。使用 @ts-nocheck 暂时忽略尚未准备好的文件,并按文件数量跟踪进度,逐步完成转换。

免费开始

用 AI 导师学习 TypeScript — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
101
课程
352

常见问题解答

「开始迁移:allowJs 与 checkJs」课时是免费的吗?

是的 — 「开始迁移:allowJs 与 checkJs」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 TypeScript Academy 课程的其余内容,请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 4 节课。

「开始迁移:allowJs 与 checkJs」这节课中我会学到什么?

在 JavaScript 项目中启用 TypeScript 检查 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 TypeScript Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。

「开始迁移:allowJs 与 checkJs」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 TypeScript Academy 课中编写并运行代码吗?

能。每节 TypeScript Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 开始迁移:allowJs 与 checkJs
  2. JSDoc 类型注解:过渡方案
  3. 逐文件转换策略
  4. 处理无类型的第三方库
← 返回 TypeScript Academy