refactor: commands throw errors instead of calling logError

src/commands/apis.ts

@@ -8,7 +8,7 @@ import {enableOrDisableAPI} from '../apiutils';
 import {discovery, loadAPICredentials, serviceUsage} from '../auth';
 import {ERROR} from '../messages';
 import {URL} from '../urls';
-import {checkIfOnline, getProjectId, logError} from '../utils';
+import {checkIfOnline, getProjectId} from '../utils';
 import {ReadonlyDeep} from 'type-fest';
 
 interface CommandOption {
@@ -119,6 +119,6 @@ export default async (options: CommandOption): Promise<void> => {
   if (command[subcommand]) {
     command[subcommand]();
   } else {
-    logError(ERROR.COMMAND_DNE(`apis ${subcommand}`));
+    throw new Error(ERROR.COMMAND_DNE(`apis ${subcommand}`));
   }
 };

src/commands/clone.ts

@@ -26,15 +26,15 @@ export default async (
   options: CommandOption
 ): Promise<void> => {
   await checkIfOnline();
-  if (hasProject()) logError(ERROR.FOLDER_EXISTS);
+  if (hasProject()) throw new Error(ERROR.FOLDER_EXISTS);
   scriptId = scriptId ? extractScriptId(scriptId) : await getScriptId();
   spinner.setSpinnerTitle(LOG.CLONING);
   const {rootDir} = options;
   await saveProject({scriptId, rootDir}, false);
   const files = await fetchProject(scriptId, versionNumber);
   await writeProjectFiles(files, rootDir);
   await status();
-  if (spinner.isSpinning()) spinner.stop(true);
+  // if (spinner.isSpinning()) spinner.stop(true);
 };
 
 /**

src/commands/create.ts

@@ -10,7 +10,6 @@ import {
   getDefaultProjectName,
   getDescriptionFrom,
   getProjectSettings,
-  logError,
   saveProject,
   spinner,
 } from '../utils';
@@ -33,7 +32,7 @@ interface CommandOption {
 export default async (options: CommandOption): Promise<void> => {
   // Handle common errors.
   await checkIfOnline();
-  if (hasProject()) logError(ERROR.FOLDER_EXISTS);
+  if (hasProject()) throw new Error(ERROR.FOLDER_EXISTS);
   await loadAPICredentials();
 
   // Create defaults.
@@ -69,13 +68,15 @@ export default async (options: CommandOption): Promise<void> => {
 
   // CLI Spinner
   spinner.setSpinnerTitle(LOG.CREATE_PROJECT_START(title)).start();
-  try {
-    const {scriptId} = await getProjectSettings(true);
-    if (scriptId) logError(ERROR.NO_NESTED_PROJECTS);
-  } catch {
-    // No scriptId (because project doesn't exist)
-    // console.log(error);
-  }
+  // try {
+  //   const {scriptId} = await getProjectSettings(true);
+  //   if (scriptId) throw new Error(ERROR.NO_NESTED_PROJECTS);
+  // } catch {
+  //   // No scriptId (because project doesn't exist)
+  //   // console.log(error);
+  // }
+  const {scriptId} = await getProjectSettings(true);
+  if (scriptId) throw new Error(ERROR.NO_NESTED_PROJECTS);
 
   // Create a new Apps Script project
   const response = await script.projects.create({
@@ -87,7 +88,7 @@ export default async (options: CommandOption): Promise<void> => {
   if (spinner.isSpinning()) spinner.stop(true);
   if (response.status !== 200) {
     if (parentId) console.log(response.statusText, ERROR.CREATE_WITH_PARENT);
-    logError(getDescriptionFrom(response.statusText) ?? ERROR.CREATE);
+    throw new Error(getDescriptionFrom(response.statusText) ?? ERROR.CREATE);
   }
 
   const createdScriptId = response.data.scriptId ?? '';

src/commands/default.ts

@@ -3,12 +3,11 @@ import {Command} from 'commander';
 import {ReadonlyDeep} from 'type-fest';
 
 import {ERROR} from '../messages';
-import {logError} from '../utils';
 
 /**
  * Displays a default message when an unknown command is typed.
  * @param command {string} The command that was typed.
  */
 export default async (_: ReadonlyDeep<Command>, command: string): Promise<void> => {
-  logError(ERROR.COMMAND_DNE(command));
+  throw new Error(ERROR.COMMAND_DNE(command));
 };

src/commands/deploy.ts

@@ -2,7 +2,7 @@
 import {loadAPICredentials, script} from '../auth';
 import {PROJECT_MANIFEST_BASENAME} from '../constants';
 import {ERROR, LOG} from '../messages';
-import {checkIfOnline, getProjectSettings, logError, spinner} from '../utils';
+import {checkIfOnline, getProjectSettings, spinner} from '../utils';
 
 interface CommandOption {
   readonly versionNumber?: number;
@@ -33,8 +33,8 @@ export default async (options: CommandOption): Promise<void> => {
         description,
       },
     });
+    if (version.status !== 200) throw new Error(ERROR.ONE_DEPLOYMENT_CREATE);
     if (spinner.isSpinning()) spinner.stop(true);
-    if (version.status !== 200) logError(ERROR.ONE_DEPLOYMENT_CREATE);
     versionNumber = version.data.versionNumber ?? 0;
     console.log(LOG.VERSION_CREATED(versionNumber));
   }
@@ -66,7 +66,7 @@ export default async (options: CommandOption): Promise<void> => {
     });
   }
 
+  if (deployments.status !== 200) throw new Error(ERROR.DEPLOYMENT_COUNT);
   if (spinner.isSpinning()) spinner.stop(true);
-  if (deployments.status !== 200) logError(ERROR.DEPLOYMENT_COUNT);
   console.log(`- ${deployments.data.deploymentId} @${versionNumber}.`);
 };

src/commands/deployments.ts

@@ -3,7 +3,7 @@ import {script_v1 as scriptV1} from 'googleapis';
 
 import {loadAPICredentials, script} from '../auth';
 import {LOG} from '../messages';
-import {checkIfOnline, getProjectSettings, logError, spinner} from '../utils';
+import {checkIfOnline, getProjectSettings, spinner} from '../utils';
 
 /**
  * Lists a script's deployments.
@@ -18,7 +18,7 @@ export default async (): Promise<void> => {
     scriptId,
   });
   if (spinner.isSpinning()) spinner.stop(true);
-  if (deployments.status !== 200) logError(deployments.statusText);
+  if (deployments.status !== 200) throw new Error(deployments.statusText);
   const deploymentsList = deployments.data.deployments ?? [];
   const deploymentCount = deploymentsList.length;
   const deploymentWord = deploymentCount === 1 ? 'Deployment' : 'Deployments';

src/commands/list.ts

@@ -4,7 +4,7 @@ import {drive_v3 as driveV3} from 'googleapis';
 import {drive, loadAPICredentials} from '../auth';
 import {ERROR, LOG} from '../messages';
 import {URL} from '../urls';
-import {checkIfOnline, logError, spinner, ellipsize} from '../utils';
+import {checkIfOnline, spinner, ellipsize} from '../utils';
 
 /**
  * Lists a user's Apps Script projects using Google Drive.
@@ -20,8 +20,8 @@ export default async (): Promise<void> => {
     // fields: 'nextPageToken, files(id, name)',
     q: 'mimeType="application/vnd.google-apps.script"',
   });
+  if (filesList.status !== 200) throw new Error(ERROR.DRIVE);
   if (spinner.isSpinning()) spinner.stop(true);
-  if (filesList.status !== 200) logError(ERROR.DRIVE);
   const files = filesList.data.files ?? [];
   if (files.length === 0) {
     console.log(LOG.FINDING_SCRIPTS_DNE);

src/commands/open.ts

@@ -6,7 +6,7 @@ import {loadAPICredentials, script} from '../auth';
 import {deploymentIdPrompt} from '../inquirer';
 import {ERROR, LOG} from '../messages';
 import {URL} from '../urls';
-import {ellipsize, getDescriptionFrom, getProjectSettings, getWebApplicationURL, logError} from '../utils';
+import {ellipsize, getDescriptionFrom, getProjectSettings, getWebApplicationURL} from '../utils';
 
 interface CommandOption {
   readonly webapp?: boolean;
@@ -23,7 +23,7 @@ interface CommandOption {
 export default async (scriptId: string, options: CommandOption): Promise<void> => {
   const projectSettings = await getProjectSettings();
   if (!scriptId) scriptId = projectSettings.scriptId;
-  if (scriptId.length < 30) logError(ERROR.SCRIPT_ID_INCORRECT(scriptId));
+  if (scriptId.length < 30) throw new Error(ERROR.SCRIPT_ID_INCORRECT(scriptId));
   // We've specified to open creds.
   if (options.creds) {
     const {projectId} = projectSettings;
@@ -33,7 +33,7 @@ export default async (scriptId: string, options: CommandOption): Promise<void> =
       return;
     }
 
-    logError(ERROR.NO_GCLOUD_PROJECT);
+    throw new Error(ERROR.NO_GCLOUD_PROJECT);
   }
 
   // We've specified to print addons and open the first one.
@@ -51,7 +51,7 @@ export default async (scriptId: string, options: CommandOption): Promise<void> =
       return;
     }
 
-    logError(ERROR.NO_PARENT_ID);
+    throw new Error(ERROR.NO_PARENT_ID);
   }
 
   // If we're not a web app, open the script URL.
@@ -64,9 +64,9 @@ export default async (scriptId: string, options: CommandOption): Promise<void> =
   // Web app: Otherwise, open the latest deployment.
   await loadAPICredentials();
   const deploymentsList = await script.projects.deployments.list({scriptId});
-  if (deploymentsList.status !== 200) logError(getDescriptionFrom(deploymentsList.statusText));
+  if (deploymentsList.status !== 200) throw new Error(getDescriptionFrom(deploymentsList.statusText));
   const deployments: Array<Readonly<scriptV1.Schema$Deployment>> = deploymentsList.data.deployments ?? [];
-  if (deployments.length === 0) logError(ERROR.SCRIPT_ID_INCORRECT(scriptId));
+  if (deployments.length === 0) throw new Error(ERROR.SCRIPT_ID_INCORRECT(scriptId));
   // Order deployments by update time.
   const choices = deployments
     .slice()
@@ -100,6 +100,6 @@ export default async (scriptId: string, options: CommandOption): Promise<void> =
   if (target) {
     await open(target, {wait: false});
   } else {
-    logError(`Could not open deployment: ${JSON.stringify(deployment)}`);
+    throw new Error(`Could not open deployment: ${JSON.stringify(deployment)}`);
   }
 };

src/commands/pull.ts

@@ -18,6 +18,6 @@ export default async (options: CommandOption): Promise<void> => {
     spinner.setSpinnerTitle(LOG.PULLING);
     const files = await fetchProject(scriptId, options.versionNumber);
     await writeProjectFiles(files, rootDir);
-    if (spinner.isSpinning()) spinner.stop(true);
+    // if (spinner.isSpinning()) spinner.stop(true);
   }
 };

src/commands/push.ts

@@ -63,7 +63,7 @@ export default async (options: CommandOption): Promise<void> => {
 
     spinner.setSpinnerTitle(LOG.PUSHING).start();
     await pushFiles();
-    if (spinner.isSpinning()) spinner.stop(true);
+    // if (spinner.isSpinning()) spinner.stop(true);
   }
 };
 

src/commands/setting.ts

@@ -1,7 +1,7 @@
 /* eslint-disable new-cap */
 import {ProjectSettings} from '../dotfile';
 import {ERROR} from '../messages';
-import {getProjectSettings, logError, saveProject} from '../utils';
+import {getProjectSettings, saveProject} from '../utils';
 
 /**
  * Gets or sets a setting in .clasp.json
@@ -30,7 +30,7 @@ export default async (settingKey?: keyof ProjectSettings, settingValue?: string)
       // Which interfers with storing the value
       process.stdout.write(keyValue);
     } else {
-      logError(ERROR.UNKNOWN_KEY(settingKey));
+      throw new Error(ERROR.UNKNOWN_KEY(settingKey));
     }
   } else {
     try {
@@ -50,14 +50,15 @@ export default async (settingKey?: keyof ProjectSettings, settingValue?: string)
           currentSettings.fileExtension = settingValue;
           break;
         default:
-          logError(ERROR.UNKNOWN_KEY(settingKey));
+          throw new Error(ERROR.UNKNOWN_KEY(settingKey));
       }
       // filePushOrder doesn't work since it requires an array.
       // const filePushOrder = settingKey === 'filePushOrder' ? settingValue : currentSettings.filePushOrder;
       await saveProject(currentSettings, true);
       console.log(`Updated "${settingKey}": "${currentValue}" → "${settingValue}"`);
     } catch (error) {
-      logError('Unable to update .clasp.json');
+      if (error instanceof Error) throw error;
+      throw new Error('Unable to update .clasp.json');
     }
   }
 };

src/commands/undeploy.ts

@@ -1,7 +1,7 @@
 /* eslint-disable new-cap */
 import {loadAPICredentials, script} from '../auth';
 import {ERROR, LOG} from '../messages';
-import {checkIfOnline, getDescriptionFrom, getProjectSettings, logError, spinner} from '../utils';
+import {checkIfOnline, getDescriptionFrom, getProjectSettings, spinner} from '../utils';
 
 interface CommandOption {
   readonly all?: boolean;
@@ -19,18 +19,18 @@ export default async (deploymentId: string | undefined, options: CommandOption):
 
   if (options.all) {
     const deploymentsList = await script.projects.deployments.list({scriptId});
-    if (deploymentsList.status !== 200) logError(getDescriptionFrom(deploymentsList.statusText));
+    if (deploymentsList.status !== 200) throw new Error(getDescriptionFrom(deploymentsList.statusText));
 
     const deployments = deploymentsList.data.deployments ?? [];
-    if (deployments.length === 0) logError(ERROR.SCRIPT_ID_INCORRECT(scriptId));
+    if (deployments.length === 0) throw new Error(ERROR.SCRIPT_ID_INCORRECT(scriptId));
 
     deployments.shift(); // @HEAD (Read-only deployments) may not be deleted.
     for (const deployment of deployments) {
       const id = deployment.deploymentId ?? '';
       spinner.setSpinnerTitle(LOG.UNDEPLOYMENT_START(id)).start();
       const result = await script.projects.deployments.delete({scriptId, deploymentId: id});
 
-      if (result.status !== 200) logError(ERROR.READ_ONLY_DELETE);
+      if (result.status !== 200) throw new Error(ERROR.READ_ONLY_DELETE);
 
       if (spinner.isSpinning()) spinner.stop(true);
       console.log(LOG.UNDEPLOYMENT_FINISH(id));
@@ -41,13 +41,13 @@ export default async (deploymentId: string | undefined, options: CommandOption):
 
   if (!deploymentId) {
     const deploymentsList = await script.projects.deployments.list({scriptId});
-    if (deploymentsList.status !== 200) logError(getDescriptionFrom(deploymentsList.statusText));
+    if (deploymentsList.status !== 200) throw new Error(getDescriptionFrom(deploymentsList.statusText));
 
     const deployments = deploymentsList.data.deployments ?? [];
-    if (deployments.length === 0) logError(ERROR.SCRIPT_ID_INCORRECT(scriptId));
+    if (deployments.length === 0) throw new Error(ERROR.SCRIPT_ID_INCORRECT(scriptId));
 
     // @HEAD (Read-only deployments) may not be deleted.
-    if (deployments.length <= 1) logError(ERROR.SCRIPT_ID_INCORRECT(scriptId));
+    if (deployments.length <= 1) throw new Error(ERROR.SCRIPT_ID_INCORRECT(scriptId));
 
     deploymentId = deployments[deployments.length - 1].deploymentId ?? '';
   }
@@ -60,6 +60,6 @@ export default async (deploymentId: string | undefined, options: CommandOption):
     if (spinner.isSpinning()) spinner.stop(true);
     console.log(LOG.UNDEPLOYMENT_FINISH(deploymentId));
   } else {
-    logError(ERROR.READ_ONLY_DELETE);
+    throw new Error(ERROR.READ_ONLY_DELETE);
   }
 };

src/commands/version.ts

@@ -2,7 +2,7 @@
 import {loadAPICredentials, script} from '../auth';
 import {descriptionPrompt} from '../inquirer';
 import {LOG} from '../messages';
-import {checkIfOnline, getDescriptionFrom, getProjectSettings, logError, spinner} from '../utils';
+import {checkIfOnline, getDescriptionFrom, getProjectSettings, spinner} from '../utils';
 
 /**
  * Creates a new version of an Apps Script project.
@@ -23,10 +23,10 @@ export default async (description?: string): Promise<void> => {
       description,
     },
   });
-  if (spinner.isSpinning()) spinner.stop(true);
   if (versions.status === 200) {
+    if (spinner.isSpinning()) spinner.stop(true);
     console.log(LOG.VERSION_CREATED(versions.data.versionNumber ?? -1));
   } else {
-    logError(getDescriptionFrom(versions.statusText));
+    throw new Error(getDescriptionFrom(versions.statusText));
   }
 };

src/commands/versions.ts

@@ -3,7 +3,7 @@ import {script_v1 as scriptV1} from 'googleapis';
 
 import {loadAPICredentials, script} from '../auth';
 import {LOG} from '../messages';
-import {checkIfOnline, getDescriptionFrom, getProjectSettings, logError, spinner} from '../utils';
+import {checkIfOnline, getDescriptionFrom, getProjectSettings, spinner} from '../utils';
 
 /**
  * Lists versions of an Apps Script project.
@@ -42,9 +42,9 @@ export default async (): Promise<void> => {
         console.log(LOG.VERSION_DESCRIPTION(version));
       });
     } else {
-      logError(LOG.DEPLOYMENT_DNE);
+      throw new Error(LOG.DEPLOYMENT_DNE);
     }
   } else {
-    logError(getDescriptionFrom(response.statusText));
+    throw new Error(getDescriptionFrom(response.statusText));
   }
 };