ng配置文件之package.json

用途:

package.json配置文件是配置和描述如何与程序交互和运行的中心文件。

npm 用它来识别项目,并了解如何处理项目的依赖关系。

npm可通过此配置文件启动项目、运行脚本、安装依赖包、发布npm公用包……

npm也是管理此配置文件的最佳方法,因为它有助于在项目的整个生命周期内生成和更新此配置文件。

 

常用配置项:

name:

  项目名称/包名称

  规范:string,不能超过214个字符,只能是小写字母、连字符和下换线。

  如果项目要发布到npm,则此配置项为必须项。

 

version:

  项目版本号

  规范:0.0.0

  如果项目要发布到npm,则此配置项为必填项。


license

  定义适用于此配置文件所描述代码的许可证

  规范:属性值通常是许可证的标识符代码,例如:MIT、ISC……如果不想提供许可证,或者不想授予使用私有或未发布包的权限,可配置为 UNLICENSED 

  项目发布到npm时,此项可以限制某些人或组织对此npm包的使用。

  

author 和 contributors

  定义作者及贡献者姓名、邮箱、url

  规范:可以是string直接写姓名,也可以是object定义姓名、邮箱、url

  author只能写一个人,contributors可写多个人

 

description:

  npm包的描述,可通过此配置内容在网站中搜索到本包

 

keywords:

  属性值为字符串数组,

  与description类似,数组每一个值均为概括本包的关键字

  在网站中通过关键字,可查询到本包

 

main:

  功能属性

  定义项目入口点(文件),通常是用于启动项目的文件

  如果包通过npm安装,可通过import导入本包,导入的内容为通过此文件export出去的

  通常指向根目录下的main.ts文件,也可以是自定义文件

 

scripts:

  自定义指令

  规范:object

  可通过npm run xxx(object的属性)运行自定义指令

  此配置是npm CLI 用来运行项目任务的强大工具

 

private:

  指定项目是否是私有的,true or false

 

dependencies:

  列出项目的所有依赖包

  通过npm install 将此配置项中所有包下载到项目node_modules目录下

 

devDependencies:

  与dependencies类似,此配置项列出的为项目开发环境需要而生产环境不需要的npm包

 

 

posted @ 2020-07-21 11:02  冰凝^  阅读(608)  评论(0编辑  收藏  举报