npm node package manager
nodejs的包管理工具

什么是 npm？
就是别人写的 nodejs模块，可以直接拿来使用

npm文档 https://www.npmjs.cn/getting-started/creating-node-modules

image.png

  1. npm, Node Package Manager
  2. npm包是从哪里下载的？，就是 registry
    1. npm.com 为企业提供私有的 npm registry 服务和团队合作的 Saas 服务
    2. npm包就是：一个特定功能的文件夹；包是模块的集合
  1. npm i lodash --registry=https://registry.npm.taobao.org
  3. which node
  5. which npm

npm常用命令

  1. npm init
  3. npm install
  5. npm -h
  7. npm -l
  9. npm list -g --depth=0 // 查看全局安装模块

查看 npm全局安装包

  1. 开发中，会有意无意的安装了不少全局安装包，有些可能不会再使用了，有些已经太旧
  2. 查看自己电脑安装过的全局工具包，顺便卸载不需要的

npx 是个不错的选择

推荐使用 npx 的方式代替 npm install -g、yarn global 全局安装

  1. 有些包我们只会使用一次，或者只想尝试以下，不想安装到全局，也不想作为当前项目的依赖
  2. 用 npx 的方式来执行
  3. npx 是 npm 5.2+ 版本之后自带的工具，能够帮助我们更高效的执行 npm 软件仓库里的安装包 ```bash

    npx 之前

    node ./node_modules/.bin/mocha

使用 npx

npx mocha

npx创建 react项目

npx create-react-app my-app

  2. <a name="Uj4XO"></a>
  3. ### npx原理
  4.  执行npx命令，会按以下顺序工作：
  6. 1. 先查看当前项目有没 create-react-app
  7. 1. 如果当前项目找不到，会去全局查找 create-react-app
  8. 1. 如果全局还找不到，会帮我们临时从 npm 包仓库安装 create-react-app，不会污染到当前项目，也不会装到全局
  11. <a name="PyeBf"></a>
  12. ### npm查看全局安装包
  13. ```bash
  14. npm list -g --depth=0

image.png

yarn查看全局安装包

  1. yarn global list --depth=0

image.png

npm的3个部分

  1. npm 官网，网址 www.npmjs.com，查询 npm模块的信息
  2. npm registry，https://registry.npmjs.org/ 模块查询下载的服务 API
  3. npm cli，命令行下载工具，通过它来从 registry 下载模块

npm init

  1. 创建一个 package.json；npm init --yes 创建默认值的 package.json
  2. package.json信息：
    1. 当前模块/项目名称、版本、描述、作者
    2. 配置了当前项目依赖的模块及版本
    3. 配置了当前项目是在哪个 git repo 下
    4. 当前模块的主入口文件 main

npm install

  1. —save，-S
    1. 模块安装到 dependencies，运行时依赖的模块
  2. —save-dev，-D
    1. devDependencies，本地开发时依赖的模块，上线不依赖
  3. 安装模块，一定要指定 —save 或者 -S，确保本地模块正确的添加到 package.json
    1. npm install，简写 npm i
    2. 项目中已有 package.json，可以直接 npm intall 安装所有依赖项
    3. 可以把所有的模块全部 tarball 形式从本地上传到服务器，可以保证所有模块代码的绝对一致性
  4. @ 开头，私有包；scope 通常用于管理私有模块
  1. npm install <git repo url>
  3. npm install https://github.com/petkaantonov/bluebird.git // 仓库地址
  4. npm install https://github.com/caolan/async/tarball/v2.3.0
  5. npm install https://github.com/koajs/koa/archive/2.5.3.tar.gz // tar 包地址来安装
  7. // 安装本地的 tar 包
  8. npm install /Users/black/Downloads/request-2.88.1.tar.gz
  10. // 从本地文件夹安装
  11. npm install ../scott/some-module
  14. // 私有包
  15. npm install @lang/lts
  17. // 安装某个范围内的版本
  18. npm install lodash@">=2.0.0 <3.0.0"
  19. npm install @lang/lts@">=2.0.0 <3.0.0"
  21. // 卸载包
  22. npm uninstall jquery -S

npx包执行工具

  1. npx 是 npm 自带的功能，直接执行依赖包里的二进制文件
    1. 包里的二进制文件会被放到 node_modules/.bin 目录下

npm scripts

脚本能力，在 package.json 里的 scripts 里配置的各种任务

  1. npm start
  2. npm run dev
  3. npm run egg:prod
  1. 复杂的 scripts 会带来非常复杂的依赖队列，不好维护，
  2. 建议把每个独立的任务都分拆开进行组合，把复杂的任务独立写入到一个本地的脚本中，比如 task.js
  1. "scripts": {
  2.   // 通过 && 分隔，如果 clean:dist 任务失败，则不会执行后面的构建任务
  3.   "build:task1": "npm run clean:dist && npm run build:prod"
  4.   // 通过 ; 分隔，无论 clean:dist 是否成功，运行后都继续执行后面的构建任务
  5.   "build:task2": "npm run clean:dist;npm run build:prod"
  6.   // 通过 || 分隔，只有当 clean:dist 失败，才会继续执行后面的构建任务
  7.   "build:task3": "npm run clean:dist;npm run build:prod"
  8.   "clean:dist": "rimraf ./dist",
  9.   "build:prod": "cross-env NODE_ENV=production webpack",
  10.   // 对一个命令传配置参数，可以通过 -- --prod
  11.   // 比如 npm run compile:prod 相当于执行 node ./r.js --prod
  12.   "compile:prod": "npm run compile -- --prod",
  13.   "compile": "node ./r.js",
  14. }

npm publish

  1. https://www.npmjs.com/ 注册账号
  2. 本地（或者从 Github 上）创建创建一个空项目，拉到本地
  3. 增加 .gitignore 忽略文件和 README
  4. npm init 生成 package.json
  5. 编写功能代码，增加到目录 /lib
  6. npm install 本地包进行测试
  7. npm publish 发布包
  8. npm install 线上包进行验证
  9. 修改代码发布一个新版本
  1. npm login
  3. npm publish

在包目录下 npm publish

私有包

  1. 搭建自己的 registry
  2. 第三方的 registry
    1. https://github.com/cnpm/cnpmjs.org
    2. cnpm cli https://github.com/cnpm/cnpm
    3. 团队搭建私有 registry，可以参考 cnpmjs.org
    4. Aliyun Registry
  3. 把本地的包代码，改成 @scope/lts
  4. 然后本地 npm registry 切换到这个源，重新 npm login/npm publish 就可以

npm version

  1. v1.2.0 major minor patch，也就是 主版本号.次版本号.修订号
    1. major: breaking changes (做了不兼容的 API 修改)
    2. minor: feature add（向下兼容的功能性新增）
    3. patch: bug fix, docs（向下兼容的问题修正）
  2. 版本管理参考 https://semver.org/

锁定 npm版本

  1. npm shrinkwrap 把包的版本锁住，保证它的代码每一行每一个字节都恒久不变
  2. npm5 package-lock.json
  3. ~ ^ 自动升级较新版本的包
  1. ~ 选择一个最近的小版本依赖包
  2.     ~3.9.0 可以匹配到所有的 3.9.x 版本,不会匹配到 3.10.0
  4. ^ 是匹配最新的大版本
  5.     ^3.9.0 可以匹配到所有的 3.x.x，但是不会匹配到 4.0.0
  7. >=
  9. *
  11. // 完全不依赖锁包功能
  12. npm config set package-lock false

全包上传，全包回滚，防止版本不一致带来的错误

package-lock.json

package-lock.json 理解为一个详细描述代码版本的快照文件

  1. {
  2.   "name": "npm",
  3.   "version": "1.0.0",
  4.   "lockfileVersion": 1,
  5.   "requires": true,
  6.   "dependencies": {
  7.     "async": {
  8.       "version": "2.6.1",
  9.       "resolved": "http://registry.npm.taobao.org/async/download/async-2.6.1.tgz",
  10.       "integrity": "sha1-skWiPKcZMAROxT+kaqAKPofGphA=",
  11.       "requires": {
  12.         "lodash": "^4.17.10"
  13.       }
  14.     },
  15.     "lodash": {
  16.       "version": "4.17.11",
  17.       "resolved": "http://registry.npm.taobao.org/lodash/download/lodash-4.17.11.tgz",
  18.       "integrity": "sha1-s56mIp72B+zYniyN8SU2iRysm40="
  19.     }
  20.   }
  21. }
  1. version 就是包的准确版本号
  2. resolved 则是一个明确 tar 包地址，唯一不变的
  3. integrity 这个内容 hash 的值，三个就决定了这个包准确身份信息
  4. requires 字段实现，让这些包向下依赖时保持不变

node_modules

  1. npm3 里面，安装策略改成了平铺结构，全部平铺到 node_modules
  2. 每个文件夹都是一个 package（包），每个包都有自己依赖的其他包，每个包也都有自己的名称和版本

实现一个 Node LTS 查看工具

#!/usr/bin/env node

  1. #! 定义当前脚本的执行环境是用 Node 执行

目录

  1. /index.js
  2. /bin/index.js
  3. /lib
  4.     /update.js
  5.     /query.js
  7. npm i axios cli-color cli-table compare-versions -S

package.json

  1. "main": "index.js",
  2. "bin": { // 安装包,以后像二进制一样来执行
  3.   "lts": "bin/lts.js"
  4. }

/index.js

  1. exports.query = require('./lib/query')
  2. exports.update = require('./lib/update')

/lib/update.js

  1. const axios = require('axios')
  2. const color = require('cli-color')
  3. const terminalLink = require('terminal-link')
  4. const compareVersions = require('compare-versions')
  6. module.exports = async (v) => {
  7.     // 拿到所有的 Node 版本
  8.     const { data } = await axios
  9.     .get('https://nodejs.org/dist/index.json')
  11.     // 把目标版本的 LTS 都挑选出来
  12.     return data.filter(node => {
  13.         const cp = v
  14.         ? (compareVersions(node.version, 'v' + v + '.0.0') >= 0)
  15.         : true
  16.         return node.lts && cp
  17.     }).map(it => {
  18.         // 踢出去 file 这个字段，其他的全部返回
  19.         const { files, ...rest } = it
  20.         const doc = color.yellow(terminalLink('API', `https://nodejs.org/dist/${it.version}/docs/api/documentation.html`))
  21.         return { ...rest, doc }
  22.     })
  23. }

/lib/query.js

  1. const Table = require('cli-table')
  3. function query(dists) {
  4.     const keys = Object.keys(dists[0])
  5.     // 建立表头
  6.     const table = new Table({
  7.         head: keys
  8.     })
  10.     // 拼接出表格的每一行
  11.     return dists
  12.         .reduce((res, item) => {
  13.         table.push(
  14.             Object.values(item)
  15.         )
  16.         return res
  17.     }, table)
  18.         .toString()
  19. }
  21. module.exports = query

/bin/lts.js

  1. #!/usr/bin/env node
  3. const pkg = require('../package')
  4. // 从顶层 index.js 里面拿到 lib 下面模块暴露的方法
  5. const query = require('..').query
  6. const update = require('..').update
  8. // 输出结果到命令行窗口
  9. function printResult(v) {
  10.   update(v).then(dists => {
  11.     const results = query(dists, v)
  12.     console.log(results)
  13.     process.exit()
  14.   })
  15. }
  17. function printVersion() {
  18.   console.log('ltsn ' + pkg.version)
  19.   process.exit()
  20. }
  22. // 一些命令的帮助提示
  23. function printHelp(code) {
  24.   const lines = [
  25.     '',
  26.     '  Usage:',
  27.     '    lts [8]',
  28.     '',
  29.     '  Options:',
  30.     '    -v, --version             print the version of vc',
  31.     '    -h, --help                display this message',
  32.     '',
  33.     '  Examples:',
  34.     '    $ lts 8',
  35.     ''
  36.   ]
  38.   console.log(lines.join('\n'))
  39.   process.exit(code || 0)
  40. }
  42. // 包的入口函数，里面对参数做剪裁处理，拿到入参并给予
  43. // 不同入参的处理逻辑
  44. function main(argv) {
  45.   if (!argv) {
  46.     printHelp(1)
  47.   }
  49.   const getArg = function() {
  50.     let args = argv.shift()
  52.     args = args.split('=')
  53.     if (args.length > 1) {
  54.       argv.unshift(args.slice(1).join('='))
  55.     }
  56.     return args[0]
  57.   }
  59.   let arg
  61.   while (argv.length) {
  62.     arg = getArg()
  63.     switch(arg) {
  64.       case '-v':
  65.       case '-V':
  66.       case '--version':
  67.         printVersion()
  69.         break
  70.       case '-h':
  71.       case '-H':
  72.       case '--help':
  73.         printHelp()
  75.         break
  76.       default:
  77.         printResult(arg)
  79.         break
  80.     }
  81.   }
  82. }
  84. // 启动程序就开始执行主函数
  85. main(process.argv.slice(2))
  86. module.exports = main

npm无法安装

  1. npm config get proxy
  2. npm config get https-proxy
  4. 如果返回值不为null，继续执行
  5. npm config set proxy null
  6. npm config set https-proxy null

npm run mock & npm run dev 无法同时运行的解决

  1. 运行mock服务器和项目的命令，只能启动第一个
  2. 解决方法：
    1. 开2个命令窗口，先运行 npm run mock，后运行 npm run dev
      1. npm run mock && npm run dev // 无效
      2. npm run mock | npm run dev // 无效

npm config

配置成功
npm config ls -l

设置 npm源

  1. npm config set registry http://registry.npm.taobao.org/
  3. # 验证是否成功
  4. npm config get registry 
  6. # 还原为 npm源
  7. npm config set registry https://registry.npmjs.org/
  9. # 使用 npm而不是默认的 yarn
  10. --use-npm

运行多个命令

  1. npm install concurrently --save-dev
  3. 使用
  4. "script": {
  5.   "start": "concurrently \"react-scripts start\" \"npm run mock\""
  6. },
  7. "proxy": "http://localhost:3030" // 代理异步请求

检查 npm 包是否被注入恶意代码

  1. flatmap-stream@0.1.1 代表项目有影响
    1. npm ls event-stream flatmap
  1. Use the `--scripts-prepend-node-path` option to include the path for the node binary npm was executed with.
  3. npm config set scripts-prepend-node-path true // 无效