feat: package update checker w/ banner

README.md

@@ -52,6 +52,17 @@ const main = defineCommand({
     name: "hello",
     version: "1.0.0",
     description: "My Awesome CLI App",
+    updateChecker: {
+      registryName: "helloWorld",
+      msg: `Update available! {current} → {latest}.\n\nRun "npm install -g {cmd}" to update`,
+      box: {
+        padding: 1,
+        margin: 1,
+        align: "center",
+        borderColor: "yellow",
+        borderStyle: "round",
+      }
+    }
   },
   args: {
     name: {

package.json

@@ -29,19 +29,27 @@
     "release": "pnpm test && changelogen --release --push && npm publish",
     "test": "pnpm lint && vitest run --coverage"
   },
+  "dependencies": {
+    "boxen": "^7.0.2"
+  },
   "devDependencies": {
     "@types/node": "^18.15.11",
+    "@types/semver": "^7.3.13",
     "@vitest/coverage-c8": "^0.29.8",
     "changelogen": "^0.5.2",
     "colorette": "^2.0.19",
+    "defu": "^6.1.2",
     "eslint": "^8.37.0",
     "eslint-config-unjs": "^0.1.0",
     "jiti": "^1.18.2",
+    "ofetch": "^1.0.1",
+    "pkg-types": "^1.0.2",
     "prettier": "^2.8.7",
     "scule": "^1.0.0",
+    "semver": "^7.3.8",
     "typescript": "^5.0.3",
     "unbuild": "^1.2.0",
     "vitest": "^0.29.8"
   },
   "packageManager": "[email protected]"
-}
+}

src/_registry.ts

@@ -0,0 +1,42 @@
+import { ofetch } from "ofetch";
+import { readPackageJSON } from "pkg-types";
+import semver from "semver";
+
+interface ReturnPkgVersion {
+  latest?: string;
+  current?: string;
+}
+
+const REGISTRY_URL = "https://registry.npmjs.org";
+
+// Check the latest version of a package
+export async function checkPkgVersion(name: string): Promise<ReturnPkgVersion> {
+  const latest = await ofetch(`${REGISTRY_URL}/${name}`, { retry: 3 })
+    .then((reg) => {
+      const {
+        "dist-tags": { latest },
+      } = reg;
+      return latest;
+    })
+    .catch(() => undefined);
+
+  const current = await readPackageJSON()
+    .then((pkg) => pkg.version)
+    .catch(() => undefined);
+
+  return {
+    latest,
+    current,
+  };
+}
+
+// Check if the current version is outdated
+export function isPkgOutdated(pkgVer: ReturnPkgVersion): boolean {
+  const { latest, current } = pkgVer;
+
+  if (!latest || !current) {
+    return false;
+  }
+
+  return semver.lt(current, latest);
+}

src/main.ts

@@ -1,8 +1,12 @@
-import { bgRed } from "colorette";
+import boxen from "boxen";
+import defu from "defu";
+import { bgRed, red, bold, green, magenta } from "colorette";
+import { readPackageJSON } from "pkg-types";
 import type { CommandDef } from "./types";
 import { resolveSubCommand, runCommand } from "./command";
-import { CLIError } from "./_utils";
+import { CLIError, resolveValue } from "./_utils";
 import { showUsage } from "./usage";
+import { checkPkgVersion, isPkgOutdated } from "./_registry";
 
 export interface RunMainOptions {
   rawArgs?: string[];
@@ -11,6 +15,46 @@ export interface RunMainOptions {
 export async function runMain(cmd: CommandDef, opts: RunMainOptions = {}) {
   const rawArgs = opts.rawArgs || process.argv.slice(2);
   try {
+    const cmdMeta = defu(await resolveValue(cmd.meta || {}), {
+      updateChecker: {
+        registryName: undefined,
+        msg: `Update available! ${red(bold("{current}"))} → ${bold(
+          green("{latest}")
+        )}.\n\nRun "${bold(magenta("npm install -g {cmd}"))}" to update.`,
+        box: {
+          padding: 1,
+          textAlignment: "center",
+          borderStyle: "round",
+          borderColor: "yellowBright",
+        },
+      },
+    });
+
+    // Check for updates
+    const pkgName = await readPackageJSON()
+      .then((r) => r.name)
+      .catch(() => undefined);
+    const updateOpts = cmdMeta.updateChecker;
+    const registryName =
+      typeof updateOpts === "object"
+        ? updateOpts?.registryName || pkgName
+        : false;
+
+    if (registryName && updateOpts) {
+      const version = await checkPkgVersion(registryName);
+      const isOutdated = isPkgOutdated(version);
+
+      if (isOutdated && version.current && version.latest) {
+        const msg = updateOpts.msg
+          .replace(/{cmd}/g, registryName)
+          .replace(/{current}/g, version.current)
+          .replace(/{latest}/g, version.latest);
+
+        console.log(boxen(msg, updateOpts.box as any) + "\n");
+      }
+    }
+    // End of update check
+
     if (rawArgs.includes("--help") || rawArgs.includes("-h")) {
       await showUsage(...(await resolveSubCommand(cmd, rawArgs)));
       process.exit(0);