@juit/check-updates 2.0.6 → 3.0.0

package/dist/versions.cjs

@@ -0,0 +1,65 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// versions.ts
+var versions_exports = {};
+__export(versions_exports, {
+  VersionsCache: () => VersionsCache
+});
+module.exports = __toCommonJS(versions_exports);
+var import_npm_registry_fetch = __toESM(require("npm-registry-fetch"), 1);
+var import_semver = __toESM(require("semver"), 1);
+var import_debug = require("./debug.cjs");
+var VersionsCache = class {
+  _cache;
+  _debug;
+  constructor(debug = false) {
+    this._debug = (0, import_debug.makeDebug)(debug);
+    this._cache = {};
+  }
+  /** Return the available versions for a package, sorted */
+  getVersions(name, npmrc) {
+    if (this._cache[name]) {
+      this._debug(`Returning cached versions for ${import_debug.Y}${name}${import_debug.X}`);
+      return this._cache[name];
+    }
+    this._debug(`Retrieving versions for package ${import_debug.Y}${name}${import_debug.X}`);
+    const range = new import_semver.default.Range(">=0.0.0", { includePrerelease: false });
+    const promise = import_npm_registry_fetch.default.json(name, Object.assign({}, npmrc, { spec: name })).then((data) => {
+      return Object.entries(data.versions).filter(([, info]) => !info.deprecated).map(([version]) => version).filter((version) => range.test(version)).sort(import_semver.default.rcompare);
+    });
+    this._cache[name] = promise;
+    return promise;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  VersionsCache
+});
+//# sourceMappingURL=versions.cjs.map

package/dist/versions.cjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/versions.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gCAAkB;AAClB,oBAAmB;AAEnB,mBAAgC;AAGzB,IAAM,gBAAN,MAAoB;AAAA,EACjB;AAAA,EACA;AAAA,EAER,YAAY,QAAiB,OAAO;AAClC,SAAK,aAAS,wBAAU,KAAK;AAC7B,SAAK,SAAS,CAAC;AAAA,EACjB;AAAA;AAAA,EAGA,YACI,MACA,OACiB;AACnB,QAAI,KAAK,OAAO,IAAI,GAAG;AACrB,WAAK,OAAO,iCAAiC,cAAC,GAAG,IAAI,GAAG,cAAC,EAAE;AAC3D,aAAO,KAAK,OAAO,IAAI;AAAA,IACzB;AAEA,SAAK,OAAO,mCAAmC,cAAC,GAAG,IAAI,GAAG,cAAC,EAAE;AAE7D,UAAM,QAAQ,IAAI,cAAAA,QAAO,MAAM,WAAW,EAAE,mBAAmB,MAAM,CAAC;AAItE,UAAM,UAAU,0BAAAC,QAAM,KAAK,MAAM,OAAO,OAAO,CAAC,GAAG,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC,EACpE,KAAK,CAAC,SAAc;AACnB,aAAO,OAAO,QAAQ,KAAK,QAA+C,EACrE,OAAO,CAAC,CAAE,EAAE,IAAK,MAAM,CAAE,KAAK,UAAU,EACxC,IAAI,CAAC,CAAE,OAAQ,MAAM,OAAO,EAC5B,OAAO,CAAC,YAAY,MAAM,KAAK,OAAO,CAAC,EACvC,KAAK,cAAAD,QAAO,QAAQ;AAAA,IAC3B,CAAC;AACL,SAAK,OAAO,IAAI,IAAI;AACpB,WAAO;AAAA,EACT;AACF;",
+  "names": ["semver", "fetch"]
+}

package/dist/versions.d.ts

@@ -0,0 +1,8 @@
+/** Cache of versions */
+export declare class VersionsCache {
+    private _cache;
+    private _debug;
+    constructor(debug?: boolean);
+    /** Return the available versions for a package, sorted */
+    getVersions(name: string, npmrc: Record<string, any>): Promise<string[]>;
+}

package/dist/versions.mjs

@@ -0,0 +1,30 @@
+// versions.ts
+import fetch from "npm-registry-fetch";
+import semver from "semver";
+import { X, Y, makeDebug } from "./debug.mjs";
+var VersionsCache = class {
+  _cache;
+  _debug;
+  constructor(debug = false) {
+    this._debug = makeDebug(debug);
+    this._cache = {};
+  }
+  /** Return the available versions for a package, sorted */
+  getVersions(name, npmrc) {
+    if (this._cache[name]) {
+      this._debug(`Returning cached versions for ${Y}${name}${X}`);
+      return this._cache[name];
+    }
+    this._debug(`Retrieving versions for package ${Y}${name}${X}`);
+    const range = new semver.Range(">=0.0.0", { includePrerelease: false });
+    const promise = fetch.json(name, Object.assign({}, npmrc, { spec: name })).then((data) => {
+      return Object.entries(data.versions).filter(([, info]) => !info.deprecated).map(([version]) => version).filter((version) => range.test(version)).sort(semver.rcompare);
+    });
+    this._cache[name] = promise;
+    return promise;
+  }
+};
+export {
+  VersionsCache
+};
+//# sourceMappingURL=versions.mjs.map

package/dist/versions.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/versions.ts"],
+  "mappings": ";AAAA,OAAO,WAAW;AAClB,OAAO,YAAY;AAEnB,SAAS,GAAG,GAAG,iBAAiB;AAGzB,IAAM,gBAAN,MAAoB;AAAA,EACjB;AAAA,EACA;AAAA,EAER,YAAY,QAAiB,OAAO;AAClC,SAAK,SAAS,UAAU,KAAK;AAC7B,SAAK,SAAS,CAAC;AAAA,EACjB;AAAA;AAAA,EAGA,YACI,MACA,OACiB;AACnB,QAAI,KAAK,OAAO,IAAI,GAAG;AACrB,WAAK,OAAO,iCAAiC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE;AAC3D,aAAO,KAAK,OAAO,IAAI;AAAA,IACzB;AAEA,SAAK,OAAO,mCAAmC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE;AAE7D,UAAM,QAAQ,IAAI,OAAO,MAAM,WAAW,EAAE,mBAAmB,MAAM,CAAC;AAItE,UAAM,UAAU,MAAM,KAAK,MAAM,OAAO,OAAO,CAAC,GAAG,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC,EACpE,KAAK,CAAC,SAAc;AACnB,aAAO,OAAO,QAAQ,KAAK,QAA+C,EACrE,OAAO,CAAC,CAAE,EAAE,IAAK,MAAM,CAAE,KAAK,UAAU,EACxC,IAAI,CAAC,CAAE,OAAQ,MAAM,OAAO,EAC5B,OAAO,CAAC,YAAY,MAAM,KAAK,OAAO,CAAC,EACvC,KAAK,OAAO,QAAQ;AAAA,IAC3B,CAAC;AACL,SAAK,OAAO,IAAI,IAAI;AACpB,WAAO;AAAA,EACT;AACF;",
+  "names": []
+}

package/package.json

@@ -1,12 +1,27 @@
 {
   "name": "@juit/check-updates",
-  "version": "2.0.6",
+  "version": "3.0.0",
   "type": "module",
   "description": "Small and fast utility to update package dependencies",
   "author": "Team Juit <developers@juit.com>",
   "license": "Apache-2.0",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
   "bin": {
-    "check-updates": "check-updates.js"
+    "check-updates": "./dist/main.mjs"
   },
   "scripts": {
     "build": "plug",
@@ -17,19 +32,17 @@
     "transpile": "plug transpile"
   },
   "dependencies": {
-    "glob": "^10.3.4",
     "ini": "^4.1.1",
     "npm-registry-fetch": "^16.0.0",
     "semver": "^7.5.4",
-    "yargs": "^17.7.2"
+    "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
-    "@plugjs/build": "^0.4.34",
-    "@types/glob": "^8.1.0",
+    "@plugjs/build": "^0.5.4",
     "@types/ini": "^1.3.31",
-    "@types/npm-registry-fetch": "^8.0.4",
-    "@types/semver": "^7.5.1",
-    "@types/yargs": "^17.0.24"
+    "@types/npm-registry-fetch": "^8.0.5",
+    "@types/semver": "^7.5.2",
+    "@types/yargs-parser": "^21.0.1"
   },
   "repository": {
     "type": "git",
@@ -41,7 +54,7 @@
   "homepage": "https://github.com/juitnow/juit-check-updates#readme",
   "files": [
     "*.md",
-    "check-updates.js",
+    "dist/",
     "src/"
   ],
   "directories": {

package/src/debug.ts

@@ -0,0 +1,14 @@
+/** Our colors */
+export const X = '\u001b[0m'
+export const R = '\u001b[38;5;203m'
+export const G = '\u001b[38;5;76m'
+export const Y = '\u001b[38;5;220m'
+export const B = '\u001b[38;5;69m'
+export const K = '\u001b[38;5;240m'
+
+/* Create our debug function */
+export function makeDebug(debug?: boolean): (...args: any[]) => void {
+  return debug ?
+    (...args: any[]) => void (args.length && console.log(`${K}[DEBUG]${X}`, ...args)) :
+    () => void 0
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export type { UpdaterOptions } from './updater'
+
+export { readNpmRc } from './npmrc'
+export { Updater } from './updater'
+export { VersionsCache } from './versions'

package/src/main.mts

@@ -0,0 +1,165 @@
+#!/usr/bin/env node
+
+import { readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import yargsParser from 'yargs-parser'
+
+import { B, G, K, R, X, Y, makeDebug } from './debug'
+import { Updater } from './updater'
+import { VersionsCache } from './versions'
+
+import type { UpdaterOptions } from './updater'
+
+type ReleaseType = undefined | 'major' | 'minor' | 'patch'
+function releaseType(releaseType: unknown): ReleaseType {
+  if (releaseType === undefined) return
+  if (releaseType === '') return 'patch'
+  if (releaseType === 'major') return 'major'
+  if (releaseType === 'minor') return 'minor'
+  if (releaseType === 'patch') return 'patch'
+  console.log(`Invalid flag for --bump: "${releaseType}"`)
+  process.exit(1)
+}
+
+/* ========================================================================== *
+ * CALL UP MAIN() AND DEAL WITH THE ASYNC PROMISE IT RETURNS                  *
+ * ========================================================================== */
+
+function showVersion(): never {
+  const path = fileURLToPath(import.meta.url)
+  const file = resolve(path, '..', '..', 'package.json')
+  const data = readFileSync(file, 'utf-8')
+  const json = JSON.parse(data)
+  console.log(`v${json.version}`)
+  process.exit(1)
+}
+
+function showHelp(): never {
+  console.log(`
+${Y}Usage${X}:
+  ${G}check-updates${X} [--options ...] [package.json ...]
+
+${Y}Options${X}:
+  ${G}-h${X}, ${G}--help${X}           Show this help.
+
+  ${G}-v${X}, ${G}--version${X}        Show the version and exit.
+
+  ${G}-b${X}, ${G}--bump${X}           Bump the version of the  package file when changes in the
+                       dependencies are found. Specifiy either "${B}major${X}",  "${B}minor${X}"
+                       or "${B}patch${X}" ${K}(default)${X} to indicate which version to bump.
+
+  ${G}-s${X}, ${G}--strict${X}         Strictly  adhere to semver  rules for  tilde ${K}(~x.y.z)${X} and
+                       caret ${K}(^x.y.z)${X} dependency ranges.
+
+  ${G}-q${X}, ${G}--quick${X}          Consider dev/peer/optional dependency updates if and only
+                       if the main depenencies also had updates.
+
+  ${G}-d${X}, ${G}--debug${X}          Output debugging informations.
+
+  ${G}-x${X}, ${G}--dry-run${X}        Do not write package changes.
+
+      ${G}--no-errors${X}      Exit with ${B}0${X} in case  of no updates.  Normally the updater
+                       will exit with ${B}255${X} in this case.
+
+      ${G}--no-workspaces${X}  Do not process workspaces.
+
+      ${G}--no-align${X}       Do not align workspaces versions. By default all versions
+                       will  be set to  the highest  one amongst  all workspaces
+                       after bumping.
+
+${Y}Remarks${X}:
+  Multiple ${B}package.json${X} files can be  specified on the command line.  In case no
+  files are specified,  the default is to process  the ${B}package.json${X}  file in the
+  current directory.
+`)
+  process.exit(1)
+}
+
+/* Parse command line arguments */
+const { _: args, ...opts } = yargsParser(process.argv.slice(2), {
+  configuration: {
+    'camel-case-expansion': false,
+    'strip-aliased': true,
+    'strip-dashed': true,
+  },
+  alias: {
+    'bump': [ 'b' ],
+    'debug': [ 'd' ],
+    'dry-run': [ 'x' ],
+    'help': [ 'h' ],
+    'quick': [ 'q' ],
+    'strict': [ 's' ],
+    'version': [ 'v' ],
+  },
+  string: [ 'bump' ],
+  boolean: [
+    'align',
+    'debug',
+    'dry-run',
+    'help',
+    'errors',
+    'quick',
+    'strict',
+    'version',
+    'workspaces',
+  ],
+})
+
+/* Preliminiary stuff before checking options */
+makeDebug(opts.debug)('Options:', { args, ...opts })
+if (opts.version) showVersion()
+if (opts.help) showHelp()
+
+/* Defaults */
+let align = true
+let dryRun = false
+let errors = true
+const options: UpdaterOptions = {
+  bump: undefined,
+  debug: false,
+  quick: false,
+  strict: false,
+  workspaces: true,
+}
+
+/* Process each option, one by one */
+for (const [ key, value ] of Object.entries(opts)) {
+  switch (key) {
+    case 'align': align = !! value; break
+    case 'bump': options.bump = releaseType(value); break
+    case 'debug': options.debug = !! value; break
+    case 'dry-run': dryRun = !! value; break
+    case 'errors': errors = !! value; break
+    case 'quick': options.quick = !! value; break
+    case 'strict': options.strict = !! value; break
+    case 'workspaces': options.workspaces = !! value; break
+    default:
+      console.log(`${R}[ERROR]${X} Unsupported / unknown option: --${key}\n`)
+      showHelp()
+  }
+}
+
+/* Normalize arguments and default to package.json in the current directory */
+const files = args.map((arg) => arg.toString())
+if (! files.length) files.push('package.json')
+
+/* Process packages, one by one */
+try {
+  const cache = new VersionsCache()
+
+  let changed = false
+  for (const file of files) {
+    const updater = await new Updater(file, options, cache).init()
+    await updater.update()
+    if (align) await updater.align()
+    if (! dryRun) await updater.write()
+    changed ||= updater.changed
+  }
+
+  process.exitCode = changed ? 0 : errors ? -1 : 0
+} catch (error) {
+  console.error(error)
+  process.exitCode = 1
+}

package/src/npmrc.ts

@@ -9,7 +9,7 @@ function replaceEnvironmentVariable(token: string): string {
   })
 }
 
-async function readFile(filename: string): Promise<Record<string, any>> {
+async function readIniFile(filename: string): Promise<Record<string, any>> {
   try {
     const data = await fs.readFile(filename, 'utf8')
     const npmrc = parse(data)
@@ -28,12 +28,12 @@ async function readFile(filename: string): Promise<Record<string, any>> {
 }
 
 export async function readNpmRc(packageJsonFile: string): Promise<Record<string, any>> {
-  const local = readFile(path.resolve(packageJsonFile, '..', '.npmrc'))
-  const user = readFile(
+  const local = readIniFile(path.resolve(packageJsonFile, '..', '.npmrc'))
+  const user = readIniFile(
     process.env.NPM_CONFIG_USERCONFIG ?
       process.env.NPM_CONFIG_USERCONFIG :
       process.env.HOME ? path.resolve(process.env.HOME, '.npmrc') : '' )
-  const global = readFile(
+  const global = readIniFile(
     process.env.NPM_CONFIG_GLOBALCONFIG ?
       process.env.NPM_CONFIG_GLOBALCONFIG :
       '/etc/npmrc')