练习 - 配置 package.json

4 分钟

你是 Tailwind Traders 的 Node.js 开发人员。了解如何设置新的 Node.js 项目是一项重要技能。安装程序包括生成 package.json 文件，以及创建一些用于整个项目生命周期的常见脚本。

在开发容器中打开项目

已经为你提供了一个简单的开发环境。如果计算机上已安装 Node.js LTS，则可以跳过本部分，克隆示例存储库并使用本地环境。

远程开发（浏览器）
本地开发 (Docker)

开始在 MicrosoftDocs/node-essentials GitHub 存储库的 main 分支上创建新的 GitHub Codespace。

在 GitHub Codespaces 中打开此项目
在“创建 codespace”页上，查看 codespace 配置设置，然后选择“新建 codespace”
等待 Codespace 启动。此启动过程会花费几分钟时间。
在 codespace 中打开新终端。

提示

可以使用主菜单导航到“终端”菜单选项，然后选择“新建终端”选项。
验证环境中是否安装了 Node.js：
```
node --version
```
开发容器使用 Node.js LTS 版本，例如 v20.5.1。确切的版本可能有所不同。
此项目中的剩余练习在此开发容器的上下文中进行。

在空目录的上下文中打开 Visual Studio Code。
确保在 Visual Studio Code 中安装了开发容器扩展。
在编辑器中打开新终端。

提示

可以使用主菜单导航到“终端”菜单选项，然后选择“新建终端”选项。
将 MicrosoftDocs/node-essentials GitHub 存储库克隆到当前目录。
```
git clone https://github.com/MicrosoftDocs/node-essentials.git
```
在终端中使用以下命令以代码形式打开存储库。
```
cd node-essentials
code .
```
打开命令面板，搜索“开发容器”命令，然后选择“开发容器：在容器中重新打开”。

提示

Visual Studio Code 可能会自动提示在开发容器中重新打开现有文件夹。这在功能上等效于使用命令面板重新打开容器中的当前工作区。
验证环境中是否安装了 Node.js：
```
node --version
```
开发容器使用 Node.js LTS 版本，例如 v20.5.1。确切的版本可能有所不同。
此项目中的剩余练习在此开发容器的上下文中进行。

设置新的 Node.js 项目

在本单元中，已为你提供 JavaScript 源代码。你的作业是创建 package.json 文件。

在终端中，切换到本练习的文件夹：
```
cd node-dependencies/3-exercise-package-json
```
查看文件夹的内容：
```
ls -R
```
在此文件夹中，你应该会看到一个 src 子文件夹，其中包含 index.js 文件：
```
 ./src:
     index.js
```

运行以下命令以创建具有默认值的 package.json 文件：

npm init -y

package.json 文件，类似于此示例：

{
  "name": "3-exercise-package-json",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

使用以下属性值修改 package.json：

name：“tailwind-trader-api”
description：“用于管理 Tailwind Traders 数据库中各项的 HTTP API”
main：“index.js”
keywords：["API", "database"]
author：“Sam”

你的 package.json 文件现在应该如以下代码所示：

{
  "name": "tailwind-trader-api",
  "version": "1.0.0",
  "description": "HTTP API to manage items from the Tailwind Traders database",
  "main": "index.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": ["api", "database"],
  "author": "Sam",
  "license": "ISC"
}

在 scripts 部分中，在 test 脚本上方添加名为 start 的新脚本：
```
"start": "node ./src/index.js",
```
保存更改，然后关闭 package.json 文件。
输入以下命令，使用 start 操作启动项目：
```
npm start
```
你应该会看到以下输出：
```
Welcome to this application
```

你现在有了一个很好的 package.json 文件，项目规模扩大时可在其基础上进行构建。

练习 - 配置 package.json

在开发容器中打开项目

设置新的 Node.js 项目

反馈