简介

update-notifier用于检查包的当前版本是否是最新版本，如果不是，则提示更新
image.png

用法

  1. const updateNotifier = require('update-notifier');
  2. const pkg = require('./package.json');
  4. updateNotifier({pkg}).notify();

源码分析

package.json

  1. {
  2.     ...
  3.       "dependencies": {
  4.         "boxen": "^5.0.0",
  5.         "chalk": "^4.1.0",
  6.         "configstore": "^5.0.1",
  7.         "has-yarn": "^2.1.0",
  8.         "import-lazy": "^2.1.0",
  9.         "is-ci": "^2.0.0",
  10.         "is-installed-globally": "^0.4.0",
  11.         "is-npm": "^5.0.0",
  12.         "is-yarn-global": "^0.3.0",
  13.         "latest-version": "^5.1.0",
  14.         "pupa": "^2.1.1",
  15.         "semver": "^7.3.4",
  16.         "semver-diff": "^3.1.1",
  17.         "xdg-basedir": "^4.0.0"
  18.     },
  19.     "devDependencies": {
  20.         "ava": "^2.4.0",
  21.         "clear-module": "^4.1.1",
  22.         "fixture-stdout": "^0.2.1",
  23.         "mock-require": "^3.0.3",
  24.         "strip-ansi": "^6.0.0",
  25.         "xo": "^0.37.1"
  26.     }
  27.   ...
  28. }

从以上代码中，可以看出，dependencies中有一些依赖包：
boxen
此包主要用于在终端创建盒，例如：

  1. import boxen from 'boxen';
  3. console.log(boxen('unicorn', {padding: 1}));
  4. /*
  5. ┌─────────────┐
  6. │             │
  7. │   unicorn   │
  8. │             │
  9. └─────────────┘
  10. */
  12. console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
  13. /*
  15.    ╔═════════════╗
  16.    ║             ║
  17.    ║   unicorn   ║
  18.    ║             ║
  19.    ╚═════════════╝
  21. */
  23. console.log(boxen('unicorns love rainbows', {title: 'magical', titleAlignment: 'center'}));
  24. /*
  25. ┌────── magical ───────┐
  26. │unicorns love rainbows│
  27. └──────────────────────┘
  28. */

chalk
此包可以用来控制终端中输入的字符串的颜色、背景等

  1. import chalk from 'chalk';
  3. const log = console.log;
  5. // Combine styled and normal strings
  6. log(chalk.blue('Hello') + ' World' + chalk.red('!'));
  8. // Compose multiple styles using the chainable API
  9. log(chalk.blue.bgRed.bold('Hello world!'));
  11. // Pass in multiple arguments
  12. log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz'));
  14. // Nest styles
  15. log(chalk.red('Hello', chalk.underline.bgBlue('world') + '!'));
  17. // Nest styles of the same type even (color, underline, background)
  18. log(chalk.green(
  19.     'I am a green line ' +
  20.     chalk.blue.underline.bold('with a blue substring') +
  21.     ' that becomes green again!'
  22. ));
  24. // ES2015 template literal
  25. log(`
  26. CPU: ${chalk.red('90%')}
  27. RAM: ${chalk.green('40%')}
  28. DISK: ${chalk.yellow('70%')}
  29. `);
  31. // Use RGB colors in terminal emulators that support it.
  32. log(chalk.rgb(123, 45, 67).underline('Underlined reddish color'));
  33. log(chalk.hex('#DEADED').bold('Bold gray!'));

image.png
configstore
此包通过既定文件命名规则，在当前系统中创建文件，用于存储用户的配置数据。再通过文件读写，实现配置的修改和保存。

  1. import Configstore from 'configstore';
  3. const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
  5. // Create a Configstore instance.
  6. const config = new Configstore(packageJson.name, {foo: 'bar'});
  8. console.log(config.get('foo'));
  9. //=> 'bar'
  11. config.set('awesome', true);
  12. console.log(config.get('awesome'));
  13. //=> true
  15. // Use dot-notation to access nested properties.
  16. config.set('bar.baz', true);
  17. console.log(config.get('bar'));
  18. //=> {baz: true}
  20. config.delete('awesome');
  21. console.log(config.get('awesome'));
  22. //=> undefined

has-yarn
此包用于来检测项目中是否有yarn,主要是通过检测工作目录中是否有yarn.lock的文件

  1. .
  2. ├── foo
  3. │   └── package.json
  4. └── bar
  5.     ├── package.json
  6.     └── yarn.lock
  1. import hasYarn from 'has-yarn';
  3. hasYarn('foo');
  4. //=> false
  6. hasYarn('bar');
  7. //=> true

import-lazy
此包主要是懒加载模块

  1. // Pass in `require` or a custom import function
  2. const importLazy = require('import-lazy')(require);
  3. const _ = importLazy('lodash');
  5. // Instead of referring to its exported properties directly…
  6. _.isNumber(2);
  8. // …it's cached on consecutive calls
  9. _.isNumber('unicorn');
  11. // Works out of the box for functions and regular properties
  12. const stuff = importLazy('./math-lib');
  13. console.log(stuff.sum(1, 2)); // => 3
  14. console.log(stuff.PHI); // => 1.618033

is-ci:判断当前环境是否是持续集成的服务
is-installed-globally:检测是否安装了全局的包
is-npm:检测当前代码是否是npm或yarn运行的
is-yarn-global:检测是否全局安装了yarn
latest-version:获取npm包的最新版
pupa
此包是一个简便的宏模版

  1. import pupa from 'pupa';
  3. pupa('The mobile number of {name} is {phone.mobile}', {
  4.     name: 'Sindre',
  5.     phone: {
  6.         mobile: '609 24 363'
  7.     }
  8. });
  9. //=> 'The mobile number of Sindre is 609 24 363'
  11. pupa('I like {0} and {1}', ['🦄', '🐮']);
  12. //=> 'I like 🦄 and 🐮'
  14. // Double braces encodes the HTML entities to avoid code injection.
  15. pupa('I like {{0}} and {{1}}', ['<br>🦄</br>', '<i>🐮</i>']);
  16. //=> 'I like &lt;br&gt;🦄&lt;/br&gt; and &lt;i&gt;🐮&lt;/i&gt;'

semver:Node的语义化版本
semver-diff:获取两个semver版本的diff类型
xdg-basedir
此包主要应用于Linux平台,基于xdg获取文件路径。

  1. import {xdgData, xdgConfig, xdgDataDirectories} from 'xdg-basedir';
  3. console.log(xdgData);
  4. //=> '/home/sindresorhus/.local/share'
  6. console.log(xdgConfig);
  7. //=> '/home/sindresorhus/.config'
  9. console.log(xdgDataDirectories);
  10. //=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/']

devDependencies
ava和xo主要用来进行进行
clear-module:清除模块缓存
fixture-stdout:
mock-require:简单、直观地模拟Node模块
strip-ansi:从字符串中去掉ANSI转译码

  1. import stripAnsi from 'strip-ansi';
  3. stripAnsi('\u001B[4mUnicorn\u001B[0m');
  4. //=> 'Unicorn'
  6. stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
  7. //=> 'Click'

index.js

  1. 'use strict';
  2. const {spawn} = require('child_process');
  3. const path = require('path');
  4. const {format} = require('util');
  5. const importLazy = require('import-lazy')(require);
  7. const configstore = importLazy('configstore');
  8. const chalk = importLazy('chalk');
  9. const semver = importLazy('semver');
  10. const semverDiff = importLazy('semver-diff');
  11. const latestVersion = importLazy('latest-version');
  12. const isNpm = importLazy('is-npm');
  13. const isInstalledGlobally = importLazy('is-installed-globally');
  14. const isYarnGlobal = importLazy('is-yarn-global');
  15. const hasYarn = importLazy('has-yarn');
  16. const boxen = importLazy('boxen');
  17. const xdgBasedir = importLazy('xdg-basedir');
  18. const isCi = importLazy('is-ci');
  19. const pupa = importLazy('pupa');
  21. const ONE_DAY = 1000 * 60 * 60 * 24;

定义的变量，具体用法可以参照上面package.json的包的解释

代码部分就直接贴一个运行的流程图了
image.png