ts-node安装与配置完全指南

ts-node安装与配置完全指南

ts-node TypeScript execution and REPL for node.js 项目地址: https://gitcode.com/gh_mirrors/ts/ts-node

项目基础介绍及编程语言

ts-node 是一个强大的Node.js工具，用于执行TypeScript代码，无需事先编译成JavaScript。它集成了TypeScript的解释器和REPL（Read-Eval-Print Loop），支持原生ES模块以及各种自定义选项，使得在Node.js环境中开发和调试TypeScript应用变得轻而易举。此项目主要使用的编程语言是 TypeScript，并且它依赖于Node.js环境。

关键技术和框架

• TypeScript: 高级静态类型化的JavaScript版本，提供了代码的类型检查和更现代的语言特性。
• Node.js: JavaScript运行时，允许在服务器端运行JavaScript代码。
• npm/yarn: 包管理器，用于安装和管理项目依赖。
• Shebang: 用于脚本文件中的第一行，指定如何运行该文件的命令解释器。

准备工作与详细安装步骤

步骤一：确保Node.js安装

首先，你需要安装 Node.js。访问 Node.js 官网 下载并安装适用于你的操作系统版本。这将同时安装npm包管理器。

步骤二：全局或局部安装ts-node

局部安装（推荐）

对于项目的特定需求，建议在项目目录中进行局部安装：

npm install --save-dev typescript ts-node
# 或者使用yarn
yarn add --dev typescript ts-node

这样做的好处是可以控制每个项目的依赖版本，并且方便版本共享。

全局安装

如果你打算在多个项目中频繁使用ts-node作为开发辅助，可以考虑全局安装：

npm install -g typescript ts-node
# 或者使用yarn
yarn global add typescript ts-node

步骤三：创建或更新tsconfig.json

在项目根目录下，如果没有tsconfig.json，可以通过执行以下命令快速生成默认配置：

tsc --init

接着，为了更好地使用ts-node，你可以编辑这个文件以适应ts-node的需求，例如添加ts-node相关的配置项：

{
  "compilerOptions": {
    "target": "esnext",
    "module": "commonjs", <!-- 若需支持ESM，可改为 "esnext" 并参考文档 -->
    "outDir": "./dist", <!-- 输出目录，按需设置 -->
    "sourceMap": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"], <!-- 指定要编译的文件夹 -->
  "exclude": ["node_modules"], <!-- 排除不需要编译的目录 -->
  "ts-node": { <!-- 可选，直接在这里配置ts-node行为 -->
    "transpileOnly": true
  }
}

步骤四：使用ts-node运行TypeScript文件

现在，你可以使用ts-node直接运行.ts文件，而不必先将其编译为.js文件。例如，有一个名为app.ts的文件：

ts-node app.ts

如果你希望每次运行TypeScript脚本都使用ts-node，可以在脚本文件顶部加入shebang来实现这一点：

#!/usr/bin/env ts-node

// 然后是你的TypeScript代码
console.log('Hello, World!');

记得给脚本文件增加执行权限：

chmod +x app.ts

步骤五：配置环境变量或命令行参数

如果你想通过环境变量或者命令行参数定制ts-node的行为，比如启用或禁用某些特性，可以在运行时使用相应的CLI标志，或者设置NODE_OPTIONS环境变量。例如，启用ES模块支持：

NODE_OPTIONS='--loader ts-node/esm' node index.ts

通过遵循上述步骤，即使你是初学者，也能顺利地安装和配置ts-node，享受在Node.js中直接编写和运行TypeScript代码的便捷。

ts-node TypeScript execution and REPL for node.js 项目地址: https://gitcode.com/gh_mirrors/ts/ts-node