@oclif/plugin-warn-if-update-available

What is @oclif/plugin-warn-if-update-available?

@oclif/plugin-warn-if-update-available is a plugin for the Oclif CLI framework that checks for updates to the CLI tool and warns the user if an update is available. This helps ensure that users are always aware of the latest version and can benefit from new features, bug fixes, and security patches.

What are @oclif/plugin-warn-if-update-available's main functionalities?

Check for Updates

This feature checks if there is an update available for the CLI tool and warns the user if an update is found. The code sample demonstrates how to integrate this functionality into an Oclif command.

const { Command } = require('@oclif/command');
const { warnIfUpdateAvailable } = require('@oclif/plugin-warn-if-update-available');

class MyCommand extends Command {
  async run() {
    await warnIfUpdateAvailable(this.config);
    this.log('Hello, world!');
  }
}

MyCommand.run();

Other packages similar to @oclif/plugin-warn-if-update-available

update-notifier

update-notifier is a package that checks for updates of a given npm package and notifies the user if an update is available. It is similar to @oclif/plugin-warn-if-update-available but can be used with any Node.js application, not just Oclif-based CLIs.

npm-check-updates

npm-check-updates is a tool that allows you to find and update outdated npm dependencies in your project. While it is more focused on updating dependencies rather than notifying users of CLI updates, it provides similar functionality in terms of keeping software up-to-date.

README

@oclif/plugin-warn-if-update-available

warns if there is a newer version of CLI released

• @oclif/plugin-warn-if-update-available
• What is this?
• How it works
• Installation
• Configuration
• Environment Variables
• Contributing

What is this?

This plugin shows a warning message if a user is running an out of date CLI.

How it works

This checks the version against the npm registry asynchronously in a forked process once every 60 days by default (see Configuration for how to configure this). It then saves a version file to the cache directory that will enable the warning. The upside of this method is that it won't block a user while they're using your CLI—the downside is that it will only display after running a command that fetches the new version.

Installation

Add the plugin to your project with yarn add @oclif/plugin-warn-if-update-available, then add it to the package.json of the oclif CLI:

{
  "name": "mycli",
  "version": "0.0.0",
  // ...
  "oclif": {
    "plugins": ["@oclif/plugin-help", "@oclif/plugin-warn-if-update-available"]
  }
}

Configuration

In package.json, set oclif['warn-if-update-available'] to an object with any of the following configuration properties:

• timeoutInDays - Duration between update checks. Defaults to 60.
• message - Customize update message.
• registry - URL of registry. Defaults to the public npm registry: https://registry.npmjs.org
• authorization - Authorization header value for registries that require auth.
• frequency - The frequency that the new version warning should be shown.
• frequencyUnit - The unit of time that should be used to calculate the frequency (days, hours, minutes, seconds, milliseconds). Defaults to minutes.

Example configuration

{
  "oclif": {
    "plugins": ["@oclif/plugin-warn-if-update-available"],
    "warn-if-update-available": {
      "timeoutInDays": 7,
      "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.",
      "registry": "https://my.example.com/module/registry",
      "authorization": "Basic <SOME READ ONLY AUTH TOKEN>"
    }
  }
}

Notification Frequency

Once a new version has been found, the default behavior is to notify the user on every command execution. You can modify this by setting the frequency and frequencyUnit options.

Examples

Once every 10 minutes.

{
  "oclif": {
    "warn-if-update-available": {
      "frequency": 10
    }
  }
}

Once every 6 hours.

{
  "oclif": {
    "warn-if-update-available": {
      "frequency": 6,
      "frequencyUnit": "hours"
    }
  }
}

Once a day.

{
  "oclif": {
    "warn-if-update-available": {
      "frequency": 1,
      "frequencyUnit": "days"
    }
  }
}

Once every 30 seconds.

{
  "oclif": {
    "warn-if-update-available": {
      "frequency": 30,
      "frequencyUnit": "seconds"
    }
  }
}

Environment Variables

• <CLI>_SKIP_NEW_VERSION_CHECK: Skip this version check
• <CLI>_FORCE_VERSION_CACHE_UPDATE: Force the version cache to update
• <CLI>_NEW_VERSION_CHECK_FREQ: environment variable override for frequency setting
• <CLI>_NEW_VERSION_CHECK_FREQ_UNIT: environment variable override for frequencyUnit setting

Contributing

See contributing guide

Changelog

3.0.19 (2024-05-12)

Bug Fixes

• deps: bump @oclif/core from 3.26.5 to 3.26.6 (#604) (5f520d6)