华为云首页用户手册

制品仓库 CODEARTS ARTIFACT-上传私有组件:npm组件介绍

时间：2024-06-06 11:14:08

制品仓库 CODEARTS ARTIFACT 私有依赖库（新版）

npm组件介绍

npm全称Node Package Manager，是一个JavaScript包管理工具，npm组件包就是npm管理的对象，而npm私有依赖库就是管理和存储npm组件包的一个私有仓库。

npm组件包是由结构和文件描述组成：

包结构：是组织包中的各种文件，例如：源代码文件，资源文件等。
描述文件：描述包的相关信息，例如：package.json、bin、lib等文件。

包中的package.json文件是对项目或模块包的描述文件，它主要包含名称、描述、版本、作者等信息，npm install命令会根据这个文件下载所有依赖的模块。

package.json示例如下：

{
  "name": "third_use",			//包名
  "version": "0.0.1",           //版本号
  "description": "this is a test project",  //描述信息
  "main": "index.js",			//入口文件
  "scripts": {					//脚本命令
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [					//关键字
    "show"
  ],
  "author": "f",				//开发者姓名
  "license": "ISC",				//许可协议
  "dependencies": {				//项目生产依赖
    "jquery": "^3.6.0",
    "mysql": "^2.18.1"
  },
  "devDependencies": {			//项目开发依赖
    "less": "^4.1.2",
    "sass": "^1.45.0"
  }
}

其中最重要的是name和version字段，这两个字段必须存在，否则当前包无法被安装，这两个属性一起形成了一个 npm 包的唯一标识。

name是 package(包)的名称。名称的第一部分如“@scope”用作名称空间；另一部分“name”，一般通过搜索该“name”字段来安装使用需要的包。