当前位置：首页 > news >正文

typescript常用命令选项

news 2025/8/22 17:05:48

TypeScript CLI 常用命令及其选项说明

TypeScript CLI（命令行接口）主要通过 tsc（TypeScript 编译器）命令来操作，它用于将 TypeScript 代码编译为 JavaScript。安装 TypeScript 编译器后（参考安装步骤1），您可以在终端运行 tsc 命令及其选项。以下是常用命令和选项的详细说明，基于标准 TypeScript 文档和常见用法。命令结构通常为：tsc [options] [file...]，其中 options 是可选参数，file 是输入文件。

1. 常用命令概览

TypeScript CLI 的核心命令是 tsc，它支持多种选项来控制编译行为。以下列出最常用的选项及其说明（完整列表可通过 tsc --help 查看）：

选项	短格式	参数类型	说明	示例
`--help`	`-h`	无	显示所有可用选项的帮助信息。	`tsc -h`
`--version`	`-v`	无	显示 TypeScript 编译器版本。	`tsc -v`
`--init`	无	无	在当前目录初始化一个 `tsconfig.json` 配置文件（用于项目级设置）。	`tsc --init`
`--watch`	`-w`	无	启用监视模式：自动重新编译文件当源文件变化时。	`tsc --watch`
`--outDir`	无	字符串	指定编译输出的 JavaScript 文件目录。	`tsc --outDir dist`
`--target`	无	字符串	设置 ECMAScript 目标版本（如 `es5`, `es6`）。	`tsc --target es6`
`--module`	无	字符串	指定模块系统（如 `commonjs`, `es2015`）。	`tsc --module commonjs`
`--strict`	无	布尔	启用所有严格类型检查选项（推荐用于高质量代码）。	`tsc --strict true`
`--noEmit`	无	布尔	只进行类型检查，不生成输出文件。	`tsc --noEmit`
`--project`	`-p`	字符串	指定项目目录或 `tsconfig.json` 文件路径。	`tsc -p ./my-project`

说明：

这些选项可以直接在命令行中使用，例如 tsc --watch src/index.ts 会监视 index.ts 文件的变化并自动编译。
大多数选项也可以在 tsconfig.json 文件中配置（通过 --init 创建），这更适合项目级管理。
选项参数类型：字符串 表示需要值（如目录名），布尔 表示开关（true 或 false），无 表示无参数。
使用 -- 前缀的选项是标准格式，类似于 Commander.js 中的选项声明方式（参考）。

2. 详细选项说明和示例

以下是关键选项的深入解释：

--watch / -w：在开发中非常有用，它会持续监视文件变化。例如，运行 tsc -w 后，修改任何 .ts 文件都会触发重新编译。这类似于 npm 脚本中的监视模式（参考）。
--outDir：指定输出目录，避免编译文件混入源码。示例：tsc --outDir dist 会将所有编译后的 .js 文件放入 dist 文件夹。
--target：控制生成的 JavaScript 版本。例如，tsc --target es5 确保代码兼容旧浏览器，而 es2022 支持最新特性。
--strict：启用严格模式，包括 noImplicitAny 和 strictNullChecks 等子选项。这有助于捕获潜在错误，但可能增加编译时间。
--project / -p：用于指定自定义配置。例如，tsc -p config/tsconfig.dev.json 会使用指定文件而非默认 tsconfig.json。

示例完整命令：

# 编译当前目录所有 .ts 文件，输出到 dist 目录，使用 ES6 目标
tsc --outDir dist --target es6# 初始化项目并启用监视模式
tsc --init
tsc --watch

3. 其他相关命令

tsc --build：用于构建项目（需在 tsconfig.json 中配置 composite 选项），支持增量编译。
ts-node：非官方但常用工具，允许直接运行 TypeScript 文件（无需编译）。安装后使用 ts-node file.ts，它常用于开发脚本（参考 npm 脚本配置）。
tsc --showConfig：显示当前生效的配置，帮助调试 tsconfig.json。