JavaScript / TypeScript / 知识点

TypeScript 速查手册

手册条目

创建 TypeScript 项目并生成基础配置文件。

初始化 TypeScript 项目

用于从空目录创建可复现的 TypeScript 项目:将编译器安装为开发依赖,生成 package.json、锁文件和 tsconfig.json,再执行一次类型检查。优先使用项目内的 tsc,避免全局版本与锁定版本不一致。

快速初始化

以下命令适用于 macOS、Linux 或 Git Bash,并要求 ts-demo 目录尚不存在。set -e 会在任一步失败时停止。

bash
set -e

mkdir ts-demo
cd ts-demo
npm init -y >/dev/null

# 安装到项目中,由 package-lock.json 记录实际版本。
npm install --save-dev typescript --silent --no-audit --no-fund
npx tsc --init >/dev/null

mkdir src
cat > src/index.ts <<'TS'
const message: string = "TypeScript ready";
console.log(message);
TS

test -f tsconfig.json && echo "tsconfig.json created"
# 只检查类型,不生成 JavaScript。
npx tsc --noEmit && echo "type-check passed"
npx tsc --version

预期输出

text
tsconfig.json created
type-check passed
Version <VERSION>

<VERSION> 是本地安装的实际版本。三行均出现,表示配置文件已生成、源码通过检查,并且 npx 调用的是项目编译器。

生成文件

路径 作用
package.json 记录依赖和脚本
package-lock.json 锁定依赖解析结果,通常应提交
tsconfig.json 控制输入文件、检查规则和输出
src/index.ts 最小 TypeScript 源码

node_modules 不应提交;通常还会在 .gitignore 中加入 dist/。是否忽略其他缓存目录,应按项目构建工具决定。

常用命令

命令 用途
npx tsc --noEmit 仅做类型检查
npx tsc 按最近的 tsconfig.json 编译
npx tsc --watch 持续监听并重新检查
npx tsc -p <PATH> 使用指定配置文件

风险与排障

在非空目录执行初始化,可能改写现有 package.json 或同名源码。触发条件是目录已存在项目文件;后果是依赖、脚本或代码被覆盖。安全做法是先检查 git status,或始终在新目录中执行。

不要使用全局 tsc 验证项目。全局版本漂移会造成选项、默认值和诊断结果不同;统一运行 npx tsc,并用 npm ls typescript --depth=0 核对本地依赖。

执行 npx tsc src/index.ts 时,显式文件参数会绕过常规项目配置。验证完整项目应使用 npx tsc --noEmit;指定其他配置时使用 npx tsc -p <PATH>。

若安装中断或提示找不到 tsc,先确认 node --version 与 npm --version 可执行,再运行 npm install 恢复依赖。不要随意删除锁文件,否则可能引入整棵依赖树的版本变化。

目录与阅读设置

记录一个想法

TypeScript 速查手册

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通