Rename coverError to wrapError

Author: mcmire

src/fs.ts

@@ -3,7 +3,7 @@ import {
   readJsonObjectFile as underlyingReadJsonObjectFile,
   writeJsonFile as underlyingWriteJsonFile,
 } from '@metamask/action-utils';
-import { coverError, isErrorWithCode } from './misc-utils';
+import { wrapError, isErrorWithCode } from './misc-utils';
 
 /**
  * Reads the file at the given path, assuming its content is encoded as UTF-8.
@@ -16,7 +16,7 @@ export async function readFile(filePath: string): Promise<string> {
   try {
     return await fs.promises.readFile(filePath, 'utf8');
   } catch (error) {
-    throw coverError(`Could not read file '${filePath}'`, error);
+    throw wrapError(`Could not read file '${filePath}'`, error);
   }
 }
 
@@ -34,7 +34,7 @@ export async function writeFile(
   try {
     await fs.promises.writeFile(filePath, content);
   } catch (error) {
-    throw coverError(`Could not write file '${filePath}'`, error);
+    throw wrapError(`Could not write file '${filePath}'`, error);
   }
 }
 
@@ -56,7 +56,7 @@ export async function readJsonObjectFile(
   try {
     return await underlyingReadJsonObjectFile(filePath);
   } catch (error) {
-    throw coverError(`Could not read JSON file '${filePath}'`, error);
+    throw wrapError(`Could not read JSON file '${filePath}'`, error);
   }
 }
 
@@ -77,7 +77,7 @@ export async function writeJsonFile(
   try {
     await underlyingWriteJsonFile(filePath, jsonValue);
   } catch (error) {
-    throw coverError(`Could not write JSON file '${filePath}'`, error);
+    throw wrapError(`Could not write JSON file '${filePath}'`, error);
   }
 }
 
@@ -97,10 +97,7 @@ export async function fileExists(entryPath: string): Promise<boolean> {
       return false;
     }
 
-    throw coverError(
-      `Could not determine if file exists '${entryPath}'`,
-      error,
-    );
+    throw wrapError(`Could not determine if file exists '${entryPath}'`, error);
   }
 }
 
@@ -118,7 +115,7 @@ export async function ensureDirectoryPathExists(
   try {
     return await fs.promises.mkdir(directoryPath, { recursive: true });
   } catch (error) {
-    throw coverError(
+    throw wrapError(
       `Could not create directory path '${directoryPath}'`,
       error,
     );
@@ -136,6 +133,6 @@ export async function removeFile(filePath: string): Promise<void> {
   try {
     return await fs.promises.rm(filePath, { force: true });
   } catch (error) {
-    throw coverError(`Could not remove file '${filePath}'`, error);
+    throw wrapError(`Could not remove file '${filePath}'`, error);
   }
 }

src/misc-utils.test.ts

@@ -4,7 +4,7 @@ import {
   isErrorWithCode,
   isErrorWithMessage,
   isErrorWithStack,
-  coverError,
+  wrapError,
   resolveExecutable,
   getStdoutFromCommand,
   runCommand,
@@ -80,10 +80,10 @@ describe('misc-utils', () => {
     });
   });
 
-  describe('coverError', () => {
+  describe('wrapError', () => {
     it('returns a new Error that links to the given Error', () => {
       const originalError = new Error('oops');
-      const newError = coverError('Some message', originalError);
+      const newError = wrapError('Some message', originalError);
 
       expect(newError.message).toStrictEqual('Some message');
       expect(newError.cause).toBe(originalError);
@@ -92,13 +92,13 @@ describe('misc-utils', () => {
     it('copies over any "code" property that exists on the given Error', () => {
       const originalError: any = new Error('oops');
       originalError.code = 'CODE';
-      const newError: any = coverError('Some message', originalError);
+      const newError: any = wrapError('Some message', originalError);
 
       expect(newError.code).toStrictEqual('CODE');
     });
 
     it('returns a new Error which prefixes the given message', () => {
-      const newError = coverError('Some message', 'Some original message');
+      const newError = wrapError('Some message', 'Some original message');
 
       expect(newError.message).toBe('Some message: Some original message');
       expect(newError.cause).toBeUndefined();

src/misc-utils.ts

@@ -80,7 +80,7 @@ export function isErrorWithStack(error: unknown): error is { stack: string } {
  * something throwable).
  * @returns A new error object.
  */
-export function coverError(message: string, originalError: unknown) {
+export function wrapError(message: string, originalError: unknown) {
   if (isError(originalError)) {
     const error: any = new ErrorWithCause(message, { cause: originalError });
 

src/release-specification.ts

@@ -5,7 +5,7 @@ import { readFile } from './fs';
 import {
   debug,
   hasProperty,
-  coverError,
+  wrapError,
   isObject,
   runCommand,
 } from './misc-utils';
@@ -127,7 +127,7 @@ export async function waitForUserToEditReleaseSpecification(
   stdout.write('\r\u001B[K');
 
   if (caughtError) {
-    throw coverError(
+    throw wrapError(
       'Encountered an error while waiting for the release spec to be edited.',
       caughtError,
     );
@@ -170,7 +170,7 @@ export async function validateReleaseSpecification(
   try {
     unvalidatedReleaseSpecification = YAML.parse(releaseSpecificationContents);
   } catch (error) {
-    throw coverError(
+    throw wrapError(
       [
         'Your release spec does not appear to be valid YAML.',
         afterwordForAllErrorMessages,