check-update.ts

import {Hook} from '@oclif/config'
import * as Chalk from 'chalk'
import {spawn} from 'child_process'
import * as fs from 'fs-extra'
import * as _ from 'lodash'
import * as path from 'path'
import * as semver from 'semver'

const debug = require('debug')('update-check')

const hook: Hook<'init'> = async function ({config}) {
  const file = path.join(config.cacheDir, 'version')

  // Destructure package.json configuration with defaults
  const {
    timeoutInDays = 60,
    message = '<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.',
    registry = 'https://registry.npmjs.org',
    authorization = '',
  } = (config.pjson.oclif as any)['warn-if-update-available'] || {}

  const checkVersion = async () => {
    try {
      // do not show warning if updating
      if (process.argv[2] === 'update') return
      const distTags = await fs.readJSON(file)
      if (config.version.includes('-')) {
        // TODO: handle channels
        return
      }
      if (distTags && distTags.latest && semver.gt(distTags.latest.split('-')[0], config.version.split('-')[0])) {
        const chalk: typeof Chalk = require('chalk')
        const template = _.template
        // Default message if the user doesn't provide one
        this.warn(template(message)({
          chalk,
          config,
          ...distTags,
        }))
      }
    } catch (error) {
      if (error.code !== 'ENOENT') throw error
    }
  }

  const refreshNeeded = async () => {
    try {
      const {mtime} = await fs.stat(file)
      const staleAt = new Date(mtime.valueOf() + (1000 * 60 * 60 * 24 * timeoutInDays))
      return staleAt < new Date()
    } catch (error) {
      debug(error)
      return true
    }
  }

  const spawnRefresh = async () => {
    debug('spawning version refresh')
    spawn(
      process.execPath,
      [path.join(__dirname, '../../../lib/get-version'), config.name, file, config.version, registry, authorization],
      {
        detached: !config.windows,
        stdio: 'ignore',
      },
    ).unref()
  }

  await checkVersion()
  if (await refreshNeeded()) await spawnRefresh()
}

export default hook