npm 与 package.json

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/jnshu_it/article/details/89278241

大家好,这里是修真院前端小课堂,今天给大家分享的是

《npm 与 package.json》

1. 背景介绍

NPM 是什么?
NPM(node package manager),通常称为 node 包管理器。顾名思义,它的主要功能就是管理 node 包,包括:安装、卸载、更新、查看、搜索、发布等。
npm 的背后,是基于 couchdb 的一个数据库,详细记录了每个包的信息,包括作者、版本、依赖、授权信息等。它的一个很重要的作用就是:将开发者从繁琐的包管理工作(版本、依赖等)中解放出来,更加专注于功能的开发。

我们需要了解什么?
1.npm 的安装、卸载、升级、配置
2.npm 的使用:package 的安装、卸载、升级、查看、搜索、发布
3.npm 包的安装模式:本地 vs 全局
4.package.json:包描述信息
5.package 版本:常见版本声明形式

2. 知识剖析

npm 包安装模式:
node 包的安装分两种:本地安装、全局安装。两者的区别如下:
本地安装:npm install pkg,package 会被下载到当前所在目录,也只能在当前目录下使用。
全局安装:npm install -g pkg,package 会被下载到到特定的系统目录下,安装的 package 能够在所有目录下使用

通过 package.json 进行安装:
如果我们的项目依赖了很多 package,一个一个地安装那将是个体力活。我们可以将项目依赖的包都在 package.json 这个文件里声明,然后一行命令搞定
npm install

其他 package 安装命令
运行如下命令,列出所有 npm install 可能的参数形式:

npm install --help
npm uninstall pkg:卸载
npm ls:查看当前目录安装了哪些 package
npm info pkg:查看特定 package 的详细信息
npm update pkg:package 更新
npm search pgk:搜索

NPM 配置
npm 的配置工作主要是通过 npm config 命令,主要包含增、删、改、查几个步骤,下面就以最为常用的 proxy 配置为例:

设置 proxy:npm set prox
查看 proxy:npm get proxy
删除 proxy:npm delete proxy
查看所有配置:npm config list
直接修改配置文件:npm config edit

3. 常见问题

什么是 package.json?

4. 解决方案

假设当我们下载了 node 应用,这个 node 应用依赖于 A、B、C 三个包,如果没有 package.json,我们需要人肉安装这个三个包(如果对版本有特定要求就更悲剧了):

npm install A
npm install B
npm install C

有了 package.json,一行命令安装所有依赖。
npm install

5. 编码实战

npm 允许在 package.json 文件里面,使用 scripts 字段定义脚本命令。
"scripts": {"build": "node build.js"}
上面代码是 package.json 文件的一个片段,里面的 scripts 字段是一个对象。它的每一个属性,对应一段脚本。比如,build 命令对应的脚本是 node build.js.
命令行下使用 npm run 命令,就可以执行这段脚本。
npm run build
node build.js

6. 扩展思考

package.json 字段简介

package.json 中最重要的属性是 name 和 version 两个属性,这两个属性是必须要有的,否则模块就无法被安装,这两个属性一起形成了一个 npm 模块的唯一标识符。模块中内容变更的同时,模块版本也应该一起变化。

name 属性就是你的模块名称,下面是一些命名规则:
1. 必须小于等于 214 个字节,包括前缀名称在内(如 x/xmodule)。
2.name 属性会成为模块 url、命令行中的一个参数或者一个文件夹名称,任何非 url 安全的字符在 name 中都不能使用,也不能以 "_" 或 "." 开头,不能含有大写字母
3. 不要使用和 node 核心模块一样的名称,明早不要含有 "js" 和 "node"。
4.name 属性也许会被写在 require () 的参数中,所以最好取个简短而语义化的值。
5. 创建一个模块前可以先到 https://www.npmjs.com查查 name 是否已经被占用.

version:
package 的版本,当 package 发生变化时,version 也应该跟着一起变化,同时,version 必须可以被 npm 依赖的一个 node-semver 模块解析。

description:
package 的应用依赖模块,即别人要使用这个 package,至少需要安装哪些东东。应用依赖模块会安装到当前模块的 node_modules 目录下。

devDependencies:
package 的开发依赖模块,即别人要在这个 package 上进行开发。

常见版本声明形式:
1."~1.2.3" 是神马意思呢:
"~1.2.3" = ">=1.2.3 <1.3.0"

2."1.x.x" 是什么意思呢:
"1.2.x" = ">=1.2.0 <1.3.0"

3.~version "约等于",^version " 兼容版本

 

7. 参考文献

npm package.json 属性详解:http://www.cnblogs.com/tzyy/p/5193811.html


【更多内容,可以加入IT交流群565734203与大家一起讨论交流】

【这里是技能树·IT修真院:IT修真院官网,初学者转行到互联网的聚集地】

猜你喜欢

转载自blog.csdn.net/jnshu_it/article/details/89278241