【前端知识】npm命令行详细说明

概述

npm（全称Node Package Manager）是Node.js的包管理工具，以下是关于npm的详细介绍：

一、定义与功能

npm是Node.js的默认包管理工具，它提供了一个模块仓库，允许开发人员从仓库中下载已发布的模块到本地，并可以将自己开发的模块发布到仓库中供他人使用。npm的主要功能包括：

1. 包安装和管理：通过npm，用户可以方便地安装、更新、删除JavaScript包。
2. 依赖管理：npm能够管理项目的依赖关系，确保项目的稳定性和一致性。
3. 包发布和管理：开发者可以使用npm发布自己的包到npm注册表，并管理自己的包。
4. 脚本执行：npm允许开发者在package.json中定义脚本，并通过npm运行这些脚本，从而简化开发流程。

二、基本命令

npm提供了一系列命令行工具，用于执行各种包管理操作。以下是一些常用的npm命令：

1. npm install：安装包到当前项目的node_modules目录，并更新package.json和package-lock.json文件。
2. npm uninstall：卸载已安装的包。
3. npm update：更新项目中的包到最新版本。
4. npm list：列出已安装的包及其依赖关系。
5. npm init：初始化一个新的npm项目，并生成package.json文件。
6. npm publish：将包发布到npm注册表。
7. npm run：运行package.json中定义的脚本。

三、配置文件与注册表

1. 配置文件：npm的配置文件为~/.npmrc或项目根目录下的.npmrc文件。这些文件用于存储npm的配置信息，如注册表地址、全局安装包的路径、代理服务器地址等。
2. 注册表：npm registry是npm包的存储和分发中心。通过registry，开发者可以发布、发现和安装npm包。常用的npm registry有npm官方注册表（https://registry.npmjs.org/）和淘宝npm镜像（https://registry.npm.taobao.org/）等。

四、应用场景

npm在JavaScript开发中有着广泛的应用场景，包括但不限于：

1. Web开发：使用npm安装前端框架（如React、Vue.js、Angular）、构建工具（如Webpack、Gulp）、开发服务器等。
2. Node.js应用：管理Node.js项目的依赖关系，执行各种脚本和任务，如安装中间件、运行测试等。
3. 前端工程化：自动化构建、测试和部署等任务，使用npm安装构建工具、测试框架和部署工具。
4. 包开发：创建、测试和发布自己的npm包，供其他开发者使用。

五、高级特性

npm还提供了一些高级特性和使用技巧，如：

1. npm Workspaces：允许在一个package.json文件中管理多个项目，简化开发流程。
2. npm ci：在持续集成（CI）环境中使用，提供更快的安装速度，并且只安装package-lock.json或npm-shrinkwrap.json中列出的依赖。
3. npm Outdated：检查哪些包已经过时，以便及时更新。
4. npm Link：在开发多个包时，创建符号链接以共享代码。
5. npm Deprecate：弃用一个包，并给出自定义的弃用理由。
6. npm Access：管理包的访问权限，如设置为公开或受限。

综上所述，npm是JavaScript开发中不可或缺的工具之一，为开发者提供了高效、灵活和可靠的包管理解决方案。

环境设置

npm（Node Package Manager）的环境相关配置通常涉及设置镜像源、全局依赖存储路径、缓存路径等。以下是一些常用的npm环境配置命令行：

1. 设置镜像源

由于npm默认的镜像源在国外，有时会导致下载速度较慢。为了提高下载速度，可以配置使用国内的镜像源，如阿里镜像、腾讯镜像、华为镜像等。

• 配置使用阿里镜像：

npm config set registry https://registry.npmmirror.com

• 配置使用腾讯镜像：

npm config set registry https://mirrors.cloud.tencent.com/npm/

• 配置使用华为镜像：

npm config set registry https://mirrors.huaweicloud.com/repository/npm/

• 恢复到npm官方源：

npm config set registry https://registry.npmjs.org/

• 查看当前registry的配置：

npm config get registry

*登录到仓库

npm login

2. 配置全局依赖存储路径

npm的全局依赖默认安装在系统的某个特定目录下。为了管理方便，可以配置一个自定义的全局依赖存储路径。

• 配置全局依赖存储路径（例如D:\GlobalNodeModules）：

npm config set prefix "D:\GlobalNodeModules"

• 查看当前的全局依赖存储路径：

npm config get prefix

3. 配置缓存路径

npm会将下载的包存储在本地缓存中，以便在之后的安装过程中重复使用，避免重复下载。可以配置一个自定义的缓存路径。

• 配置缓存路径（例如D:\npm_repository\npm-cache）：

npm config set cache "D:\npm_repository\npm-cache"

• 查看当前的缓存路径：

npm config get cache

4. 查看所有配置

要查看npm的所有配置信息，可以使用以下命令：

npm config list

5. 清除缓存

有时需要清除npm的本地缓存，可以使用以下命令：

npm cache clean --force  # 旧版npm使用
npm cache verify         # 验证缓存数据的完整性，并尝试修复任何问题
npm cache clean --all    # 新版npm使用，清除所有缓存数据

注意：npm cache clean --force命令在新版npm中可能已经被弃用，建议使用npm cache clean --all或npm cache verify来管理缓存。

6. 升级npm版本

如果node中自带的npm版本过低，可以升级到最新版本以提高性能和安全性。

• 查看当前npm版本：

npm -v

• 升级到最新版本：

npm install npm@latest -g

以上是一些常用的npm环境配置命令行，它们可以帮助你更好地管理和优化npm的使用环境。

npm组件打包

在npm（Node Package Manager）中，包构建命令通常指的是用于创建、打包和发布npm包的命令。以下是一些与npm包构建相关的常用命令：

1. 初始化项目

• npm init

  • 功能：初始化一个新的npm项目，并生成package.json文件。这个文件包含了项目的元数据，如包名、版本、描述、入口文件等，以及项目的依赖关系。
  • 使用方法：在项目目录下运行npm init，然后按照提示输入相关信息，或者使用-y参数快速生成包含默认值的package.json文件。

2. 安装依赖

• npm install

  • 功能：安装项目所需的依赖包。这些依赖包会被安装在node_modules目录下，并在package.json文件的dependencies或devDependencies字段中列出。
  • 使用方法：运行npm install <package-name>来安装指定的包，或者使用--save（或-S）参数将其添加到dependencies中，使用--save-dev（或-D）参数将其添加到devDependencies中。

3. 构建脚本

• npm run

  • 功能：运行package.json文件中定义的脚本。这些脚本可以用于构建、测试、启动项目等任务。
  • 使用方法：在package.json的scripts字段中定义脚本，然后运行npm run <script-name>来执行该脚本。例如，可以定义一个名为build的脚本，用于构建项目，然后运行npm run build来执行构建任务。

4. 打包项目

• npm pack

  • 功能：打包当前项目，生成一个.tgz格式的压缩包。这个压缩包包含了项目的所有内容和依赖信息，可以用于发布到npm仓库或其他地方。
  • 使用方法：在项目目录下运行npm pack命令。

5. 发布包

• npm publish
  • 功能：将当前项目发布到npm仓库中。在发布之前，需要确保已经登录了npm账号，并且package.json文件中的信息完整无误。
  • 使用方法：在项目目录下运行npm publish命令。如果之前已经发布过相同版本的包，需要先更新版本号或撤销之前的发布。

6. 其他常用命令

• npm version

  • 功能：更新package.json文件中的版本号，并创建一个新的版本提交（git commit）。这个命令通常用于在发布新版本之前更新版本号。
  • 使用方法：运行npm version <newversion>来更新版本号，其中<newversion>是新的版本号（如1.0.1）。

• npm audit

  • 功能：检查项目依赖中是否存在已知的安全漏洞，并给出修复建议。
  • 使用方法：在项目目录下运行npm audit命令。

• npm outdated

  • 功能：列出当前项目中需要更新的依赖包及其最新版本。
  • 使用方法：在项目目录下运行npm outdated命令。

• npm uninstall

  • 功能：卸载项目中的依赖包。
  • 使用方法：运行npm uninstall <package-name>来卸载指定的包。

总结

npm包构建命令涵盖了从项目初始化、依赖安装、构建脚本定义、项目打包到发布包等一系列操作。熟练掌握这些命令对于开发和管理npm包至关重要。在使用这些命令时，建议查阅npm的官方文档或帮助信息，以获取更详细和最新的说明。

项目构建相关

npm（Node Package Manager）在项目构建中扮演着至关重要的角色，提供了一系列命令行工具来管理项目依赖、运行脚本、发布包等。以下是一些与npm项目构建相关的常用命令行：

1. 初始化项目

• npm init：
  • 功能：创建一个新的package.json文件，该文件是Node.js项目的核心配置文件。
  • 参数：通过一系列交互式问题，用户可以定义项目的基本信息，如名称、版本、描述、主入口文件等。
  • 快速创建：使用-y参数可以快速创建并接受默认配置，例如npm init -y。

2. 安装依赖

• npm install：
  • 功能：安装项目依赖的所有包，这些包会被添加到node_modules文件夹中，并在package.json的dependencies字段中记录。
  • 安装指定包：npm install <package>，其中<package>是包的名称。
  • 安装并保存为生产依赖：npm install <package> --save（或简写为-S），将包作为生产依赖添加到dependencies字段。
  • 安装并保存为开发依赖：npm install <package> --save-dev（或简写为-D），将包作为开发依赖添加到devDependencies字段。

3. 更新依赖

• npm update：
  • 功能：更新项目依赖的所有包到最新兼容版本。
  • 更新指定包：npm update <package>，其中<package>是包的名称。

4. 查看依赖

• npm list：
  • 功能：列出项目依赖的所有包。
  • 查看指定包：npm list <package>，其中<package>是包的名称。
  • 查看全局安装的包：npm list -g。

5. 卸载依赖

• npm uninstall：
  • 功能：卸载本地依赖。
  • 卸载指定包：npm uninstall <package>（或简写为npm rm <package>），其中<package>是包的名称。
  • 从package.json中移除对应依赖记录：可以添加--save（或-S）或--save-dev（或-D）参数以确定是从哪个依赖列表中移除。
  • 卸载全局包：npm uninstall -g <package>，其中<package>是包的名称。

6. 运行脚本

• npm run：
  • 功能：运行package.json中定义的脚本。
  • 示例：在Vue项目中，npm run serve用于启动开发服务器，npm run build用于构建生产环境的静态资源。

7. 自定义脚本

• 在package.json中添加脚本：
  • 可以在package.json的scripts字段中定义自定义脚本，例如：

    "scripts": {"build": "npm run build:css && npm run build:js","build:css": "node-sass src/styles/main.scss dist/styles/main.css","build:js": "babel src/js --out-dir dist/js"
    }
    

  • 然后通过npm run <script-name>命令来运行这些脚本，例如npm run build。

8. 发布包

• npm publish：
  • 功能：将包发布到npm注册表。
  • 前提：需要先在npm上注册账号并登录，同时确保package.json中的信息完整且正确。

9. 其他常用命令

• npm outdated：检查项目依赖的包是否有更新。
• npm config ls：查看当前npm的配置信息。
• npm config set key value：设置npm的配置项，例如设置默认项目作者名称npm config set init-author-name "Your Name"。
• npm search ：搜索npm仓库中的包。
• npm view ：查看特定包的信息。

这些命令行工具是npm项目构建过程中的基础，熟练掌握它们将大大提高开发效率和项目管理的便捷性。