package.json字段简要解析

Posted 炎泽

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了package.json字段简要解析相关的知识,希望对你有一定的参考价值。

name 必填

应用名称

version 必填

应用版本

description 选填

应用描述,多用于搜索,在npm search 时可以用到

keywords 选填

应用关键字,也多用于搜索

scripts 可选

这是一个对象,key为生命周期事件名,value是具体指令

"scripts": {
    "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
    "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
  },

如上: npm run dev 创建服务器,自动打开并开启热加载

dependencies: 可选

当前应用所依赖的包,每次npm i 时都会自动添加

devDependencies 可选

如果只需要下载使用模块,而无需下载其测试和文档框架,可放在这儿

author 必填

作者

pirate 可选

若设为true,npm会拒绝发布,这可以放在私有repositories被发出

repository 可选

代码存放的地址,多放于github

license 可选

指定一个许可证,让人指定使用的权利和限制,一般只需要指定其名字

main 可选

程序主入口模块的id,如果其他用户需要你的包,当用户调用require()方法时,返回的就是这个模块的导出(exports)。

 

 

以上是关于package.json字段简要解析的主要内容,如果未能解决你的问题,请参考以下文章

package.json 字段全解析

package.json 字段全解析

npm scripts 使用指南

如果我的代码仅供我工作的公司使用,我应该在 package.json 的许可字段中输入啥?

为基于打字稿的库在 package.json 类型字段中放置啥

package.json字段详解