项目描述文件 package.json

[ 背景故事 ]     // package.json,可以成为项目描述文件或包描述文件,里面包含了关于当前项目或包的一些描述信息。

在很久很久以前,dk 要开发一个前端项目,在计算机的某个旮沓地方建立了一个文件夹叫 dk_project,就称为这是
一个“项目”了。

又过了很久,dk 离开了公司,来了位新同事,在接手 dk 工作的时候发现计算机上面的 dk_project 文件夹,因为
没有任何明显的标识,就被当成普通文件夹给 DELETE 掉了。

回到现代,随着 npm 的诞生,人们意识到建立一个项目目录不应该这么草率,于是乎规定,
如果某个文件夹被创建作为一个项目目录,那么它就应该包含一个 package.json 的文件。

package.json 文件里记录项目的描述信息:项目作者、项目描述、项目依赖哪些包、插件配置信息等等数不清的好处。

初始化项目目录,并创建项目描述文件 package.json

进入项目文件存储目录,如webpiece,然后依次输入:
mkdir vueproject    // 创建项目目录
cd vueproject    // 进入项目目录
npm init    // 创建项目描述文件 package.json

# 命令行里会以交互的形式让你填一些项目的介绍信息,依次介绍如下(不知道怎么写可以直接回车、回车 ...):

  • name 项目名称
  • version 项目的版本号
  • description 项目的描述信息
  • entry point 项目的入口文件
  • test command 项目启动时脚本命令
  • git repository 如果你有 Git 地址,可以将这个项目放到你的 Git 仓库里
  • keywords 关键词
  • author 作者
  • license 项目要发行的时候需要的证书,平时可忽略


# 在项目目录下会自动生成 package.json 文件,打开可以看到刚才配置的项目信息。


package.json 属性配置(详解 _ 待)

[ package.json 字段分析 ]

  • name:包的名称,必须是唯一的,由小写英文字母、数字和下划线组成,不能包含空格
  • description:包的简要说明
  • version:符合语义化版本识别规范的版本字符串
  • keywords:关键词数组,通常用于搜索
  • maintainers:维护者数组,每个要素包含 name、email(可选)、web(可选)字段
  • contributors:贡献者数组,格式与 maintainers 相同。包的作者应该是贡献者数组的第一个元素
  • bugs:提交 bug 的地址,可以是网站或者电子邮件地址
  • licenses:许可证数组,每个元素要包含 type(许可证名称)和 url(链接到许可证文本的地址)字段
  • repositories:仓库托管地址数组,每个元素要包含 type(仓库类型,如 git)、url(仓-库的地址)和 path(相对于仓库的路径,可选)字段
  • dependencies:包的依赖,一个关联数组,由包的名称和版本号组成