Added a CLI and NPM module exports

Author: JamesMessinger

.gitignore

@@ -38,6 +38,9 @@ pids
 # Dependencies
 /node_modules
 
+# Build output
+/lib
+
 # Test output
 /.nyc_output
 /coverage

bin/npm-publish.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+"use strict";
+const { main } = require("../lib/cli");
+main(process.argv.slice(2));

package-lock.json

@@ -19,23 +19,25 @@
     "type": "git",
     "url": "https://github.com/JS-DevTools/npm-publish.git"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "bin": {
-    "npm-publish": "dist/index.js"
+    "npm-publish": "bin/npm-publish.js"
   },
   "files": [
-    "dist"
+    "bin",
+    "lib"
   ],
   "scripts": {
-    "clean": "shx rm -rf .nyc_output coverage dist",
+    "clean": "shx rm -rf .nyc_output coverage lib dist",
     "lint": "npm run lint:typescript && npm run lint:javascript",
     "lint:typescript": "tslint -p tsconfig.json",
     "lint:javascript": "eslint test",
-    "build": "npm run build:ncc && npm run build:node_modules",
-    "build:ncc": "ncc build src/index.ts --source-map --external semver",
+    "build": "npm run build:typescript && npm run build:ncc && npm run build:node_modules",
+    "build:typescript": "tsc --declaration",
+    "build:ncc": "ncc build src/action/index.ts --source-map --external semver",
     "build:node_modules": "shx mkdir -p dist/node_modules && shx cp -r node_modules/semver dist/node_modules",
-    "watch": "npm run build:ncc -- --watch",
+    "watch": "tsc --watch",
     "test": "mocha && npm run lint",
     "coverage": "nyc -x dist/sourcemap-register.js node_modules/mocha/bin/mocha",
     "upgrade": "npm-check -u && npm audit fix",
@@ -48,6 +50,7 @@
   "devDependencies": {
     "@actions/core": "^1.2.1",
     "@types/chai": "^4.2.7",
+    "@types/command-line-args": "^5.0.0",
     "@types/mocha": "^5.2.7",
     "@types/node": "^13.1.8",
     "@types/semver": "^6.2.0",
@@ -69,5 +72,8 @@
     "typescript": "^3.5.1",
     "typescript-tslint-plugin": "^0.5.0",
     "version-bump-prompt": "^5.0.3"
+  },
+  "dependencies": {
+    "command-line-args": "^5.1.1"
   }
 }

package.json

@@ -0,0 +1,11 @@
+/**
+ * CLI exit codes.
+ *
+ * @see https://nodejs.org/api/process.html#process_exit_codes
+ * @internal
+ */
+export enum ExitCode {
+  Success = 0,
+  FatalError = 1,
+  InvalidArgument = 9
+}

src/cli/exit-code.ts

@@ -0,0 +1,24 @@
+/**
+ * Text explaining how to use the CLI
+ * @internal
+ */
+export const usageText = `
+Usage: npm-publish [options] [package_path]
+
+options:
+  --token <token>     The NPM access token to use when publishing
+
+  --registry <url>    The NPM registry URL to use
+
+  --debug, -d         Enable debug mode, with increased logging
+
+  --quiet, -q         Suppress unnecessary output
+
+  --version, -v       Print the version number
+
+  --help, -h          Show help
+
+package_path          The absolute or relative path of the NPM package to publish.
+                      Can be a directory path, or the path of a package.json file.
+                      Defaults to the current directory.
+`;

src/cli/help.ts

@@ -0,0 +1,55 @@
+// tslint:disable: no-console
+import { join } from "path";
+import { npmPublish } from "../npm-publish";
+import { readManifest } from "../read-manifest";
+import { ExitCode } from "./exit-code";
+import { usageText } from "./help";
+import { parseArgs } from "./parse-args";
+
+/**
+ * The main entry point of the CLI
+ *
+ * @param args - The command-line arguments
+ */
+export async function main(args: string[]): Promise<void> {
+  try {
+    // Setup global error handlers
+    process.on("uncaughtException", errorHandler);
+    process.on("unhandledRejection", errorHandler);
+
+    // Parse the command-line arguments
+    let { help, version, options } = parseArgs(args);
+
+    if (help) {
+      // Show the help text and exit
+      console.log(usageText);
+      process.exit(ExitCode.Success);
+    }
+    else if (version) {
+      // Show the version number and exit
+      let manifest = await readManifest(join(__dirname, "../../package.json"));
+      console.log(manifest.version);
+      process.exit(ExitCode.Success);
+    }
+    else {
+      await npmPublish(options);
+    }
+  }
+  catch (error) {
+    errorHandler(error as Error);
+  }
+}
+
+/**
+ * Prints errors to the console
+ */
+function errorHandler(error: Error): void {
+  let message = error.message || String(error);
+
+  if (process.env.DEBUG || process.env.NODE_ENV === "development") {
+    message = error.stack || message;
+  }
+
+  console.error(message);
+  process.exit(ExitCode.FatalError);
+}

src/cli/index.ts

@@ -0,0 +1,60 @@
+// tslint:disable: no-console
+import * as commandLineArgs from "command-line-args";
+import { Options } from "../options";
+import { ExitCode } from "./exit-code";
+import { usageText } from "./help";
+
+/**
+ * The parsed command-line arguments
+ * @internal
+ */
+export interface ParsedArgs {
+  help?: boolean;
+  version?: boolean;
+  options: Options;
+}
+
+/**
+ * Parses the command-line arguments
+ * @internal
+ */
+export function parseArgs(argv: string[]): ParsedArgs {
+  try {
+    let args = commandLineArgs(
+      [
+        { name: "token", type: String },
+        { name: "registry", type: String },
+        { name: "package", type: String, defaultOption: true },
+        { name: "debug", alias: "d", type: Boolean },
+        { name: "quiet", alias: "q", type: Boolean },
+        { name: "version", alias: "v", type: Boolean },
+        { name: "help", alias: "h", type: Boolean },
+      ],
+      { argv }
+    );
+
+    let parsedArgs: ParsedArgs = {
+      help: args.help as boolean,
+      version: args.version as boolean,
+      options: {
+        token: args.token as string,
+        registry: args.registry as string,
+        package: args.package as string,
+        debug: args.debug ? console.debug : undefined,
+        quiet: args.quiet as boolean,
+      }
+    };
+
+    return parsedArgs;
+  }
+  catch (error) {
+    // There was an error parsing the command-line args
+    return errorHandler(error as Error);
+  }
+}
+
+function errorHandler(error: Error): never {
+  console.error(error.message);
+  console.error(usageText);
+  return process.exit(ExitCode.InvalidArgument);
+}

src/cli/parse-args.ts

@@ -1,45 +1,15 @@
-import { getInput, setFailed, setOutput } from "@actions/core";
-import { Options } from "./options";
-import { publishToNPM } from "./publish-to-npm";
+// tslint:disable: no-default-export
+import { npmPublish } from "./npm-publish";
 
-/**
- * The main entry point of the GitHub Action
- */
-async function main(): Promise<void> {
-  try {
-    // Setup global error handlers
-    process.on("uncaughtException", errorHandler);
-    process.on("unhandledRejection", errorHandler);
+// Exprot the external type definitions as named exports
+export * from "./options";
+export * from "./results";
 
-    // Get the GitHub Actions input options
-    const options: Options = {
-      token: getInput("token", { required: true }),
-      registry: getInput("registry", { required: true }),
-      package: getInput("package", { required: true }),
-      checkVersion: getInput("check-version", { required: true }).toLowerCase() === "true",
-    };
+// Export `npmPublish` as a named export and the default export
+export { npmPublish };
+export default npmPublish;
 
-    // Puglish to NPM
-    let results = await publishToNPM(options);
-
-    // Set the GitHub Actions output variables
-    setOutput("type", results.type);
-    setOutput("version", results.version);
-    setOutput("old-version", results.oldVersion);
-  }
-  catch (error) {
-    errorHandler(error as Error);
-  }
-}
-
-/**
- * Prints errors to the console
- */
-function errorHandler(error: Error): void {
-  let message = error.stack || error.message || String(error);
-  setFailed(message);
-  process.exit();
+// CommonJS default export hack
+if (typeof module === "object" && typeof module.exports === "object") {
+  module.exports = Object.assign(module.exports.default, module.exports);  // tslint:disable-line: no-unsafe-any
 }
-
-// tslint:disable-next-line: no-floating-promises
-main();