管理本地安装的npm包的最佳方法是创建一个 package.json文件。本篇文章就来带大家了解一下package.json文件,希望对大家有所帮助!
了解package.json
每个项目(npm上下载的包,或者其他的nodejs项目)的根目录下面,一般都有一个package.json文件, 定义了这个项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证、如何启动项目、运行脚本等元数据)。npm install命令根据这个配置文件,自动下载所需的模块。
package.json文件就是一个json对象,该对象的每一个成员就是当前项目的一项设置。比如name就是项目名称,version是版本(遵守“大版本.次要版本.小版本”的格式)。还会在项目的生命周期中扮演多个角色、开发、测试、上线版本。
package.json的作用
作为一个描述文件,描述了你的项目所依赖的包允许我们使用 “语义化版本规则”(后面介绍)指明你项目依赖包的版本让你的构建更好地与其他开发者分享,便于重复使用package.json如何创建
1、使用命令行工具客户端cli
npm init
这将启动命令行调查问卷,该调查问卷将package.json在您启动命令的目录中创建.
2、创建默认值
要获取默认值package.json,请npm init使用--yes or -y标志运行:
npm init -y
此方法将package.json使用从当前目录中提取的信息生成默认值, 跳过回答问题步骤 。
3、手动创建
直接在项目根目录新建一个 package.json 文件,然后输入相关的内容。 具体请查看下文package.json的注意事项。
package.json文件常见字段详解
1、 name
必须字段 ,当前模块\包名称, 长度必须小于等于214个字符,不能以.(点)或者_(下划线)开头,不能包含大写字母。
这个名字可能会作为参数被传入require(),所以它应该比较短,但也要意义清晰。
2、 version
必须字段 ,当前包的版本号,初次建立默认为1.0.0。
version必须可以被npm依赖的一个node-semver模块解析 。定义了当前项目的版本迭代进度。 (遵守“大版本.次要版本.小版本”的格式)
可能现在很多小伙伴们没有注意或者不在乎版本号,更多使用产品的版本号,或者git hashcode方式。
3、 description
可选字段,必须是字符串。当前包的描述信息,是一个字符串。它可以帮助人们在使用npm search时找到这个包。
如果 package.json 中没有 description 信息,npm 使用项目中的 readme.md 的第一行作为描述信息。这个描述信息有助于别人搜索你的项目,因此建议好好写 description 信息。
4、 main
可选字段, 指定了项目加载的入口文件。
这个字段的默认值是模块根目录下面的index.js。
5、 scripts
可选字段,scripts是一个由脚本命令组成的hash对象,他们在包不同的生命周期中被执行。key是生命周期事件,value是要运行的命令。 指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start时,所要执行的命令。我们可以自定义我们想要的运行脚本命令。
参考:http://www.ruanyifeng.com/blog/2016/10/npm_scripts.html
scripts配置执行的脚本
1)执行命令 echo xxx
执行node_modules/.bin 下的文件为什么可以执行呢?
当我执行 npm run的时候,就会自动新建一个 shell,在这个 shell 里面执行指定的脚本命令。因此,只要是 shell(一般是 bash)可以运行的命令,就可以写在 npm 脚本里面。会把当前目录下的node_modules/.bin也拷贝到当前的系统的path(只是临时拷贝,执行结束后,在将path变量恢复原样), 所以当前目录的node_modules/.bin子目录里面的所有脚本,都可以直接用脚本名调用,而不必加上路径。
例如:
我们用node执行一个node.js服务是,node + 文件 可以用node server.js; 我们也可以用webpack的打包前端文件,webpack-dev-server,当然webpack 和webpack-dev-server是要安装依赖的模块;
scripts: { build: webpack --mode=development, dev: webpack-dev-server --mode=development --contentbase=./dist, server:node app.js }
我们在命令行工具中输入npm run server ,就会调用node app.js帮我们运行。
简写形式:
npm start是npm run startnpm stop是npm run stop的简写npm test是npm run test的简写npm restart是npm run stop && npm run restart && npm run start的简写
常用脚本 -----网上收集转
// 删除目录clean: rimraf dist/*,// 本地搭建一个 http 服务serve: http-server -p 9090 dist/,// 打开浏览器open:dev: opener http://localhost:9090,// 实时刷新 livereload: live-reload --port 9091 dist/,// 构建 html 文件build:html: jade index.jade > dist/index.html,// 只要 css 文件有变动,就重新执行构建watch:css: watch 'npm run build:css' assets/styles/,// 只要 html 文件有变动,就重新执行构建watch:html: watch 'npm run build:html' assets/html,// 部署到 amazon s3deploy:prod: s3-cli sync ./dist/ s3://example-com/prod-site/,// 构建 faviconbuild:favicon: node scripts/favicon.js,start: cross-env node_env=production node server/index.js,
6、 dependencies、devdependencies
可选字段, dependencies字段指定了项目运行所依赖的模块 , devdependencies指定项目开发所需要的模块 。
值指向一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。
默认创建的package.json没有,当我们安装npm install一个模块时就会生成。
npm install expressnpm install express --savenpm install express --save-dev
上面代码表示单独安装express模块,
后边没有参数时,表示安装到dependencies属性,--save参数表示将该模块写入dependencies属性,--save-dev表示将该模块写入devdependencies属性。7、bundleddependencies
可选字段,发布包时同时打包的其他依赖。
8、 peerdependencies
可选字段,兼容性依赖,如果你的项目或者模块,同时依赖另一个模块,但是所依赖的版本不一样。
比如,你的项目依赖a模块和b模块的1.0版,而a模块本身又依赖b模块的2.0版。
{ name: chai-as-promised, peerdependencies: { chai: 1.x }}
上面代码指定,安装chai-as-promised模块时,主程序chai必须一起安装,而且chai的版本必须是1.x。如果你的项目指定的依赖是chai的2.0版本,就会报错。
9、 bin
可选字段,bin字段用来指定各个内部命令对应的可执行文件的位置。
在项目根目录创建/bin/www文件
#! /usr/bin/env node
package.json中配置
bin:{ lee-cli:./bin/www}
npm link 将package中的属性bin的值路径添加全局链接 创建快捷方式连接
在命令行中执行lee-cli就会执行bin/www文件。过程是:
在上面的例子中,www会建立符号链接node_modules/.bin/www。由于node_modules/.bin/目录会在运行时加入系统的path变量,因此在运行npm时,就可以不带路径,直接通过命令来调用这些脚本。
10、 config
config字段用于向环境变量输出值
{ name : package, config : { port : 8080 }, scripts : { start : node server.js }}
如果想改变我们可以使用
npm config set package:port 80
11、engines
可选字段,指明了该模块运行的平台版本,比如 node 的某个版本或者浏览器, 也可以指定适用的npm版本 。
engines : { node : >=0.10.3 <0.12"}
12、license
可选字段, 表示定义适用于package.json所描述代码的许可证。不同的协议有不同的限制。让用户知道他们有何权限来使用你的模块,以及使用该模块有哪些限制。
可参考: choosealicense.com/ 选择许可证。
如:mit:最大许可,别人下载你的代码可以改你的代码,默认安装值。
13、author
可选字段,项目开发者。
14、private
可选字段,布尔值,是否私有,设置为 true 时,npm 拒绝发布。
这是防止私有包被以外发布的一种方法。如果你希望包装某个包只能被发布到特定的一个registry中(比如,一个内部的registry),则可以使用下面的publishconfig字典来描述以在publish-time重写registry配置参数。
15、keywords
可选字段,项目关键字,是一个字符串数组。它可以帮助人们在使用npm search时找到这个包。
16、os
可选字段,指定模块可以在什么操作系统上运行
17、style
style指定供浏览器使用时,样式文件所在的位置。
18、repository
包代码存放的地方的类型,可以是 git 或 svn,git 可在 github 上
19、homepage
可选字段,没有http://等带协议前缀的url。
版本问题:
version:"1.0.0"
1.0.0:
第一位改变表示:不兼容老代码,大规模的更新,新版本发布;
第二位表示:增加了一些功能,向下兼容;
第三位表示:小的补丁,bug修改;
我们发表项目的时候,一盘使用npm + git
使用npm version patch (patch打补丁) 这种会改变版本的第三位;使用git tag 执行即会自动在git上版本号使用npm version minor这种改变的版本号的第二位;同步git版本;使用npm version major 这种改变版本号的第一位;同步git版本;npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]major:主版本号minor:次版本号patch:补丁号premajor:预备主版本prepatch:预备次版本prerelease:预发布版本
ps:注意,如果报错:git working directory not clean是说明你现在需要git status是clean的。
git add .git commit -mpackage.json详解
npm versin monir -m增加版本号
git push -u origin master
如何制定规则?
作为使用者,我们可以在 package.json 文件中写明我们可以接受这个包的更新程度(假设当前依赖的是 1.2.4 版本):
如果只打算接受补丁版本的更新(也就是最后一位的改变),就可以这么写:
1.2 1.2.x ~1.2.4
如果接受小版本的更新(第二位的改变),就可以这么写:
11.x^1.2.4
如果可以接受大版本的更新(自然接受小版本和补丁版本的改变),就可以这么写:
*x
小结一下:总共三种版本变化类型,接受依赖包哪种类型的更新,就把版本号准确写到前一位。
版本周期、阶段:
α -alpha 第一阶段 一般只供内测使用β -beta 第二阶段 已经消除了软件中大部分的不完善之处,但是仍有可能还存在缺陷和漏洞,一般提供给特定的用户群里来测试使用;γ - rc 是第三阶段,此时产品已经相当成熟,只需要在个别地方在做进一步的优化处理即可上市发布例如:
2.1.0-beta.1 一般这样用户不会安装这种的,这种可以用内侧、测试人员使用。
依赖包的版本问题
实例说明
~1.2.3 主版本+次要版本+补丁版本;1.2.3 <= version < 1.3.0;
~1.2 主版本+次要版本;1.2.0 <= version < 1.3.0
~1 主版本;1.0.0 <= version < 2.0.0
符号实例版本范围说明
1.0.0 1.0.0 锁定1.0.0版本,必须这个版本。
^会匹配最新的大版本依赖包 ^1.2.3、^0.2.3 >=1.2.3 <2.0.0、>=0.2.3 <0.3.0 表示安装1.x.x的最新版本(不低于1.2.3,包括1.3.0),但是不安装2.x.x,也就是说安装时不改变大版本号。需要注意的是,如果大版本号为0,则插入号的行为与波浪号相同,这是因为此时处于开发阶段,即使是次要版本号变动,也可能带来程序的不兼容。(主版本)
~会匹配最近的小版本依赖包 ~1.2.3 >=1.2.3 <1.3.0 表示安装1.2.x的最新版本(不低于1.2.3),但是不安装1.3.x,也就是说安装时不改变大版本号和次要版本号。
>= >=2.1.0 >=2.1.0 大于等于2.1.0
<= <=2.0.0 <=2.0.0 小于等于2.0.0
laster
安装最新的版本
*
>=0.0.0 任何版本
- 1.2.3 - 2.3.4 >=1.2.3 <=2.3.4
区分安装dependencies和dependencies?
devdependencies是开发所需要的模块,所以我们可以在开发过程中需要的安装上去,来提高我们的开发效率,比如一些知名的第三方库, webpack、rollup、less、babel这些。 就没必要在生成环境安装。
以下类库都建议安装到devdependencies:
单元测试支撑(mocha、chai);语法兼容(babel);语法转换(jsx to js、coffeescript to js、typescript to js)程序构建与优化(webpack、gulp、grunt、uglifyjs);css 处理器(postcss、scss、stylus);代码规范(eslint);依赖包(指定、更新、本地、使用、卸载)
1、安装本地依赖包
npm install jquery
这个命令会在当前目录创建一个 node_modules 目录,然后下载我们指定的包到这个目录中。
2、指定安装版本,可以在package name后@版本号。
如果包的名称以包开头@,则它是一个范围包。
npm install jquery@3.4.1npm install jquery@">=1.1.0 <2.2.0"npm install jquery@latest
更新之后,dependencies内的版本号也会改变。
3、更新依赖包
npm update jquery
4、使用包
let jquery = require('jquery');
<script src="/node_modules/jquery/dist/jquery.js">//这个需要注意路径</script>6、卸载依赖包
npm uninstall jquery
semantic versioning(语义化版本规则)
https://docs.npmjs.com/about-semantic-versioning
https://github.com/npm/node-semver
package.json注意事项
根据上边我们在使用npm init会询问我们填几项内容,有的可以不填,有的必须填,这些必填都是一个package.json内容必须要具备的字段:name和version,如果没有,无法执行install
name:全是小写,没有空格,循序使用连字符和下划线version: 版本号,遵循上边说的语义化版本规则x.x.x其他注意事项:
添加中文注释会编译出错更多node相关知识,请访问:nodejs 教程!
以上就是深入浅析package.json文件的详细内容。