package.json全面解析_package.json alias-程序员宅基地

技术标签: vue  js  

在这里插入图片描述

你真的了解package.json吗?来看看吧,这可能是最全的package解析

1. 概述

从我们接触前端开始,每个项目的根目录下一般都会有一个package.json文件,这个文件定义了当前项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等)。

当运行npm install命令的时候,会根据package.json文件中的配置自动下载所需的模块,也就是配置项目所需的运行和开发环境。

比如下面这个文件,只存在简单的项目名称和版本号。

{
    
  "name" : "yindong",
  "version" : "1.0.0",
}
复制代码

package.json文件是一个JSON对象,这从他的后缀名.json就可以看出来,该对象的每一个成员就是当前项目的一项设置。比如name就是项目名称,version是版本号。

当然很多人其实并不关心package.json的配置,他们应用的更多的是dependencies或devDependencies配置。

下面是一个更完整的package.json文件,详细解释一下每个字段的真实含义。

{
    
    "name": "yindong",
    "version":"0.0.1",
    "description": "antd-theme",
    "keywords":["node.js","antd", "theme"],
    "homepage": "https://zhiqianduan.com",
    "bugs":{
    "url":"http://path/to/bug","email":"[email protected]"},
    "license": "ISC",
    "author": "yindong",
    "contributors":[{
    "name":"yindong","email":"[email protected]"}],
    "files": "",
    "main": "./dist/default.js",
    "bin": "",
    "man": "",
    "directories": "",
    "repository": {
    
		"type": "git",
		"url": "https://path/to/url"
	},
    "scripts": {
    
      "start": "webpack serve --config webpack.config.dev.js --progress"
    },
    "config": {
     "port" : "8080" },
    "dependencies": {
    },
    "devDependencies": {
    
        "@babel/core": "^7.14.3",
        "@babel/preset-env": "^7.14.4",
        "@babel/preset-react": "^7.13.13",
        "babel-loader": "^8.2.2",
        "babel-plugin-import": "^1.13.3",
        "glob": "^7.1.7",
        "less": "^3.9.0",
        "less-loader": "^9.0.0",
        "style-loader": "^2.0.0",
        "webpack": "^5.38.1",
        "webpack-cli": "^4.7.0",
        "webpack-dev-server": "^3.11.2"
    },
    "peerDependencies": {
    
        "tea": "2.x"
    },
    "bundledDependencies": [
        "renderized", "super-streams"
    ],
    "engines": {
    "node": "0.10.x"},
	  "os" : [ "win32", "darwin", "linux" ],
    "cpu" : [ "x64", "ia32" ],
    "private": false,
    "publishConfig": {
    }
  }
  
复制代码

2. name字段

package.json文件中最重要的就是nameversion字段,这两项是必填的。名称和版本一起构成一个标识符,该标识符被认为是完全唯一的。对包的更改应该与对版本的更改一起进行。

name必须小于等于214个字符,不能以._开头,不能有大写字母,因为名称最终成为URL的一部分因此不能包含任何非URL安全字符。 npm官方建议我们不要使用与核心节点模块相同的名称。不要在名称中加jsnode。如果需要可以使用engines来指定运行环境。

该名称会作为参数传递给require,因此它应该是简短的,但也需要具有合理的描述性。

3. version字段

version一般的格式是x.x.x, 并且需要遵循该规则。

package.json文件中最重要的就是nameversion字段,这两项是必填的。名称和版本一起构成一个标识符,该标识符被认为是完全唯一的。每次发布时version不能与已存在的一致。

4. description字段

description是一个字符串,用于编写描述信息。有助于人们在npm库中搜索的时候发现你的模块。

5. keywords字段

keywords是一个字符串组成的数组,有助于人们在npm库中搜索的时候发现你的模块。

6. homepage字段

homepage项目的主页地址。

7. bugs字段

bugs用于项目问题的反馈issue地址或者一个邮箱。

"bugs": {
     
  "url" : "https://github.com/owner/project/issues",
  "email" : "[email protected]"
}
复制代码

8. license字段

license是当前项目的协议,让用户知道他们有何权限来使用你的模块,以及使用该模块有哪些限制。

"license" : "BSD-3-Clause"
复制代码

9. author字段 contributors字段

author是具体一个人,contributors表示一群人,他们都表示当前项目的共享者。同时每个人都是一个对象。具有name字段和可选的urlemail字段。

"author": {
    
  "name" : "yindong",
  "email" : "[email protected]",
  "url" : "https://zhiqianduan.com/"
}
复制代码

也可以写成一个字符串

"author": "yindong [email protected] (https://zhiqianduan.com/)"
复制代码

10. files字段

files属性的值是一个数组,内容是模块下文件名或者文件夹名,如果是文件夹名,则文件夹下所有的文件也会被包含进来(除非文件被另一些配置排除了)

可以在模块根目录下创建一个.npmignore文件,写在这个文件里边的文件即便被写在files属性里边也会被排除在外,这个文件的写法与.gitignore类似。

11. main字段

main字段指定了加载的入口文件,require导入的时候就会加载这个文件。这个字段的默认值是模块根目录下面的index.js

12. bin字段

bin项用来指定每个内部命令对应的可执行文件的位置。如果你编写的是一个node工具的时候一定会用到bin字段。

当我们编写一个cli工具的时候,需要指定工具的运行命令,比如常用的webpack模块,他的运行命令就是webpack

"bin": {
    
  "webpack": "bin/index.js",
}
复制代码

当我们执行webpack命令的时候就会执行bin/index.js文件中的代码。

在模块以依赖的方式被安装,如果存在bin选项。在node_modules/.bin/生成对应的文件, Npm会寻找这个文件,在node_modules/.bin/目录下建立符号链接。由于node_modules/.bin/目录会在运行时加入系统的PATH变量,因此在运行npm时,就可以不带路径,直接通过命令来调用这些脚本。

所有node_modules/.bin/目录下的命令,都可以用npm run [命令]的格式运行。在命令行下,键入npm run,然后按tab键,就会显示所有可以使用的命令。

13. man字段

man用来指定当前模块的man文档的位置。

"man" :[ "./doc/calc.1" ]
复制代码

14. directories字段

directories制定一些方法来描述模块的结构, 用于告诉用户每个目录在什么位置。

15. repository字段

指定一个代码存放地址,对想要为你的项目贡献代码的人有帮助

"repository" : {
    
  "type" : "git", 
  "url" : "https://github.com/npm/npm.git"
}
复制代码

16. scripts字段

scripts指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start时,所要执行的命令。

"scripts": {
    
  "start": "node ./start.js"
}
复制代码

使用scripts字段可以快速的执行shell命令,可以理解为alias

scripts可以直接使用node_modules中安装的模块,这区别于直接运行需要使用npx命令。

"scripts": {
    
  "build": "webpack"
}

// npm run build
// npx webpack
复制代码

17. config字段

config字段用于添加命令行的环境变量。

{
    
  "name" : "yindong",
  "config" : {
     "port" : "8080" },
  "scripts" : {
     "start" : "node server.js" }
}
复制代码

然后,在server.js脚本就可以引用config字段的值。

console.log(process.env.npm_package_config_port); // 8080
复制代码

用户可以通过npm config set来修改这个值。

npm config set yindong:port 8000
复制代码

18. dependencies字段, devDependencies字段

dependencies字段指定了项目运行所依赖的模块,devDependencies指定项目开发所需要的模块。

它们的值都是一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。

当安装依赖的时候使用--save参数表示将该模块写入dependencies属性,--save-dev表示将该模块写入devDependencies属性。

"devDependencies": {
    
        "webpack": "^5.38.1",
}
复制代码

对象的每一项通过一个键值对表示,前面是模块名称,后面是对应模块的版本号。版本号遵循“大版本.次要版本.小版本”的格式规定。

版本说明

固定版本: 比如5.38.1,安装时只安装指定版本。 波浪号: 比如~5.38.1, 表示安装5.38.x的最新版本(不低于5.38.1),但是不安装5.39.x,也就是说安装时不改变大版本号和次要版本号。 插入号: 比如ˆ5.38.1, ,表示安装5.x.x的最新版本(不低于5.38.1),但是不安装6.x.x,也就是说安装时不改变大版本号。需要注意的是,如果大版本号为0,则插入号的行为与波浪号相同,这是因为此时处于开发阶段,即使是次要版本号变动,也可能带来程序的不兼容。 latest: 安装最新版本。

19. peerDependencies字段

当我们开发一个模块的时候,如果当前模块与所依赖的模块同时依赖一个第三方模块,并且依赖的是两个不兼容的版本时就会出现问题。

比如,你的项目依赖A模块和B模块的1.0版,而A模块本身又依赖B模块的2.0版。

大多数情况下,这不构成问题,B模块的两个版本可以并存,同时运行。但是,有一种情况,会出现问题,就是这种依赖关系将暴露给用户。

最典型的场景就是插件,比如A模块是B模块的插件。用户安装的B模块是1.0版本,但是A插件只能和2.0版本的B模块一起使用。这时,用户要是将1.0版本的B的实例传给A,就会出现问题。因此,需要一种机制,在模板安装的时候提醒用户,如果A和B一起安装,那么B必须是2.0模块。

peerDependencies字段,就是用来供插件指定其所需要的主工具的版本。可以通过peerDependencies字段来限制,使用myless模块必须依赖less模块的3.9.x版本.

{
    
  "name": "myless",
  "peerDependencies": {
    
    "less": "3.9.x"
  }
}
复制代码

注意,从npm 3.0版开始,peerDependencies不再会默认安装了。就是初始化的时候不会默认带出。

20. bundledDependencies字段

bundledDependencies指定发布的时候会被一起打包的模块.

21. optionalDependencies字段

如果一个依赖模块可以被使用, 同时你也希望在该模块找不到或无法获取时npm继续运行,你可以把这个模块依赖放到optionalDependencies配置中。这个配置的写法和dependencies的写法一样,不同的是这里边写的模块安装失败不会导致npm install失败。

22. engines字段

engines字段指明了该模块运行的平台,比如Node或者npm的某个版本或者浏览器。

{
     "engines" : {
     "node" : ">=0.10.3 <0.12", "npm" : "~1.0.20" } }
复制代码

23. os字段

可以指定你的模块只能在哪个操作系统上运行

"os" : [ "darwin", "linux", "win32" ]
复制代码

24. cpu字段

限制模块只能在某种架构的cpu下运行

"cpu" : [ "x64", "ia32" ]
复制代码

25. private字段

如果这个属性被设置为truenpm将拒绝发布它,这是为了防止一个私有模块被无意间发布出去。

"private": true
复制代码

26. publishConfig字段

这个配置是会在模块发布时生效,用于设置发布用到的一些值的集合。如果你不想模块被默认标记为最新的,或者默认发布到公共仓库,可以在这里配置tag或仓库地址。

通常publishConfig会配合private来使用,如果你只想让模块被发布到一个特定的npm仓库,如一个内部的仓库。

"private": true,
"publishConfig": {
    
  "tag": "1.0.0",
  "registry": "https://registry.npmjs.org/",
  "access": "public"
}
复制代码

27. preferGlobal字段

preferGlobal的值是布尔值,表示当用户不将该模块安装为全局模块时(即不用–global参数),要不要显示警告,表示该模块的本意就是安装为全局模块。

"preferGlobal": false
复制代码

28. browser字段

browser指定该模板供浏览器使用的版本。Browserify这样的浏览器打包工具,通过它就知道该打包那个文件。

"browser": {
      "tipso": "./node_modules/tipso/src/tipso.js" },
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/hkw20/article/details/119295575

智能推荐

android 高仿 探探卡片滑动,玩转仿探探卡片式滑动效果-程序员宅基地

文章浏览阅读763次。博文出处:玩转仿探探卡片式滑动效果,欢迎大家关注我的博客,谢谢!讲起本篇博客的历史起源,估计有一段“历史”了。最早可以追溯到我试玩探探这个 APP 。第一次进入软件界面,就被这种通过卡片式滑动来选择“喜欢/不喜欢”的设计所吸引了。当时就非常想通过自己来实现这种仿探探式的效果,然而却没什么思路。不过毋庸置疑的是,这种效果的原理肯定和 ListView / RecyclerView 类似,涉及到 It..._安卓仿探探卡片滑动

c primer plus--数据和C(第3章)--习题-程序员宅基地

文章浏览阅读152次。以前觉得看书不如看视频教程,但随着学习倒发觉视频不如书来得细致,比如打印sizeof()函数时用的%u,以前看视频时老师也只说要用%u,也不太清楚为什么要用这个,只知道记住就得了。虽然视频比较方便,但学着学着就会想知道原理之类的东西,这些天看完本章内容所说此处指unsigned,这才明白缘由。果然我看书是真的慢(手动狗头)第三章 数据和C----3.11 编程练习1.通过试验的..._1 #include2 int main(void){3 float d, j;4 int y;5 j=3.156;6 y=4

360浏览器 根据网页META 自动切换内核-程序员宅基地

文章浏览阅读96次。为什么80%的码农都做不了架构师?>>> ..._检测浏览器根据系统页面head标签中的代码特征来自动切换内核

css连续选取几个li_详解:5种CSS选择器的结合使用-程序员宅基地

文章浏览阅读2.2k次。1、元素选择器2、类选择器3、ID选择器4、属性选择器5、派生选择器1、元素选择器最常见的css选择器当属元素选择器了,在HTML文档中该选择器通常是指某种HTML元素,例如:p,h2,span,a,div乃至html。用法十分简单,例如:以下css代码会对整个文档添加黑色背景;将所有p元素字体大小设置为30像素同时添加灰色背景;对文档中所有h2元素添加红色背景。1 html {backgroun..._css 选择连续元素

离散数学太多符号了_离散数学符号大全-程序员宅基地

文章浏览阅读486次。├ 断定符(公式在L中可证)╞ 满足符(公式在E上有效,公式在E上可满足)┐ 命题的“非”运算∧ 命题的“合取”(“与”)运算∨ 命题的“析取”(“或”,“可兼或”)运算→ 命题的“条件”运算A<=>B 命题A 与B 等价关系A=>B 命题 A与 B的蕴涵关系A* 公式A 的对偶公式wff 合式公式iff 当且仅当↑ 命题的“与非” 运算( “与非门” )↓ 命题的“或非”运算(..._集合a的点数

OnePlus5刷 TWRP-程序员宅基地

文章浏览阅读819次。# 安装adbapt install adb# 安装fastbootapt install fastboot# 进入bootloader模式adb reboot bootloader# 刷入twrpfastboot flash recovery Downloads/twrp-3.3.1-0-cheeseburger.img # 注意:此时不要重启手机,否则twrp..._一加5刷入twrp

随便推点

Kafka+Zookeeper+Filebeat+ELK 搭建日志收集系统-程序员宅基地

文章浏览阅读145次。ELKELK目前主流的一种日志系统,过多的就不多介绍了Filebeat收集日志,将收集的日志输出到kafka,避免网络问题丢失信息kafka接收到日志消息后直接消费到LogstashLogstash将从kafka中的日志发往elasticsearchKibana对elasticsearch中的日志数据进行展示image环..._filebeat squid

html put 方法,HTML canvas putImageData() 方法-程序员宅基地

文章浏览阅读567次。在线示例下面的代码使用getImageData()复制画布上指定矩形的像素数据,然后使用putImageData()将图像数据放回画布上:示例html>HTMLcanvasgetImageData()方法使用-基础教程(nhooo.com)您的浏览器不支持HTML5canvas标签。varc=document.getElementById("myCanvas");varctx=..._多次调用putimagedata

shell 脚本 报警监控3306 80 端口-程序员宅基地

文章浏览阅读125次。原创作品,允许转载,转载时请务必以超链接形式标明文章 原始出处 、作者信息和本声明。否则将追究法律责任。http://kerry.blog.51cto.com/172631/320349 最近公司服务器所在机房常因***和网络故障导致网站无法正常访问,为了能第一时间获知网站无法访问,并快速处理问题,特利用shell脚本对服务器访问状况进行监控,一但..._监控一组80端口 脚本

离线状态下在服务器上部署深度学习所需python包和数据集_深度学习部署pynq-程序员宅基地

文章浏览阅读1k次。离线状态下在服务器上部署深度学习所需python包和数据集所解决问题解决python包的问题移植环境离线安装python包解决数据包的问题最终程序运行结果所解决问题最近,想在学校服务器上运行网络上其他人写的基于YOLOv3的目标识别程序,通过github得到了代码,但是遇到的问题是:学校的服务器是只能内网连接,无法通过Anaconda 的install命令或者pip命令去安装,其次,目前很多的github代码中数据集都是通过编写sh文件来在线获取,因此要想运行例子代码是需要解决以上两个问题。解决pyt_深度学习部署pynq

java中==和equals的区别_Java中==和equals的区别-程序员宅基地

文章浏览阅读59次。介绍首先==和equals可以比较基础数据类型,比如int a =1,也可以比较引用数据类型,比如Object a = new Object(),那我们就分别看一下在比较基础数据类型和引用数据类型时有什么区别.分析这是一道常见的面试题,要明白==和equals的区别,先看一下源码,equals是Object类的方法,看一下Object类的源码.public booleanequals(Object..._java ==和equals的区别

linux-ubuntu之mongodb(二):安装及配置_ubuntu mongodb安装-程序员宅基地

文章浏览阅读128次。安装下载:wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.0.6.tgz解压缩并移包:tar -zxvf mongodb-linux-x86_64-3.0.6.tgz,mv mongodb-linux-x86_64-3.0.6 /xxx/mongodb/;mongod定位移动自定义的目录,后使用命令mkdir -p ..._ubuntu mongodb安装