共计 1093 个字符,预计需要花费 3 分钟才能阅读完成。
后面咱们讲到,当应用 yarn init
初始化一个我的项目时,会主动生成一个 package.json
文件,在这个文件中能够配置我的项目的信息,例如名称、版本号、形容信息等,还能够定义我的项目所须要的各种依赖包。
package.json 文件中的字段
上面是一些 package.json
文件中的字段介绍,其中 name
和 version
是 package.json
中最重要的两个必须字段,如果没有它们那么包将无奈被装置,两者一起用来创立一个惟一的 id。
name
:包的名字,在 URL 中作为命令行参数,作为node_modules
里的目录名应用。由小写字母组成,尽量简洁。version
:包的以后版本号。author
:作者信息。description
:是一个字符串,能够帮忙咱们理解软件包的用处,也能够在包治理中搜寻包时应用它。keywords
:是一个字符串数组,在包管理器中搜寻包时起作用。license
:许可证,以不便用户晓得他们是在什么受权下应用此包,以及此包还有哪些附加限度。main
:我的项目的入口文件,默认为index.js
。scripts
:定义自动化开发相干工作的好办法,比方应用一些简略的构建过程或开发工具。能够通过yarn run <script>
命令来执行。dependencies
:包的开发版和公布版都须要的依赖。devDependencies
:只在包开发期间须要,然而生产环境不会被装置的包。config
:配置你的脚本的选项或参数。homepage
:包的我的项目主页或者文档首页。bugs
:问题反馈系统的 URL,或者是 email 地址之类的链接,用户通过该路径向你反馈问题。repository
:代码托管的地位。contributors
:贡献者信息,能够是多集体。files
:我的项目蕴含的文件,能够是独自的文件、整个文件夹,或者通配符匹配到的文件。directories
:当咱们的包装置时,能够指定确切的地位来放二进制文件、man pages、文档、例子等。
创立一个 package.json 文件
咱们能够通过 yarn init
来创立一个 package.json
文件,例如:
依据提醒填写 package.json
中的字段信息,最初会创立一个相似如下所示的文件,例如:
{
"name": "xkd_yarn",
"version": "1.0.0",
"description": "hello xkd",
"main": "index.js",
"author": "xiakedao",
"license": "MIT"
}
如果想要疾速创立一个默认 package.json
文件,能够应用如下命令:
yarn init --yes
正文完
发表至: javascript
2021-04-12