简单学习npm

一、npm是什么?

在讲npm是什么之前,我们来讲一下什么是Node
NodeJavaScript语言的服务器运行环境(一般我都是用浏览器来调试JavaScript的)

  • Javascript语言通过Node在服务器运行
  • Node提供大量工具库,使得JavaScript语言与操作系统互动(如读写文件)

好了,现在我们来讲一下什么是npm
npmNode默认的模块管理器,用来安装和管理Node模块,是一个使用Node.js编写的包管理工具。(ps:就是一段实现某个特定功能的JavaScript代码)

二、npm的使用

  1. npm的安装
    npm不需要单独安装,在安装Node的时候,会连带一起安装npm
    但是,Node附带的npm可能不是最新版本,最好用下面的命令,更新到最新版本。不过以下方法会有些问题,具体可以参考下这篇文章windows系统下npm升级的正确姿势以及原理
npm install npm@latest -g
  1. npm init
    npm init用来初始化生成一个新的package.json文件。它会向用户提问一系列问题,如果你觉得不用修改默认配置,一路回车就可以了。
    如果使用了-f(代表force)、-y(代表yes),则跳过提问阶段,直接生成一个新的package.json文件。
  • 转到对应的目录下,输入npm init命令,一路回车
    image.png
  • npm init -y会直接生成package.json文件
    image.png
  1. npm set
    npm set用来设置环境变量
npm set init-author-name 'Your name'
npm set init-author-email 'Your email'
npm set init-author-url 'http://yourdomain.com'
npm set init-license 'ISC'

上面命令等于为npm init设置了默认值,以后执行npm init的时候,package.json的作者姓名、邮件、主页、许可证字段就会自动写入预设的值。这些信息会存放在用户主目录的~/.npmrc文件,使得用户不用每个项目都输入。

  1. npm install -gnpm install
    Node模块(npm包)采用npm install命令来安装
    每个模块可以全局安装,也可以本地安装
  • 全局安装(npm install -g <package name>) 指的是将一个模块安装到系统目录中,各个项目都可以调用。一般来说,全局安装只适用于工具模块,比如eslintgulp
  • 本地安装(npm install <package name>) 指的是将一个模块下载到当前项目的node_modules子目录,然后只有在项目目录之中,才能调用这个模块
  • 下面的命令执行之后将会在当前的目录下创建一个 node_modules的目录(如果不存在的话),然后将下载的包保存到这个目录下
// 本地安装
npm install <package name>

// 全局安装
npm install -global <package name>
npm install -g <package name>
  • 例如安装一个http-server和一个lodash的包
npm install -g http-server

npm install lodash
image.png
  1. npm install --savenpm install --save-dev
    install命令可以使用不同参数,指定所安装的模块属于哪一种性质的依赖关系,即出现在packages.json文件的哪一项中
    即:把一个模块安装到node-modules下,且将文件写入到packges.json文件中的对应项中
  • --save:模块名将被添加到dependencies,可以简化为参数-S
  • --save-dev: 模块名将被添加到devDependencies,可以简化为参数-D

添加依赖进入 package.json 文件的 dependencies

npm install <package_name> --save
# 或者
npm install <package_name> -S

添加依赖进入 package.json 文件的devDependencies

npm install <package_name> --save-dev
# 或者
npm install <package_name> -D
  1. npm uninstallx卸载包
    npm uninstall命令,卸载已安装的模块。
npm uninstall <package_name>
# 卸载全局模块
npm uninstall <package_name> -global
  1. npm run xxx
    npm不仅可以用于模块管理,还可以用于执行脚本。package.json文件有一个scripts字段,可以用于指定脚本命令,供npm直接调用。
{
  "name": "myproject",
  "devDependencies": {
    "jshint": "latest",
    "browserify": "latest",
    "mocha": "latest"
  },
  "scripts": {
    "lint": "jshint **.js",
    "test": "mocha test/"
  }
}

上面代码中,scripts字段指定了两项命令linttest。命令行输入npm run-script lint或者npm run lint,就会执行jshint **.js,输入npm run-script test或者npm run test,就会执行mocha test/npm runnpm run-script的缩写,一般都使用前者,但是后者可以更好地反应这个命令的本质。

npm run命令会自动在环境变量$PATH添加node_modules/.bin目录,所以scripts字段里面调用命令时不用加上路径,这就避免了全局安装NPM模块。

npm run如果不加任何参数,直接运行,会列出package.json里面所有可以执行的脚本命令。

npm内置了两个命令简写,npm test等同于执行npm run testnpm start等同于执行npm run start

npm run会创建一个Shell,执行指定的命令,并临时将node_modules/.bin加入PATH变量,这意味着本地模块可以直接运行。

三、package.json

每个项目的根目录下面,一般都有一个package.json文件,定义了这个项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install命令根据这个配置文件,自动下载所需的模块,即配置项目所需的运行和开发环境

package.json文件可以手工编写,也可以使用npm init命令自动生成。

下面是一个package.json文件

{
    "name": "Hello World",
    "version": "1.0.0",
    "author": "",
    "description": "第一个node.js程序",
    "keywords":[],
    "repository": {
        "type": "git",
        "url": "https://path/to/url"
    },
    "license":"ISC",
    "bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
    "scripts": {
        "start": "node index.js"
    },
    "dependencies": {
        "express": "latest",
        "mongoose": "~3.8.3",
        "handlebars-runtime": "~1.0.12"
    },
    "devDependencies": {
        "bower": "~1.2.8",
        "grunt": "~0.4.1",
        "grunt-contrib-concat": "~0.3.0",
        "grunt-contrib-jshint": "~0.7.2",
        "grunt-contrib-uglify": "~0.2.7",
        "grunt-contrib-clean": "~0.5.0",
        "browserify": "2.36.1",
        "grunt-browserify": "~1.3.0",
    }
}

简单介绍默认信息:

  • name: 当前目录名称
  • version: 总会是 1.0.0
  • description: 来自readme文件,没有就是空字符串 ""
  • main: 总会是 index.js
  • scripts: 默认情况下会创建一个空的测试脚本
  • keywords: 为空
  • author: 为空
  • license:ISC
  • bugs: 来自当前目录的信息(如果存在)
  • homepage: 来自当前目录的信息(如果存在)
  1. scripts字段
    scripts指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start时,所要执行的命令。
  2. dependencies字段,devDependencies字段
    它们都指向一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。
    • dependencies字段指定了项目运行所依赖的模块,这个对象里面的内容就是我们这个项目所依赖的 js模块包
    • devDependencies指定项目开发所需要的模块,在我们开发的时候会用到的一些包,只是在开发环境中需要用到,但是在别人引用我们包的时候,不会用到这些内容,放在devDependencies 的包

当拥有了一个完整的 package.json文件的时候,就可以让人一眼看出来,这个模块的基本信息,和这个模块所需要依赖的包。我们可以通过 npm install 就可以很方便的下载好这个模块所需要的包

npm install默认会安装dependencies字段和 devDependencies字段中的所有模块,如果使用--production 参数,可以只安装 dependencies字段的模块。

 npm install --production
  1. main字段
    main字段指定了加载的入口文件,require('moduleName')就会加载这个文件。这个字段的默认值是模块根目录下面的index.js

四、流程捋一遍

  1. Node.js官网下载并安装Node,安装Node的同时npm也会一并安装,可使用npm -v查看npm是否成功安装,若出现对应版本号,则安装成功

    npm版本查询

  2. 创建一个文件夹,如npmdemo

  3. 打开终端,cdnpmdemo文件夹下,使用npm init -y来创建一个默认的package.json文件

    默认package文件创建

  4. 本地安装一个依赖(包),如axios,使用npm install axios

    包安装

    会把axios模块安装到node-modules(若没有node-modules,会自动生成,(插一句node-modules目录下的.bin目录保存着Node模块的可执行脚本))下,且将文件写入到packges.json文件中的dependencies对象中
    image.png

  5. 至此,我们就完成了一个包的安装,要使用他,就可在对应文件中require即可

// index.js
const axios = require('axios');
  1. 更新包,cd到项目的根目录中,运行update命令
//更新所有的包
npm update
// 更新单独的包
npm update axios

参考资料

http://javascript.ruanyifeng.com/nodejs/npm.html
https://www.jianshu.com/p/dca65f9493ad

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容