refactor: improve utils code (#1153)

* refactor: improve utils code

* refactor: improve code by cr suggest

* test: improve getGistId case

Author: BlackHole1

src/utils/electron-name.ts

@@ -4,11 +4,15 @@
  * @returns {string}
  */
 export function getElectronNameForPlatform(): string {
-  if (process.platform === 'win32') {
-    return 'electron.exe';
-  } else if (process.platform === 'darwin') {
-    return 'Electron.app';
-  } else {
-    return 'electron';
+  switch (process.platform) {
+    case 'win32': {
+      return 'electron.exe';
+    }
+    case 'darwin': {
+      return 'Electron.app';
+    }
+    default: {
+      return 'electron';
+    }
   }
 }

src/utils/exec.ts

@@ -1,7 +1,33 @@
+import { exec as cp_exec } from 'child_process';
+import { promisify } from 'util';
+
 import shellEnv from 'shell-env';
 
-// Singleton: We don't want to do this more than once.
-let _shellPathCalled = false;
+/**
+ * On macOS & Linux, we need to fix the $PATH environment variable
+ * so that we can call `npm`.
+ *
+ * @returns {Promise<void>}
+ */
+export const maybeFixPath = (() => {
+  // Singleton: We don't want to do this more than once.
+  let _shellPathCalled = false;
+
+  return async (): Promise<void> => {
+    if (_shellPathCalled) {
+      return;
+    }
+
+    if (process.platform !== 'win32') {
+      const { PATH } = await shellEnv();
+      if (PATH) {
+        process.env.PATH = PATH;
+      }
+    }
+
+    _shellPathCalled = true;
+  };
+})();
 
 /**
  * Execute a command in a directory.
@@ -11,40 +37,12 @@ let _shellPathCalled = false;
  * @returns {Promise<string>}
  */
 export async function exec(dir: string, cliArgs: string): Promise<string> {
-  return new Promise<string>(async (resolve, reject) => {
-    await maybeFixPath();
-
-    const { exec } = await import('child_process');
-    exec(
-      cliArgs,
-      {
-        cwd: dir,
-        maxBuffer: 200 * 1024 * 100, // 100 times the default
-      },
-      (error, result) => {
-        if (error) {
-          reject(error);
-        }
-
-        resolve(typeof result === 'string' ? result : `${result}`);
-      },
-    );
-  });
-}
+  await maybeFixPath();
 
-/**
- * On macOS & Linux, we need to fix the $PATH environment variable
- * so that we can call `npm`.
- *
- * @returns {Promise<void>}
- */
-export async function maybeFixPath(): Promise<void> {
-  if (!_shellPathCalled && process.platform !== 'win32') {
-    const { PATH } = await shellEnv();
-    if (PATH) {
-      process.env.PATH = PATH;
-    }
-  }
+  const { stdout } = await promisify(cp_exec)(cliArgs, {
+    cwd: dir,
+    maxBuffer: 200 * 1024 * 100, // 100 times the default
+  });
 
-  _shellPathCalled = true;
+  return stdout.trim();
 }

src/utils/get-name.ts

@@ -10,8 +10,8 @@ export async function getName(appState: AppState): Promise<string> {
   if (appState.localPath) {
     const path = await import('path');
     return path.basename(appState.localPath);
-  } else {
-    const namor = await import('namor');
-    return namor.generate({ words: 3, numbers: 0 });
   }
+
+  const namor = await import('namor');
+  return namor.generate({ words: 3, numbers: 0 });
 }

src/utils/get-username.ts

@@ -1,13 +1,19 @@
 import * as os from 'os';
 
-let username = '';
-
 /**
  * Returns the current username
  *
  * @export
  * @returns {string}
  */
-export function getUsername(): string {
-  return (username = username || os.userInfo().username);
-}
+export const getUsername = (() => {
+  let username = '';
+
+  return (): string => {
+    if (!username) {
+      username = os.userInfo().username;
+    }
+
+    return username;
+  };
+})();

src/utils/gist.ts

@@ -13,17 +13,9 @@
  * @returns {(string | null)}
  */
 export function getGistId(rawInput: string): string | null {
-  let input = rawInput.trim();
+  const id = rawInput.trim().match(/[0-9A-Fa-f]{32}/);
 
-  let id = input;
-  if (input.startsWith('https://gist.github.com')) {
-    if (input.endsWith('/')) {
-      input = input.slice(0, -1);
-    }
-    id = input.split('/').pop()!;
-  }
-
-  return id.match(/[0-9A-Fa-f]{32}/) ? id : null;
+  return id?.[0] || null;
 }
 
 /**

src/utils/normalize-version.ts

@@ -7,7 +7,7 @@
 export function normalizeVersion(version = ''): string {
   if (version.startsWith('v')) {
     return version.slice(1);
-  } else {
-    return version;
   }
+
+  return version;
 }

src/utils/position-for-rect.ts

@@ -75,7 +75,7 @@ function isResultOkay(
   input: PositionResult,
   size: { width: number; height: number },
 ): boolean {
-  return !!(
+  return (
     !isTooFarRight(input, size) &&
     !isTooFarLeft(input) &&
     !isTooFarUp(input) &&

tests/utils/exec-spec.ts

@@ -25,7 +25,10 @@ describe('exec', () => {
     it('executes a given string', async () => {
       const cpExec = require('child_process').exec;
       cpExec.mockImplementation((_a: any, _b: any, c: any) =>
-        c(null, Buffer.from('hi')),
+        c(null, {
+          stdout: 'hi',
+          stderr: '',
+        }),
       );
 
       const result = await execModule.exec('a/dir', 'echo hi');
@@ -38,7 +41,12 @@ describe('exec', () => {
 
     it('handles a returned string', async () => {
       const cpExec = require('child_process').exec;
-      cpExec.mockImplementation((_a: any, _b: any, c: any) => c(null, 'hi'));
+      cpExec.mockImplementation((_a: any, _b: any, c: any) =>
+        c(null, {
+          stdout: 'hi',
+          stderr: '',
+        }),
+      );
 
       const result = await execModule.exec('a/dir', 'echo hi');
       expect(result).toBe('hi');

tests/utils/gist-spec.ts

@@ -82,5 +82,10 @@ describe('gist', () => {
       const actual = getGistId(input);
       expect(actual).toBe(expected);
     });
+
+    it('should return null when gist id incorrect', () => {
+      const actual = getGistId('xx');
+      expect(actual).toBe(null);
+    });
   });
 });