feat: first impl (#1)

* feat: first impl

* feat: add changelog

* fix: print later

* feat: default not check interval

* feat: update name

* feat: update version

* docs: update readme

Author: whxaxes

.gitignore

@@ -5,3 +5,4 @@ coverage/
 **/*.js
 **/*.js.map
 **/*.d.ts
+.npmcheckupdate

CHANGELOG.md

@@ -1,21 +1,19 @@
-# artus-cli/template
+# artus-cli/plugin-npmcheckupdate
 
-template repository for artus-cli
+A artus-cli plugin be used to display upgrade info
 
-<!-- Badge，自行替换掉下面的 `artus-cli/artus-cli` 占位符-->
-
-[![NPM version](https://img.shields.io/npm/v/@artus-cli/artus-cli.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/artus-cli)
-[![NPM quality](https://img.shields.io/npms-io/final-score/@artus-cli/artus-cli.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/artus-cli)
-[![NPM download](https://img.shields.io/npm/dm/@artus-cli/artus-cli.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/artus-cli)
-[![Continuous Integration](https://github.com/artus-cli/artus-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/artus-cli/artus-cli/actions/workflows/ci.yml)
-[![Test coverage](https://img.shields.io/codecov/c/github/artus-cli/artus-cli.svg?style=flat-square)](https://codecov.io/gh/artus-cli/artus-cli)
-[![Oss Insight Analytics](https://img.shields.io/badge/OssInsight-artus--cli%2Fartus--cli-blue.svg?style=flat-square)](https://ossinsight.io/analyze/artus-cli/artus-cli)
+[![NPM version](https://img.shields.io/npm/v/@artus-cli/plugin-npmcheckupdate.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-npmcheckupdate)
+[![NPM quality](https://img.shields.io/npms-io/final-score/@artus-cli/plugin-npmcheckupdate.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-npmcheckupdate)
+[![NPM download](https://img.shields.io/npm/dm/@artus-cli/plugin-npmcheckupdate.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-npmcheckupdate)
+[![Continuous Integration](https://github.com/artus-cli/plugin-npmcheckupdate/actions/workflows/ci.yml/badge.svg)](https://github.com/artus-cli/plugin-npmcheckupdate/actions/workflows/ci.yml)
+[![Test coverage](https://img.shields.io/codecov/c/github/artus-cli/plugin-npmcheckupdate.svg?style=flat-square)](https://codecov.io/gh/artus-cli/plugin-npmcheckupdate)
+[![Oss Insight Analytics](https://img.shields.io/badge/OssInsight-artus--cli%2Fartus--cli-blue.svg?style=flat-square)](https://ossinsight.io/analyze/artus-cli/plugin-npmcheckupdate)
 
 
 ## Install
 
 ```sh
-$ npm i -D @artus-cli/artus-cli 
+$ npm i -D @artus-cli/plugin-npmcheckupdate 
 ```
 
 ## Usage
@@ -26,22 +24,24 @@ $ npm i -D @artus-cli/artus-cli
 export default {
   template: {
     enable: true,
-    package: 'artus-cli/artus-cli',
+    package: 'artus-cli/plugin-npmcheckupdate',
   },
 };
 ```
 
-## Commands
-
-### dev
-
-
-### debug
-
+## Configuration
 
-## Contributing
-
-```sh
-$ npm test
-$ npm run cov
-```
+```ts
+export interface NpmCheckUpdateConfig {
+  /** unpkg url, default is https://unpkg.com/ */
+  unpkgUrl?: string;
+  /** the file be used to cache last update info */
+  cacheFile?: string;
+  /** check inerval with local cache, default is 0, means no cache */
+  checkInterval?: string | number;
+  /** upgrade policy, canbe major/minor/patch or dist-tags, default is latest */
+  upgradePolicy?: 'major' | 'minor' | 'patch' | DistTag;
+  /** whether enable intercept in all command? default is true */
+  enableInterceptor?: boolean | ((cmd: typeof Command) => boolean);
+}
+```

README.md

@@ -1,9 +1,9 @@
 {
-  "name": "template-plugin",
-  "version": "0.0.0",
-  "description": "plugin template",
+  "name": "@artus-cli/plugin-npmcheckupdate",
+  "version": "0.0.2",
+  "description": "A artus-cli plugin be used to display upgrade info",
   "homepage": "",
-  "author": "",
+  "author": "whxaxes <[email protected]>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "commonjs",
@@ -21,29 +21,38 @@
     "cov": "c8 -n src/ npm test",
     "ci": "npm run cov",
     "tsc": "rm -rf dist && tsc",
-    "prepack": "npm run tsc"
+    "prepack": "npm run tsc",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
   },
   "dependencies": {
-    "tslib": "^2.4.0"
+    "chalk": "^4.1.2",
+    "debug": "^4.3.4",
+    "ms": "^2.1.3",
+    "ora": "^5.4.1",
+    "semver": "^7.3.8",
+    "tslib": "^2.4.0",
+    "urllib": "^3.11.0"
   },
   "devDependencies": {
     "@artus-cli/artus-cli": "latest",
     "@artus/eslint-config-artus": "^0.0.1",
     "@artus/tsconfig": "^1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^18.7.14",
+    "@types/node": "^18.14.6",
     "c8": "^7.12.0",
     "coffee": "^5.5.0",
+    "conventional-changelog": "^3.1.25",
     "eslint": "^8.28.0",
     "mocha": "^10.0.0",
+    "rimraf": "^3.0.2",
     "ts-mocha": "^10.0.0",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.1",
     "typescript": "^4.8.2"
   },
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/artus-cli/plugin-npmcheckupdate"
   },
   "files": [
     "dist"

package.json

@@ -0,0 +1,10 @@
+import { NpmCheckUpdateConfig } from '../types';
+
+export default {
+  npmcheckupdate: {
+    unpkgUrl: 'https://unpkg.com',
+    checkInterval: 0,
+    upgradePolicy: 'latest',
+    enableInterceptor: true,
+  } as NpmCheckUpdateConfig,
+};

src/cmd/example.ts

@@ -0,0 +1,93 @@
+import chalk from 'chalk';
+import urllib from 'urllib';
+import assert from 'assert';
+import semver from 'semver';
+import { NpmCheckUpdateConfig, UpgradeInfo } from './types';
+import debug from 'debug';
+const helperDebug = debug('npmcheckupdate#helper');
+
+export async function checkUpdate(option: Pick<NpmCheckUpdateConfig, 'unpkgUrl' | 'upgradePolicy'> & {
+  pkgName: string;
+  pkgVersion: string;
+  pkgBaseDir: string;
+}) {
+  const { unpkgUrl, upgradePolicy, pkgVersion, pkgName, pkgBaseDir } = option;
+
+  let distTag: string | undefined;
+  let remoteVersionPatterns: string;
+  const [ major, minor ] = pkgVersion.split('.');
+  if (upgradePolicy === 'major') {
+    remoteVersionPatterns = '*';
+  } else if (upgradePolicy === 'minor') {
+    remoteVersionPatterns = `${major}.*`;
+  } else if (upgradePolicy === 'patch') {
+    remoteVersionPatterns = `${major}.${minor}.*`;
+  } else {
+    distTag = upgradePolicy;
+    remoteVersionPatterns = upgradePolicy;
+  }
+
+  // request unpkg to get version info
+  let remoteVersion: string;
+  const unpkgHost = unpkgUrl.endsWith('/') ? unpkgUrl : `${unpkgUrl}/`;
+  const remoteUrl = `${unpkgHost}${pkgName}@${remoteVersionPatterns}/package.json`;
+  try {
+    const { data } = await urllib.request(remoteUrl, {
+      dataType: 'json',
+    });
+
+    assert(data.version, 'Invalid package.json, not found version info');
+    remoteVersion = data.version;
+  } catch(e) {
+    helperDebug(`Request ${remoteUrl} failed with error: ` + e.message);
+    return undefined;
+  }
+
+  // check whether need to update
+  const result = semver.compare(remoteVersion, pkgVersion);
+  if (result > 0) {
+    return {
+      distTag,
+      upgradePolicy,
+      pkgName,
+      pkgVersion,
+      pkgBaseDir,
+      targetVersion: remoteVersion,
+    };
+  }
+
+  return undefined;
+}
+
+export function displayUpgradeInfo(upgradeInfo: UpgradeInfo) {
+  // update contents
+  const contents = [
+    `Update available ${chalk.gray(upgradeInfo.pkgVersion)} → ${chalk.greenBright(upgradeInfo.targetVersion)}`,
+    `Run ${chalk.blueBright(`npm i -g ${upgradeInfo.pkgName}@${upgradeInfo.distTag || upgradeInfo.targetVersion}`)} to update`,
+  ];
+
+  const removeColor = c => c.replace(/\x1B\[\d+m/g, '');
+  const maxLen = contents.map(removeColor)
+    .sort((a, b) => a.length - b.length)
+    .pop().length;
+
+  // show content
+  const distanceLen = 2;
+  const displayContents: string[] = [];
+  const contentLen = maxLen + distanceLen * 2;
+  displayContents.push('┌' + '─'.repeat(contentLen) + '┐');
+  displayContents.push('│' + ' '.repeat(contentLen) + '│');
+  displayContents.push('│' + ' '.repeat(contentLen) + '│');
+
+  contents.forEach(c => {
+    const realContentLen = removeColor(c).length;
+    const leftSpace = ' '.repeat(distanceLen + (maxLen - realContentLen) / 2);
+    const rightSpace = ' '.repeat(contentLen - leftSpace.length - realContentLen);
+    displayContents.push('│' + leftSpace + c + rightSpace + '│');
+  });
+
+  displayContents.push('│' + ' '.repeat(contentLen) + '│');
+  displayContents.push('│' + ' '.repeat(contentLen) + '│');
+  displayContents.push('└' + '─'.repeat(contentLen) + '┘');
+  console.info(`\n\n${displayContents.map(c => `  ${c}`).join('\n')}\n\n`);
+}

src/config/config.default.ts

@@ -1 +1 @@
-export * from './cmd/example';
+export * from './types';

src/helper.ts

@@ -1,12 +1,44 @@
-import { Program, Inject, ApplicationLifecycle, LifecycleHook, LifecycleHookUnit } from '@artus-cli/artus-cli';
+import { Program, Inject, ApplicationLifecycle, LifecycleHook, LifecycleHookUnit, CommandContext, ArtusInjectEnum } from '@artus-cli/artus-cli';
+import DefaultConfig from './config/config.default';
+import { UpgradeInfo } from './types';
+import { Updater } from './updater';
 
 @LifecycleHookUnit()
-export default class TemplateLifecycle implements ApplicationLifecycle {
+export default class NpmCheckUpdateLifecycle implements ApplicationLifecycle {
   @Inject()
   private readonly program: Program;
 
+  @Inject(ArtusInjectEnum.Config)
+  config: typeof DefaultConfig;
+
+  @Inject()
+  updater: Updater;
+
   @LifecycleHook()
   async configDidLoad() {
-    console.info('bin', this.program.binName);
+    const { npmcheckupdate } = this.config;
+    if (!npmcheckupdate.enableInterceptor) {
+      return;
+    }
+
+    this.program.use(async (ctx: CommandContext, next) => {
+      let enableInterceptor = false;
+      if (typeof npmcheckupdate.enableInterceptor === 'function') {
+        enableInterceptor = ctx.matched ? npmcheckupdate.enableInterceptor(ctx.matched.clz) : false;
+      } else {
+        enableInterceptor = npmcheckupdate.enableInterceptor;
+      }
+
+      let upgradeInfo: UpgradeInfo | undefined;
+      if (enableInterceptor) {
+        upgradeInfo = await this.updater.checkUpdate();
+      }
+
+      await next();
+
+      if (upgradeInfo) {
+        this.updater.displayUpgradeInfo(upgradeInfo);
+      }
+    });
   }
 }

src/index.ts

@@ -1,3 +1,3 @@
 {
-  "name": "template"
+  "name": "npmcheckupdate"
 }

src/lifecycle.ts

@@ -0,0 +1,29 @@
+import { Command } from "@artus-cli/artus-cli";
+
+export type DistTag = 'latest' | 'beta' | 'alpha' | string & {};
+
+export interface NpmCheckUpdateConfig {
+  /** unpkg url, default is https://unpkg.com/ */
+  unpkgUrl?: string;
+  /** the file be used to cache last update info */
+  cacheFile?: string;
+  /** check inerval with local cache, default is 0, means no cache */
+  checkInterval?: string | number;
+  /** upgrade policy, canbe major/minor/patch or dist-tags, default is latest */
+  upgradePolicy?: 'major' | 'minor' | 'patch' | DistTag;
+  /** whether enable intercept in all command? default is true */
+  enableInterceptor?: boolean | ((cmd: typeof Command) => boolean);
+}
+
+export interface CacheInfo {
+  lastUpdateTime?: number;
+}
+
+export interface UpgradeInfo {
+  pkgName: string;
+  pkgVersion: string;
+  pkgBaseDir: string;
+  distTag: DistTag;
+  upgradePolicy: NpmCheckUpdateConfig['upgradePolicy'];
+  targetVersion: string;
+}