# wodax-update-notifier

> Update notifications for WodaX Project

Latest version **0.17.8** (published 2020-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install wodax-update-notifier
pnpm add wodax-update-notifier
yarn add wodax-update-notifier
bun add wodax-update-notifier
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.17.8 |
| Published | 2020-01-18 |
| First published | 2019-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 15 |
| Unpacked size | 203 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | sunzhifeng |
| Keywords | npm, update, updater, notify, notifier, check, checker, cli, module, package, version |

## Links

- npm: https://www.npmjs.com/package/wodax-update-notifier
- npm.io page: https://npm.io/package/wodax-update-notifier

## Dependencies (15)

- [boxen](https://npm.io/package/boxen.md) ^3.0.0
- [chalk](https://npm.io/package/chalk.md) ^2.0.1
- [execa](https://npm.io/package/execa.md) ^2.0.4
- [is-ci](https://npm.io/package/is-ci.md) ^2.0.0
- [is-npm](https://npm.io/package/is-npm.md) ^3.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [has-yarn](https://npm.io/package/has-yarn.md) ^2.1.0
- [configstore](https://npm.io/package/configstore.md) ^4.0.0
- [import-lazy](https://npm.io/package/import-lazy.md) ^2.1.0
- [semver-diff](https://npm.io/package/semver-diff.md) ^2.0.0
- [xdg-basedir](https://npm.io/package/xdg-basedir.md) ^3.0.0
- [format-package](https://npm.io/package/format-package.md) ^5.2.0
- [is-yarn-global](https://npm.io/package/is-yarn-global.md) ^0.3.0
- [latest-version](https://npm.io/package/latest-version.md) ^5.0.0
- [is-installed-globally](https://npm.io/package/is-installed-globally.md) ^0.1.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.17.8 (latest) — 2020-01-18
- 0.17.7 — 2020-01-17
- 0.17.6 — 2020-01-15
- 0.17.5 — 2020-01-15
- 0.17.4 — 2020-01-15
- 0.17.3 — 2020-01-15
- 0.17.2 — 2020-01-15
- 0.17.1 — 2020-01-14
- 0.17.0 — 2020-01-13
- 0.16.71 — 2020-01-13
- 0.16.70 — 2020-01-13
- 0.16.69 — 2020-01-13
- 0.16.68 — 2020-01-11
- 0.16.67 — 2020-01-11
- 0.16.66 — 2020-01-11
- … 122 more at https://npm.io/package/wodax-update-notifier/versions

## README

# wodax-update-notifier

[![NPM version](https://img.shields.io/npm/v/wodax-update-notifier.svg?style=flat)](https://npmjs.org/package/wodax-update-notifier)
[![NPM downloads](http://img.shields.io/npm/dm/wodax-update-notifier.svg?style=flat)](https://npmjs.org/package/wodax-update-notifier)


## 简介

通过 集成 `wodax-update-notifier` 来实现以下功能：

   - 检测 工具`wodax-update-notifier` 是否为最新？
   - 检测基于脚手架`create-wodax-project` 生成的项目模板是否有更新？
   - 检测基于脚手架`create-wodax-project` 生成的项目依赖环境是否有更新？
   - 检测项目其他依赖是否有更新？
   - 检测是否遵循 WodaX 规范?
   - 应用项目补丁，强制更新
   - 应用核心依赖库更新检测，强制更新
   - 应用执行检查代码规范，完成部分自修复
   - 应用格式化代码

## 安装

```bash
$ npm install wodax-update-notifier -D # yarn add wodax-update-notifier -D
```

## 用法示例

`check_update.js` 源码

```js
const util = require('util');
const fs = require('fs');
const path = require('path');
const updateNotifier = require('wodax-update-notifier');

const leftToken = '\033[1;31m';
const rightToken = '\033[0;0m';

/**
 * 异步运行 spawn 子进程
 * @param command
 * @param args
 * @param options
 * @param onExitCallback
 */
function runSpawnProcess(
  command = '',
  args = [],
  options = {},
  onExitCallback = () => {
  }
) {
  try {
    const envData = {
      ...process.env,
      NODE_OPTIONS: '--max_old_space_size=4096',
    };

    const hl = require('child_process').spawn(command, args, {
      env: envData,
      ...options,
    });
    hl.stdout.on('data', (data) => {
      console.log(data.toString());
    });
    hl.stderr.on('data', (data) => {
      console.log(data.toString());
    });
    hl.on('exit', (code, signal) => {
      onExitCallback && onExitCallback(code, signal);
    });
  } catch (e) {
    console.error(e);
    onExitCallback(-1, '');
  }
}

/**
 * 运行同步命令
 * @param command  命令
 * @param enableOutputContent 是否可以输出内容
 * @param enableThrow  是否可以抛出异常
 */
function runOneCommand({
                         command = `pwd`,
                         enableOutputContent = false,
                         enableThrow = false,
                       }) {
  try {
    const output = require('child_process').execSync(`${command}`, {
      env: {
        ...process.env,
        NODE_OPTIONS: '--max_old_space_size=4096',
      },
    });
    if (enableOutputContent) {
      console.log(output.toString());
    }
  } catch (e) {
    if (enableThrow) throw e;
  }
}

/** check Current Project Packages
 *
 * @param pkgInfo
 */
function checkCurrentProjectPackage(pkgInfo) {
  try {
    const {name: packageName, version: packageVersion, wodax} = pkgInfo;
    const {templateClassId, templateKey, templateVersion} = wodax;
    const pkg = {
      name: packageName,
      version: packageVersion,
    };

    // check templateVersion
    updateNotifier({
      pkg,
      templateClassId,
      templateKey,
      templateVersion,
      updateCheckInterval: 0,
      callback: function (err, info) {
        if (err) {
          if (!pkg.name === packageName) {
            console.error(err);
          }
        } else {
          console.log(info);
        }
      },
    });

    // check Dependencies
    [
      'devDependencies',
      'optionalDependencies',
      'dependencies',
      'peerDependency',
      'bundleDependencies',
    ].map((ele) => {
      const dependencies = pkgInfo[ele] || {};
      Object.keys(dependencies).map((one_pkg_name) => {
        const pkg = {
          name: one_pkg_name,
          version: dependencies[one_pkg_name],
          dependenciesType: ele,
        };

        const notifier = updateNotifier({
          pkg,
          templateClassId,
          templateKey,
          updateCheckInterval: 0,
          callback: function (err, info) {
            if (err) {
              if (!pkg.name === packageName) {
                console.error(err);
              }
            } else {
              const packageName = this.packageName;
              // 1. 先检测包是否存在？
              const modulePath = `${path.normalize(
                path.join(__dirname, '../node_modules', packageName)
              )}`;
              if (!fs.existsSync(`${modulePath}`)) {
                try {
                  const installCommand = this.getInstallCommand({
                    latestVersion: pkg.version,
                    isYarnGlobal: false,
                    isGlobal: false,
                  });

                  console.log(`${leftToken}${'-'.repeat(36)}${rightToken}`);
                  console.log(`检测路径为：'${modulePath}'`);
                  console.log(
                    `根据 WodaX 项目架构规范要求，'${packageName}' 依赖包没有找到，正在启动安装程序 ...`
                  );
                  console.log(
                    `如果 '${packageName}' 更新失败，请在终端中手动运行该命令 '${installCommand}'`
                  );
                  console.log(`${leftToken}${'-'.repeat(36)}${rightToken}`);
                  runOneCommand({
                    command: `${installCommand}`,
                    enableOutputContent: false,
                    enableThrow: true,
                  });
                  console.log(`核心依赖 '${packageName}' 已安装完成 ... `);
                  console.log(`${leftToken}${'-'.repeat(36)}${rightToken}`);
                } catch (e) {
                  console.error(e);
                }
              } else {
                // 2. 再检测是否需要更新
                const {type} = info;
                if (type && type !== 'latest') {
                  this.config.set('update', info);
                  this.printInfo(info);
                }
              }
            }
          },
        });
      });
    });
  } catch (e) {
  }
}

// 检测 npm config list
console.log(
  `${leftToken}正在检测 npm config 配置 (nodejs 全局globle 缓存cache 需要特别注意)...  ${rightToken}`
);
runOneCommand({command: `npm config list`, enableOutputContent: true});
console.log(`${leftToken}${'-'.repeat(36)}${rightToken}`);

updateNotifier.selfCheckUpdate((err, info) => {
  if (!err) {
    const {packageName, needUpdate, installCommand} = info;
    if (!needUpdate) {
      // check Dependencies
      const pkgInfo = require('../package.json');
      checkCurrentProjectPackage(pkgInfo);
    } else {
      console.log(
        `根据 WodaX 项目架构规范要求，'${packageName}' 正在强制更新中 ...`
      );
      console.log(
        `如果 '${packageName}'更新失败，请在终端中手动运行该命令 '${installCommand}' ...`
      );

      try {
        runOneCommand({command: `${installCommand}`, enableThrow: true});
        console.log(
          `${leftToken} 核心依赖 '${packageName}' 已更新完成。 正在重新检查 ... ${rightToken}`
        );
        runSpawnProcess(process.execPath, [__filename], {});
      } catch (e) {
        console.error(e);
        process.exit(999);
      }
    }
  }
});

```

---
_Source: https://npm.io/package/wodax-update-notifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._