feat: Add basic API and CLI

Author: ffflorian

README.md

@@ -5,3 +5,28 @@ Check your [Rust packages](https://crates.io) for updates.
 ## Installation
 
 Run `yarn global add crates-updater` or `npm i -g crates-updater`.
+
+## Usage
+
+```
+Usage: crates-updater [options]
+
+Check your Rust packages for updates.
+
+Options:
+  -p, --package <package>          which package to check (required)
+  -V, --package-version <version>  which version to check
+  -k, --api-key <key>              set the API key for libraries.io (required)
+  -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 -k <api key>
+
+# returns the latest version
+crates-updater -p ripgrep -k <api key>
+```

package.json

@@ -1,10 +1,13 @@
 {
   "author": "Florian Keller <github@floriankeller.de>",
   "bin": {
+    "crates-updater": "dist/cli.js",
     "update-crate": "dist/cli.js",
     "update-crates": "dist/cli.js"
   },
   "dependencies": {
+    "commander": "2.19.0",
+    "compare-versions": "3.4.0",
     "libraries.io": "1.2.2"
   },
   "description": "Check your Rust packages for updates.",

src/CratesUpdater.ts

@@ -0,0 +1,32 @@
+import compareVersions = require('compare-versions');
+import {LibrariesIO, ProjectVersion} from 'libraries.io';
+
+class CratesUpdater {
+  private readonly librariesIO: LibrariesIO;
+
+  constructor(apiKey: string) {
+    this.librariesIO = new LibrariesIO(apiKey);
+  }
+
+  public async getVersions(packageName: string): Promise<ProjectVersion[]> {
+    const result = await this.librariesIO.api.project.getProject('cargo', packageName);
+    return result.data.versions;
+  }
+
+  public async getLatestVersion(packageName: string): Promise<ProjectVersion> {
+    const versions = await this.getVersions(packageName);
+    const sorted = versions.sort((a, b) => compareVersions(a.number, b.number));
+    return sorted[versions.length - 1];
+  }
+
+  public async checkForUpdate(packageName: string, version: string): Promise<string | null> {
+    const latestVersion = await this.getLatestVersion(packageName);
+    if (compareVersions(latestVersion.number, version) > 0) {
+      return latestVersion.number;
+    }
+
+    return null;
+  }
+}
+
+export {CratesUpdater};

src/cli.ts

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+import * as program from 'commander';
+import {CratesUpdater} from './CratesUpdater';
+
+const {name, version, description}: {name: string; version: string; description: string} = 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')
+  .option('-k, --api-key <key>', 'set the API key for libraries.io (required)')
+  .version(version, '-v, --version')
+  .parse(process.argv);
+
+if (!program.options.length || !program.apiKey || !program.package) {
+  program.outputHelp();
+  process.exit(1);
+}
+
+const cratesUpdater = new CratesUpdater(program.apiKey);
+
+if (program.package && !program.packageVersion) {
+  cratesUpdater
+    .getLatestVersion(program.package)
+    .then(version => console.log(version.number))
+    .catch(error => {
+      console.error(error);
+      process.exit(1);
+    });
+} else {
+  cratesUpdater
+    .checkForUpdate(program.package, program.packageVersion)
+    .then(version => {
+      if (version) {
+        console.log(version);
+      }
+    })
+    .catch(error => {
+      console.error(error);
+      process.exit(1);
+    });
+}

src/index.ts

@@ -0,0 +1 @@
+export * from './CratesUpdater';

yarn.lock

@@ -285,11 +285,16 @@ color-name@1.1.3:
   resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25"
   integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=
 
-commander@^2.12.1, commander@^2.14.1, commander@^2.9.0:
+commander@2.19.0, commander@^2.12.1, commander@^2.14.1, commander@^2.9.0:
   version "2.19.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.19.0.tgz#f6198aa84e5b83c46054b94ddedbfed5ee9ff12a"
   integrity sha512-6tvAOO+D6OENvRAh524Dh9jcfKTYDQAqvqezbCW82xj5X0pSrcpxtvRKHLG0yBY6SD7PSDrJaj+0AiOcKVd1Xg==
 
+compare-versions@3.4.0:
+  version "3.4.0"
+  resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-3.4.0.tgz#e0747df5c9cb7f054d6d3dc3e1dbc444f9e92b26"
+  integrity sha512-tK69D7oNXXqUW3ZNo/z7NXTEz22TCF0pTE+YF9cxvaAM9XnkLo1fV621xCLrRR6aevJlKxExkss0vWqUCUpqdg==
+
 component-emitter@^1.2.1:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.2.1.tgz#137918d6d78283f7df7a6b7c5a63e140e69425e6"