初次搭建支持 TS 的 Node.js 开发环境指南：亲历经验分享

2023-09-05 03:18:10

你好，我是阿锋，最近我接触到了一个批量处理文件的项目，需要用到 Node.js 来实现。由于我第一次接触 Node.js，又想用 TypeScript 写代码，因此我决定搭建一套支持 TS 的 Node.js 开发环境。不过，在这个过程中，我也踩了不少坑。为了帮助其他初学者避开这些坑，我决定写下这篇文章，分享我的经验。

一、Node.js 环境安装

首先，你需要安装 Node.js。你可以去 Node.js 官网下载最新的 LTS（长期支持）版本。安装过程很简单，只需要按照提示操作即可。

二、TypeScript 安装

接下来，你需要安装 TypeScript。你可以通过 npm（Node.js 包管理器）来安装 TypeScript。在终端中输入以下命令：

npm install -g typescript

安装完成后，你就可以在终端中使用 tsc 命令来编译 TypeScript 代码了。

三、初始化项目

现在，你可以创建一个新的 Node.js 项目了。在终端中输入以下命令：

mkdir my-project
cd my-project
npm init -y

这将创建一个新的 Node.js 项目，并生成一个 package.json 文件。

四、安装必要的依赖

接下来，你需要安装一些必要的依赖。你可以使用 npm 来安装这些依赖。在终端中输入以下命令：

npm install express
npm install typescript

这将安装 Express.js 和 TypeScript。

五、创建 TypeScript 配置文件

现在，你需要创建一个 TypeScript 配置文件，以便 tsc 命令知道如何编译你的 TypeScript 代码。在项目根目录下创建一个名为 tsconfig.json 的文件，并输入以下内容：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "sourceMap": true
  }
}

这个配置文件告诉 tsc 命令将 TypeScript 代码编译成 ES5 代码，使用 CommonJS 模块系统，并生成源映射文件。

六、编写 TypeScript 代码

现在，你就可以开始编写 TypeScript 代码了。你可以创建一个名为 index.ts 的文件，并输入以下代码：

// 导入 Express.js
import express from 'express';

// 创建一个 Express.js 应用程序
const app = express();

// 定义一个路由
app.get('/', (req, res) => {
  res.send('Hello, World!');
});

// 启动应用程序
app.listen(3000);