欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

package.json文件说明解释

程序员文章站 2022-05-13 19:39:56
...

1、package.json是什么?
先了解什么是Node.js的模块(Module)?在Node.js中,模块是一个库或框架,也是一个Node.js项目。Node.js项目遵循模块化的架构,当我们创建了一个Node.js项目,意味着创建了一个模块,这个模块的描述文件,被称为package.json。作为一个描述文件,描述了你的项目依赖哪些包和项目模块相关信息
2、package.json属性说明
name - 包名.
version - 包的版本号。
description - 包的描述。
homepage - 包的官网URL。
author - 包的作者,它的值是你在https://npmjs.org网站的有效账户名,遵循“账户名<邮件>”的规则,例如:zhangsan [email protected]
contributors - 包的其他贡献者。
dependencies / devDependencies - 生产/开发环境依赖包列表。它们将会被安装在 node_module 目录下。
repository - 包代码的Repo信息,包括type和URL,type可以是git或svn,URL则是包的Repo地址。
main - main 字段指定了程序的主入口文件,require(‘moduleName’) 就会加载这个文件。这个字段的默认值是模块根目录下面的 index.js。
keywords - 关键字
上述参数是极为常见的参数,另外还可以设置script、license等等。除了官方必须的一些参数外,我们也可以存储我们自己的关于模块的描述信息在package.json。
3、生成package.json文件

   $ npm init

4、关于版本号的描述 https://www.jianshu.com/p/b3d86ddfd555

5. 指定依赖的包
安装包时 我们需要在 package.json 文件中指定项目依赖的包,这样别人在拿到这个项目时才可以使用 npm install 下载。

包有两种依赖方式:

dependencies:在生产环境中需要用到的依赖
devDependencies:在开发、测试环境中用到的依赖

6.安装参数 --save 和 --save -dev
添加依赖时我们可以手动修改 package.json 文件,添加或者修改 dependencies devDependencies 中的内容即可。

另一种更酷的方式是用命令行,在使用 npm install 时增加 --save 或者 --save -dev 后缀:

npm install <package_name> --save       //表示将这个包名及对应的版本添加到 package.json的 dependencies
npm install <package_name> --save-dev   //表示将这个包名及对应的版本添加到 package.json的 devDependencies
相关标签: package.json包说明