Added "tag" and "scope" options

Author: JamesMessinger

src/normalize-options.ts

@@ -1,5 +1,5 @@
 import { URL } from "url";
-import { Debug, Options } from "./options";
+import { Access, Debug, Options } from "./options";
 
 /**
  * Normalized and sanitized options
@@ -9,8 +9,10 @@ export interface NormalizedOptions {
   token: string;
   registry: URL;
   package: string;
-  checkVersion: boolean;
+  tag: string;
+  access?: Access;
   dryRun: boolean;
+  checkVersion: boolean;
   quiet: boolean;
   debug: Debug;
 }
@@ -26,8 +28,10 @@ export function normalizeOptions(options: Options): NormalizedOptions {
     token: options.token || "",
     registry: registryURL || new URL("https://registry.npmjs.org/"),
     package: options.package || "package.json",
-    checkVersion: options.checkVersion === undefined ? true : Boolean(options.checkVersion),
+    tag: options.tag || "latest",
+    access: options.access,
     dryRun: options.dryRun || false,
+    checkVersion: options.checkVersion === undefined ? true : Boolean(options.checkVersion),
     quiet: options.quiet || false,
     debug: options.debug || (() => undefined),
   };

src/npm-publish.ts

@@ -28,6 +28,8 @@ export async function npmPublish(opts: Options = {}): Promise<Results> {
     type: diff || "none",
     version: manifest.version.raw,
     oldVersion: publishedVersion.raw,
+    tag: options.tag,
+    access: options.access || (manifest.name.startsWith("@") ? "restricted" : "public"),
     dryRun: options.dryRun
   };
 

src/npm.ts

@@ -21,16 +21,26 @@ export const npm = {
     await setNpmConfig(options);
 
     try {
+      let command = ["npm", "view"];
+
+      if (options.tag === "latest") {
+        command.push(name);
+      }
+      else {
+        command.push(`${name}@${options.tag}`);
+      }
+
+      command.push("version");
+
       // Get the environment variables to pass to NPM
       let env = getNpmEnvironment(options);
 
-      options.debug(`Running command: npm view ${name} version`);
-
       // Run NPM to get the latest published version of the package
-      let { stdout, stderr } = await ezSpawn.async("npm", ["view", name, "version"], { env });
+      options.debug(`Running command: npm view ${name} version`, { command, env });
+      let { stdout, stderr } = await ezSpawn.async(command, { env });
 
       // If the package was not previously published, return version 0.0.0.
-      if (stderr && stderr.indexOf("E404") !== -1) {
+      if (stderr && stderr.includes("E404")) {
         options.debug(`The latest version of ${name} is at v0.0.0, as it was never published.`);
         return new SemVer("0.0.0");
       }
@@ -57,6 +67,20 @@ export const npm = {
     await setNpmConfig(options);
 
     try {
+      let command = ["npm", "publish"];
+
+      if (options.tag !== "latest") {
+        command.push("--tag", options.tag);
+      }
+
+      if (options.access) {
+        command.push("--access", options.access);
+      }
+
+      if (options.dryRun) {
+        command.push("--dry-run");
+      }
+
       // Run "npm publish" in the package.json directory
       let cwd = resolve(dirname(options.package));
 
@@ -66,12 +90,9 @@ export const npm = {
       // Get the environment variables to pass to NPM
       let env = getNpmEnvironment(options);
 
-      options.debug("Running command: npm publish", { stdio, cwd, env });
-
-      let command = options.dryRun ? ["publish", "--dry-run"] : ["publish"];
-
       // Run NPM to publish the package
-      await ezSpawn.async("npm", command, { cwd, stdio, env });
+      options.debug("Running command: npm publish", { command, stdio, cwd, env });
+      await ezSpawn.async(command, { cwd, stdio, env });
     }
     catch (error) {
       throw ono(error, `Unable to publish ${name} v${version} to NPM.`);

src/options.ts

@@ -24,12 +24,21 @@ export interface Options {
   package?: string;
 
   /**
-   * Only publish the package if the version number in package.json
-   * differs from the latest on NPM.
+   * The tag to publish to. This allows people to install the package
+   * using "npm install <package-name>@<tag>".
    *
-   * Defaults to `true`
+   * Defaults to "latest"
    */
-  checkVersion?: boolean;
+  tag?: string;
+
+  /**
+   * Determines whether the published package should be publicly visible,
+   * or restricted to members of your NPM organization. This only applies
+   * to scoped packages.
+   *
+   * Defaults to "restricted" for scoped packages and "public" for non-scoped packages.
+   */
+  access?: Access;
 
   /**
    * If true, run npm publish with the --dry-run flag
@@ -40,6 +49,14 @@ export interface Options {
    */
   dryRun?: boolean;
 
+  /**
+   * Only publish the package if the version number in package.json
+   * differs from the latest on NPM.
+   *
+   * Defaults to `true`
+   */
+  checkVersion?: boolean;
+
   /**
    * Suppress console output from NPM and npm-publish.
    *
@@ -55,6 +72,11 @@ export interface Options {
   debug?: Debug;
 }
 
+/**
+ * The possible access levels for an NPM package
+ */
+export type Access = "public" | "restricted";
+
 /**
  * A function that receives debug messages
  */

src/results.ts

@@ -1,4 +1,5 @@
 import { ReleaseType } from "semver";
+import { Access } from "./options";
 
 export { ReleaseType };
 
@@ -26,6 +27,17 @@ export interface Results {
    */
   oldVersion: string;
 
+  /**
+   * The tag that the package was published to.
+   */
+  tag: string;
+
+  /**
+   * Indicates whether the published package is publicly visible
+   * or restricted to members of your NPM organization.
+   */
+  access: Access;
+
   /**
    * Whether this was a dry run (not published to NPM)
    */