Registries toolbox & update notifications for your CLI
Inspired by the node package update-notifier.
- Contents
- Usage
- API
- notifier = UpdateNotifier({ name, owner, registry, currentVersion, updateCheckInterval})
- notifier.checkForUpdates(configDir)
- notifier.notify(command, overwrite)
- Update
- Registry Class
- latestVersion(registryDomain, module, owner)
- latestStableVersion(registryDomain, module, owner)
- sortedVersions(registryDomain, module, owner)
- parseURL(url)
- getRegistry(registryDomain)
- Contributing
import {
NestLand,
UpdateNotifier,
} from "https://x.nest.land/[email protected]/mod.ts";
const notifier = new UpdateNotifier({
name: "denon",
registry: NestLand,
currentVersion: "0.1.2",
});
await notifier.checkForUpdates();
notifier.notify();import {
Github,
UpdateNotifier,
} from "https://x.nest.land/[email protected]/mod.ts";
const notifier = new UpdateNotifier({
name: "denon", // module name
owner: "denosaurs", // module owner, mandatory for registries like github
registry: Github, // registry object
currentVersion: "0.1.2",
updateCheckInterval: 1000 * 60 * 60, // time interval between two checks, in milliseconds
});
const update = await notifier.checkForUpdates(); // undefined if there is no update available
console.log(update);
/** {
current: "0.1.2",
latest: "2.4.0",
type: "major",
name: "denon",
owner: "denosaurs",
registry: "raw.githubusercontent.com"
} */
notifier.notify("my command"); // displays the default notification with a custom command
Suppose denon does not use hatcher to notify its users of updates.
You can install denon with hatcher built-in !
If the install command is :
deno install --allow-read --allow-run --allow-write --allow-net -f -q --unstable https://deno.land/x/[email protected]/denon.tsYou can do:
deno install -A https://x.nest.land/[email protected]/hatcher.ts
hatcher --allow-read --allow-run --allow-write --allow-net -f -q --unstable https://deno.land/x/[email protected]/denon.tsAnd voila ! You will be notified as soon as an update is available.
Whenever you initiate the update notifier and it's not within the interval threshold, it will asynchronously check with the specified registry for available updates, then persist the result. This prevents any impact on your module startup performance.
The first time the user runs your app, it will check for an update, and even if an update is available, it will wait the specified updateCheckInterval before notifying the user (one day by default). This is done to not be annoying to the user, but might surprise you as an implementer if you're testing whether it works. Check out example.ts to quickly test out hatcher and see how you can test that it works in your app.
deno run -A https://x.nest.land/[email protected]/example.tsimport {
getLatestVersion,
parseURL,
} from "https://x.nest.land/[email protected]/mod.ts";
const result = parseURL("https://deno.land/x/[email protected]/src/runner.ts");
/** {
registry: "deno.land",
name: "denon",
version: "1.2.0",
parsedURL: "https://deno.land/x/denon@${version}/src/runner.ts",
relativePath: "src/runner.ts",
owner: ""
} */
const latestVersion = await getLatestVersion("deno.land", "denon");
console.log(latestVersion); // 0.2.4required
type: string
required for raw.githubusercontent.com, denopkg.com
type: string
required
type: Registry
required
type: string | semver.SemVer
In milliseconds, defaults to one day.
type: number
configDir is the directory where hatcher will save some information about your
module.
Defaults to ~/.deno/hatcher
Returns an Update object if there is an update available,
undefined otherwise.
By default, will ask the user to visit the registry.
notifier.notify();
type: string
notifier.notify("my command");
type: boolean
Will overwrite the body of the notification.
notifier.notify("My custom message", true);
You can of course also display a fully customized message if an update is available.
const update = await notifier.checkForUpdates();
if (update) {
console.log(`New update! ${update.latest}`);
}{
latest:
string;
current:
string;
type:
semver.ReleaseType | null; // "pre" | "major" | "premajor" | "minor" | "preminor" | "patch" | "prepatch" | "prerelease" | null
name:
string;
owner:
string;
registry:
string;
}Supported registers for the time being:
| domain (string) | Registry class |
|---|---|
deno.land |
DenoLand |
denopkg.com |
Denopkg |
raw.githubusercontent.com |
Github |
jspm.dev |
Jspm |
x.nest.land |
NestLand |
cdn.skypack.dev |
Skypack |
You can add your own registers by adding them to registries.
import { registries } from "https://x.nest.land/[email protected]/mod.ts";
registries.push(myRegistry);Your registry must implement the Registry object:
abstract class Registry {
static domain: string;
static async latestVersion(
module: string,
owner?: string,
): Promise<string | undefined>;
static async latestStableVersion(
module: string,
owner?: string,
): Promise<string | undefined>;
static async sortedVersions(
module: string,
owner?: string,
): Promise<string[]>;
static parseURL(url: string): URLData;
}Get latest version from supported registries
required
type: string
One of the supported registries domain.
required
type: string
required for raw.githubusercontent.com, denopkg.com
type: string
type: string
Same as latestVersion but get the latest stable version according to the
SemVer rules.
Get sorted versions from supported registries
required
type: string
One of the supported registries domain.
required
type: string
required for raw.githubusercontent.com, denopkg.com
type: string
type: string[]
Parse an URL from supported registries
required
type: string
interface ProcessedURL {
registry: string;
name: string;
owner: string;
version: string;
parsedURL: string;
relativePath: string;
}Get registry object from web domain
required
type: string
type: Registry
All contributions are welcome! If you can think of a command or feature that might benefit nest.land, fork this repository and make a pull request from your branch with the additions. Make sure to use Conventional Commits