Node.js-package.json文件说明

不念不忘少年蓝@ 2023-06-21 07:28 3阅读 0赞

每个项目的根目录下面，一般都有一个package.json文件，`package` 就是 “包” 的意思，这个文件用于存储项目相关的配置信息，例如：项目名称、作者、项目版本号、许可证、代码库地址等。

因为是个 json 文件所以要严格按照 json 规范进行书写：数据中不能有注释、全小写、允许有连接号和下划线等。

运行 `npm install` 命令时就会根据这个文件中的相关配置数据下载项目运行所需的第三方依赖等。

package.json 文件可以通过 `npm init -y` 命令快速初始化；如果不想直接初始化可以执行 `npm init` 命令，然后根据需求初始化配置信息。

下面来说一下 package.json 文件中相关字段的作用：

**`name`**：当前项目的名称，默认为创建的当前项目的名称

"name": "gulp-demo"

**`version`**：项目的版本号，默认为 1.0.0

"version": "1.0.0"

**`description`**：对项目的描述，用于让使用者快速了解项目的功能和作用

"description": "这是一个 node.js 程序"

**`main`**：项目的主入口文件，默认为项目根目录下的 index.js 文件

"main": "index.js"

**`scripts`**：运行脚本命令的 npm 命令的缩写，就是给相关命令起一个别名，通过这个别名来执行与之对应的命；值为一个对象在对象中配置相关的命令

示例：

"scripts": { 
        "test": "echo \"Error: no test specified\" && exit 1",
        "build": "node app.js"
    }

build 就是 node app.js 命令的别名，执行 npm run build 命令就相当于执行了 node app.js 这个命令

**`keywords`**：描述项目的关键字，其值为一个字符串数组；当在包管理器里搜索包时非常有用

"keywords": ["node.js","javascript"]

**`license`**：许可证，就是项目遵循的协议，默认为 “ISC” 协议，表示开源协议

"license": "ISC"

**`private`**：表示当前项目是否为私有；其值为布尔值，为 true 时表示私有，这是防止私有项目被意外发布的一种方法

"private": true

**`dependencies`**：用于记录项目运行时所依赖的模块，其值为一个对象，对象中的键名为所依赖的包名，键值为 包的版本号；在执行 npm install --production 命令时只会下载根据这个字段所记录的依赖包

*  如果需要将安装的第三方包的信息记录在该字段下可以在安装时使用如下语法：

> npm install 包名 --save  
> 或  
> npm install 包名 -S

"dependencies": { 
       "jquery": "^3.4.1",
       "vue": "^2.6.10"
    }

**`devDependencies`**：用于记录项目开发时所需要的依赖包，同样是一个对象

*  安装依赖包命令时在命令的后面通过空格连接 `--save-dev` 或 `-D` 就会将安装的依赖包的信息记录在这个字段中

"devDependencies": { 
      "gulp": "^3.9.1",
      "gulp-concat": "^2.6.1",
      "gulp-csso": "^4.0.1",
      "gulp-less": "^4.0.1",
      "gulp-rename": "^2.0.0",
      "gulp-uglify": "^3.0.2",
      "open": "^7.0.0"
    }

**`engines`**：当前项目运行的平台，值为一个对象； 比如 Node 的版本或者 npm 版本

"engines": { 
        "node": ">= 6.0.0",
        "npm": ">= 3.0.0"
    }

**`browserslist`**：用于指定项目浏览器的兼容情况，其值为一个数组

"browserslist": [
        "> 1%",
        "last 2 versions",
        "not ie <= 8"
    ]

说明：

*  `> 1%` 全球超过1%人使用的浏览器
 *  `last 2 versions` 所有浏览器兼容到最后两个版本，根据 CanIUse.com 追踪的版本
 *  `not ie <= 8` 排除浏览器部分版本

**`homepage`**：项目主页或文档首页的 URL

"homepage": "https://github.com/zimu-li/Git#git"

**`bugs`**：代码库的 issues 地址或开发者的联系方式，当项目的使用者发现了 bug 就可以通过这个配置项反馈给项目作者

"bugs": { 
      "url": "https://github.com/zimu-li/Git/issues",
      "email": "zimuli163@163.com"
    }

**`repository`**：代码托管的位置，就是代码库的地址，对于那些想要参与到这个项目中的人来说比较有用；其值为一个对象

"repository": { 
      "type": "git",
      "url": "https://github.com/zimu-li/Git.git"
    }

Node.js-package.json文件说明

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关 linux日志文件说明

相关行为树文件说明

相关 boa配置文件说明

相关文件属性说明

相关 nginx配置文件说明

相关 redis配置文件说明

相关 Infer - 文件说明

相关 TypeScript配置文件说明

相关 Flink 配置文件说明

相关 VC项目文件说明: