feat: Quiet mode, simple functions (#123)

Author: ffflorian

README.md

@@ -9,23 +9,26 @@ Run `yarn global add crates-updater` or `npm i -g crates-updater`.
 ## Usage
 
 ```
-Usage: crates-updater [options]
+Usage: crates-updater [options] <package> [packageVersion]
 
 Check your Rust packages for updates.
 
 Options:
-  -p, --package <package>          which package to check (required)
-  -V, --package-version <version>  which version to check
-  -v, --version                    output the version number
-  -h, --help                       output usage information
+  -q, --quiet    quiet mode. Display newer version or nothing
+  -v, --version  output the version number
+  -h, --help     output usage information
 ```
 
 ## Examples
 
 ```shell
 # returns either a newer version or nothing
-crates-updater -p ripgrep -V 0.9.0
+crates-updater ripgrep -q 0.9.0
 
-# returns the latest version
-crates-updater -p ripgrep
+# returns the latest version with a helpful text
+crates-updater ripgrep
 ```
+
+## API Usage
+
+See [`cli.ts`](./src/cli.ts).

src/CratesUpdater.ts

@@ -1,31 +1,23 @@
 import compareVersions = require('compare-versions');
 import {CratesIO, Version as CrateVersion} from 'crates.io';
 
-class CratesUpdater {
-  private readonly cratesIO: CratesIO;
+const cratesIO = new CratesIO();
 
-  constructor() {
-    this.cratesIO = new CratesIO();
+export async function checkForUpdate(packageName: string, version: string): Promise<string | null> {
+  const latestVersion = await getLatestVersion(packageName);
+  if (compareVersions(latestVersion.num, version) > 0) {
+    return latestVersion.num;
   }
 
-  public async checkForUpdate(packageName: string, version: string): Promise<string | null> {
-    const latestVersion = await this.getLatestVersion(packageName);
-    if (compareVersions(latestVersion.num, version) > 0) {
-      return latestVersion.num;
-    }
-
-    return null;
-  }
-
-  public async getLatestVersion(packageName: string): Promise<CrateVersion> {
-    const versions = await this.getVersions(packageName);
-    return versions.sort((a, b) => compareVersions(a.num, b.num)).pop()!;
-  }
+  return null;
+}
 
-  public async getVersions(packageName: string): Promise<CrateVersion[]> {
-    const {versions} = await this.cratesIO.api.crates.getVersions(packageName);
-    return versions;
-  }
+export async function getLatestVersion(packageName: string): Promise<CrateVersion> {
+  const versions = await getVersions(packageName);
+  return versions.sort((a, b) => compareVersions(a.num, b.num)).pop()!;
 }
 
-export {CratesUpdater};
+export async function getVersions(packageName: string): Promise<CrateVersion[]> {
+  const {versions} = await cratesIO.api.crates.getVersions(packageName);
+  return versions;
+}

src/cli.ts

@@ -1,45 +1,52 @@
 #!/usr/bin/env node
 
 import * as program from 'commander';
-import {CratesUpdater} from './CratesUpdater';
+import * as CratesUpdater from './CratesUpdater';
 
-const {name, version, description}: {description: string; name: string; version: string} = require('../package.json');
+const {name, version, description} = require('../package.json');
 
 program
   .name(name)
   .description(description)
-  .option('-p, --package <package>', 'which package to check (required)')
-  .option('-V, --package-version <version>', 'which version to check')
+  .arguments('<package>')
+  .arguments('[packageVersion]')
+  .option('-q, --quiet', 'quiet mode. Display newer version or nothing')
   .version(version, '-v, --version')
   .parse(process.argv);
 
-if (!program.options.length || !program.package) {
+if (!program.args.length) {
   program.outputHelp();
   process.exit(1);
 }
 
-const cratesUpdater = new CratesUpdater();
+const [packageName, packageVersion] = program.args;
 
-if (program.package && program.packageVersion) {
-  cratesUpdater
-    .checkForUpdate(program.package, program.packageVersion)
+if (packageVersion) {
+  CratesUpdater.checkForUpdate(packageName, packageVersion)
     .then(version => {
-      if (version) {
-        console.log(`An update for ${program.package} is available: ${version}.`);
+      if (program.quiet) {
+        if (version) {
+          console.log(version);
+        }
       } else {
-        console.log(`No update for ${program.package} available.`);
+        const text = version
+          ? `An update for ${packageName} is available: ${version}.`
+          : `No update for ${packageName} available.`;
+        console.log(text);
       }
     })
     .catch(error => {
-      console.error(error);
+      console.error(error.message);
       process.exit(1);
     });
 } else {
-  cratesUpdater
-    .getLatestVersion(program.package)
-    .then(version => console.log(version.num))
+  CratesUpdater.getLatestVersion(packageName)
+    .then(version => {
+      const text = program.quiet ? version.num : `Latest ${packageName} version is ${version.num}.`;
+      console.log(text);
+    })
     .catch(error => {
-      console.error(error);
+      console.error(error.message);
       process.exit(1);
     });
 }