@ts-common/azure-js-dev-tools/lib/checkPackageJsonVersion.ts

Developer dependencies for TypeScript related projects

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

import { Logger } from "@azure/logger-js";

import { getDefaultLogger } from "./logger";
import { findPackageJsonFileSync, isPackageJsonPublished, PackageJson, readPackageJsonFileSync } from "./packageJson";
import { AdditionalCheck } from "./checkEverything";

export interface CheckPackageJsonVersionOptions {
  /**
   * The path to start looking for the package.json file at.
   */
  startPath?: string;
  /**
   * The Logger to use. If no Logger is specified, then a default Logger will be used instead.
   */
  logger?: Logger;
}

export function checkPackageJsonVersion(options: CheckPackageJsonVersionOptions = {}): AdditionalCheck {
  return {
    name: "Package.json Version",
    check: () => checkPackageJsonVersionCheck(options),
  };
}

/**
 * Check the package.json file found at the provided startPath (or in one of the parent folders) to
 * see if the version number has already been published. If the version number has been published,
 * then a non-zero error code will be returned.
 * @param startPath The path to start looking for the package.json file in.
 * @param logger The logger to use. If no logger is specified, then a console logger will be used.
 * @returns The exit code for this function. Zero will be returned if the package version doesn't
 * exist in NPM.
 */
export async function checkPackageJsonVersionCheck(options: CheckPackageJsonVersionOptions = {}): Promise<number> {
  const startPath: string = options.startPath || process.cwd();
  const logger: Logger = options.logger || getDefaultLogger();

  let exitCode: number;
  logger.logSection(`Looking for package.json file starting at "${startPath}"...`);
  const packageJsonFilePath: string | undefined = findPackageJsonFileSync(startPath);
  if (!packageJsonFilePath) {
    logger.logError(`Could not find a package.json file at "${startPath}" or in any of its parent folders.`);
    exitCode = 1;
  } else {
    logger.logInfo(`Found a package.json file at "${packageJsonFilePath}".`);
    const packageJson: PackageJson = readPackageJsonFileSync(packageJsonFilePath);
    if (await isPackageJsonPublished(packageJson)) {
      logger.logError(`A package with the name "${packageJson.name}" and the version "${packageJson.version}" already exists in NPM.`);
      exitCode = 2;
    } else {
      logger.logInfo(`No package exists yet with the name "${packageJson.name}" and the version "${packageJson.version}".`);
      exitCode = 0;
    }
  }

  process.exitCode = exitCode;

  return exitCode;
}