@autorest/common/src/exceptions/exceptions.ts

Autorest common utilities

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

export class Exception extends Error {
  constructor(
    message: string,
    public exitCode: number = 1,
  ) {
    super(message.includes("[") ? message : `[Exception] ${message}`);

    Object.setPrototypeOf(this, Exception.prototype);
  }
}

export class OperationCanceledException extends Exception {
  constructor(
    message = "Cancelation Requested",
    public exitCode: number = 1,
  ) {
    super(`[OperationCanceledException] ${message}`, exitCode);
    Object.setPrototypeOf(this, OperationCanceledException.prototype);
  }
}

export class OutstandingTaskAlreadyCompletedException extends Exception {
  constructor() {
    super(
      "[OutstandingTaskAlreadyCompletedException] The OutstandingTaskAwaiter is already completed, may not Enter() again.",
      1,
    );
    Object.setPrototypeOf(this, OutstandingTaskAlreadyCompletedException.prototype);
  }
}

export class OperationAbortedException extends Exception {
  constructor() {
    super("[OperationAbortedException] Error occurred. Exiting.", 1);
    Object.setPrototypeOf(this, OperationAbortedException.prototype);
  }
}

/**
 * Represent an error emitted by a plugin where the plugin contains some failure due to the user input. This will make autorest close with a better error message.
 */
export class PluginUserError extends Error {
  public code = "PluginUserError";

  public constructor(public pluginName: string) {
    super(`Plugin '${pluginName}' completed with some error.`);
  }
}