JavaScript / TypeScript / 系统课时
初始化 TypeScript 项目
初始化 TypeScript 项目
本课从空目录开始建立一个可编译的 TypeScript 项目:初始化 npm、安装本地编译器、生成并精简 tsconfig.json,最后用一个源文件验证类型检查是否正常。完成后,你会得到清晰的 src 与 dist 目录约定。
学习目标
- 创建 npm 项目并把 TypeScript 安装为开发依赖
- 生成和配置
tsconfig.json - 编写首个
.ts文件并完成无输出类型检查
前置检查
项目需要 Node.js 和 npm。先在终端确认命令可用:
bash
node --version
npm --version预期输出:
text
v<MAJOR>.<MINOR>.<PATCH>
<MAJOR>.<MINOR>.<PATCH>实际版本号可能不同;只要两条命令都能返回版本且没有“command not found”即可继续。
创建项目并安装依赖
在准备存放代码的位置执行:
bash
mkdir ts-quick-start
cd ts-quick-start
npm init -y
npm install --save-dev typescript
npx tsc --init预期结果:
text
ts-quick-start/
├── node_modules/
├── package-lock.json
├── package.json
└── tsconfig.jsontypescript 放在 devDependencies 中,项目会使用自己的编译器版本。npx tsc 会优先调用本地依赖,避免不同电脑上的全局版本不一致。
配置源码与输出目录
将 tsconfig.json 调整为下面的最小配置:
json
{
"compilerOptions": {
"target": "ES2020",
"module": "CommonJS",
"rootDir": "./src",
"outDir": "./dist",
"strict": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"skipLibCheck": true,
"noEmitOnError": true
},
"include": ["src/**/*.ts"]
}rootDir 约定源码根目录,outDir 指定 JavaScript 输出位置,strict 开启严格类型检查,noEmitOnError 防止有类型错误时生成旧逻辑难以识别的新文件。
创建 src/index.ts:
ts
type User = {
name: string;
score: number;
};
const user: User = {
name: "Anystack",
score: 95
};
// 模板字符串中的字段都受 User 类型约束
console.log(`${user.name}: ${user.score}`);当前目录应形成以下结构:
text
ts-quick-start/
├── src/
│ └── index.ts
├── package.json
├── package-lock.json
└── tsconfig.json验证项目配置
先只做类型检查,不生成 dist 文件:
bash
npx tsc --noEmit预期输出:
text
命令成功时终端无输出,退出码为 0。若出现“Cannot find module”或找不到 tsc,先确认当前目录存在 package.json,再执行 npm install。若提示源文件不在 rootDir 中,检查文件是否确实放在 src 目录内。
本课总结
- 本地安装 TypeScript 能让团队和构建环境使用一致的编译器
tsconfig.json统一管理源码范围、输出目录和类型检查规则npx tsc --noEmit适合在真正构建前快速验证项目配置
下一课预告
下一课将分别使用单文件编译和项目编译,并运行生成的 JavaScript,进一步理解 tsc、outDir 与 Node.js 之间的完整执行流程。
按自己的节奏,确认真正理解。