Logo
Section 1 / 6

npm 入门

学习如何使用 npm,初始化一个 Node.js 项目,并探索 package.json 文件的结构和用途。

导入

npm 入门

学习如何使用 npm,初始化一个 Node.js 项目,并探索 package.json 文件的结构和用途。

  1. 打开终端并导航到一个新项目文件夹或现有项目文件夹:

    1mkdir my-project && cd my-project
  2. 运行以下命令来初始化项目:

    1npm init
  3. 回答提示。以下是可能会遇到的典型问题列表:

    • Package name: 项目的名称(默认为文件夹名称)。

    • Version: 初始版本号(默认为 1.0.0)。

    • Description: 项目的简短描述。

    • Entry point: 应用程序的起始文件(例如 index.js)。

    • Test command: 运行测试的命令(可选;可以留空)。

    • Git repository: Git 仓库链接(可选)。

    • Keywords: 描述项目的关键词(如果发布到 npm,有助于发现)。

    • Author: 您的姓名或组织名称。

    • License: 许可证类型(默认为 ISC)。

使用 npm init 创建的典型 package.json 文件,包含默认字段和值

1{ 2 "name": "my-project", 3 "version": "1.0.0", 4 "description": "", 5 "main": "index.js", 6 "scripts": { 7 "test": "echo \"Error: no test specified\" && exit 1" 8 }, 9 "keywords": [], 10 "author": "", 11 "license": "ISC" 12}
Terminal

代码示例

1"scripts": { 2 "start-app": "node app.js" 3}

代码示例

1npm run start-app

展示使用特殊脚本名称和钩子的 package.json 文件

1"scripts": { 2 "start": "node app.js", 3 "test": "echo 'Running tests...'", 4 "prestart": "echo 'Preparing to start the app...'", 5 "posttest": "echo 'Test complete!'" 6}

No configuration found for ID: 794bb82bcb14ce9020533191cf262ecb191f497681414c6bb27e6b7dc54a95e6

显示解决方案

使用以下代码更新 package.json 文件中的所需脚本。

添加带有 pre 和 post 触发器的 clean 自定义脚本

1 "scripts": { 2 "test": "echo \"No tests defined yet\" && exit 1", 3 "preclean": "echo 'Starting cleanup...'", 4 "clean": "rm -rf log/", 5 "postclean": "echo 'Cleanup completed!'" 6 },
  • 第 3 行: 定义了 preclean 脚本,它会在 clean 脚本之前自动运行。该脚本会显示一条消息,表明清理过程已经开始。

  • 第 4 行: 定义了 clean 脚本,这是任务的主要脚本。它递归且强制性地删除 log/ 文件夹内的所有文件和目录。

  • 第 5 行: 定义了 postclean 脚本,它会在 clean 脚本之后自动运行。该脚本会显示一条消息,表明清理过程已完成。

  • 第 3 行: 定义了 preclean 脚本,它会在 clean 脚本之前自动运行。该脚本会显示一条消息,表明清理过程已经开始。

  • 第 4 行: 定义了 clean 脚本,这是任务的主要脚本。它递归且强制性地删除 log/ 文件夹内的所有文件和目录。

  • 第 5 行: 定义了 postclean 脚本,它会在 clean 脚本之后自动运行。该脚本会显示一条消息,表明清理过程已完成。

构建一个基本的 Web 服务器

使用 npm 包