feat: Added addiitonal utils

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.182-beta10",
+  "version": "1.0.182-beta26",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -22,7 +22,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "clean-deep": "^3.4.0",
-    "codify-schemas": "1.0.86-beta5",
+    "codify-schemas": "1.0.86-beta7",
     "lodash.isequal": "^4.5.0",
     "nanoid": "^5.0.9",
     "strip-ansi": "^7.1.0",

package.json

@@ -25,7 +25,7 @@ export class FileUtils {
     console.log(`Finished downloading to ${destination}`);
   }
 
-  static async addToStartupFile(line: string): Promise<void> {
+  static async addToShellRc(line: string): Promise<void> {
     const lineToInsert = addLeadingSpacer(
       addTrailingSpacer(line)
     );
@@ -45,7 +45,7 @@ export class FileUtils {
     }
   }
 
-  static async addAllToStartupFile(lines: string[]): Promise<void> {
+  static async addAllToShellRc(lines: string[]): Promise<void> {
     const formattedLines = '\n' + lines.join('\n') + '\n';
     const shellRc = Utils.getPrimaryShellRc();
 
@@ -55,7 +55,17 @@ ${lines.join('\n')}`)
     await fs.appendFile(shellRc, formattedLines)
   }
 
-  static async addPathToPrimaryShellRc(value: string, prepend: boolean): Promise<void> {
+  /**
+   * This method adds a directory path to the shell rc file if it doesn't already exist.
+   *
+   * @param value - The directory path to add.
+   * @param prepend - Whether to prepend the path to the existing PATH variable.
+   */
+  static async addPathToShellRc(value: string, prepend: boolean): Promise<void> {
+    if (await Utils.isDirectoryOnPath(value)) {
+      return;
+    }
+
     const shellRc = Utils.getPrimaryShellRc();
     console.log(`Saving path: ${value} to ${shellRc}`);
 
@@ -67,64 +77,13 @@ ${lines.join('\n')}`)
     await fs.appendFile(shellRc, `\nexport PATH=${value}:$PATH;`, { encoding: 'utf8' });
   }
 
-  static async dirExists(path: string): Promise<boolean> {
-    let stat;
-    try {
-      stat = await fs.stat(path);
-      return stat.isDirectory();
-    } catch {
-      return false;
-    }
-  }
-
-  static async fileExists(path: string): Promise<boolean> {
-    let stat;
-    try {
-      stat = await fs.stat(path);
-      return stat.isFile();
-    } catch {
-      return false;
-    }
-  }
-
-  static async exists(path: string): Promise<boolean> {
-    try {
-      await fs.stat(path);
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  static async checkDirExistsOrThrowIfFile(path: string): Promise<boolean> {
-    let stat;
-    try {
-      stat = await fs.stat(path);
-    } catch {
-      return false;
-    }
-
-    if (stat.isDirectory()) {
-      return true;
-    }
-
-    throw new Error(`Directory ${path} already exists and is a file`);
-  }
-
-  static async createDirIfNotExists(path: string): Promise<void> {
-    if (!fsSync.existsSync(path)) {
-      await fs.mkdir(path, { recursive: true });
-    }
-  }
-
   static async removeFromFile(filePath: string, search: string): Promise<void> {
     const contents = await fs.readFile(filePath, 'utf8');
     const newContents = contents.replaceAll(search, '');
 
     await fs.writeFile(filePath, newContents, 'utf8');
   }
 
-
   static async removeLineFromFile(filePath: string, search: RegExp | string): Promise<void> {
     const file = await fs.readFile(filePath, 'utf8')
     const lines = file.split('\n');
@@ -168,10 +127,16 @@ ${lines.join('\n')}`)
     console.log(`Removed line: ${search} from ${filePath}`)
   }
 
-  static async removeLineFromPrimaryShellRc(search: RegExp | string): Promise<void> {
+  static async removeLineFromShellRc(search: RegExp | string): Promise<void> {
     return FileUtils.removeLineFromFile(Utils.getPrimaryShellRc(), search);
   }
 
+  static async removeAllLinesFromShellRc(searches: Array<RegExp | string>): Promise<void> {
+    for (const search of searches) {
+      await FileUtils.removeLineFromFile(Utils.getPrimaryShellRc(), search);
+    }
+  }
+
   // Append the string to the end of a file ensuring at least 1 lines of space between.
   // Ex result:
   // something something;
@@ -190,6 +155,56 @@ ${lines.join('\n')}`)
     return lines.join('\n') + '\n'.repeat(numNewLines) + textToInsert
   }
 
+  static async dirExists(path: string): Promise<boolean> {
+    let stat;
+    try {
+      stat = await fs.stat(path);
+      return stat.isDirectory();
+    } catch {
+      return false;
+    }
+  }
+
+  static async fileExists(path: string): Promise<boolean> {
+    let stat;
+    try {
+      stat = await fs.stat(path);
+      return stat.isFile();
+    } catch {
+      return false;
+    }
+  }
+
+  static async exists(path: string): Promise<boolean> {
+    try {
+      await fs.stat(path);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+
+  static async checkDirExistsOrThrowIfFile(path: string): Promise<boolean> {
+    let stat;
+    try {
+      stat = await fs.stat(path);
+    } catch {
+      return false;
+    }
+
+    if (stat.isDirectory()) {
+      return true;
+    }
+
+    throw new Error(`Directory ${path} already exists and is a file`);
+  }
+
+  static async createDirIfNotExists(path: string): Promise<void> {
+    if (!fsSync.existsSync(path)) {
+      await fs.mkdir(path, { recursive: true });
+    }
+  }
+
   // This is overly complicated but it can be used to insert into any
   // position in the future
   private static calculateEndingNewLines(lines: string[]): number {

src/utils/file-utils.ts

@@ -9,10 +9,11 @@ export function splitUserConfig<T extends StringIndexedObject>(
     type: config.type,
     ...(config.name ? { name: config.name } : {}),
     ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
+    ...(config.os ? { os: config.os } : {}),
   };
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const { type, name, dependsOn, ...parameters } = config;
+  const { type, name, dependsOn, os, ...parameters } = config;
 
   return {
     parameters: parameters as T,
@@ -35,8 +36,7 @@ export function tildify(pathWithTilde: string) {
 }
 
 export function resolvePathWithVariables(pathWithVariables: string) {
-  // @ts-expect-error Ignore this for now
-  return pathWithVariables.replace(/\$([A-Z_]+[A-Z0-9_]*)|\${([A-Z0-9_]*)}/ig, (_, a, b) => process.env[a || b])
+  return pathWithVariables.replaceAll(/\$([A-Z_]+[A-Z0-9_]*)|\${([A-Z0-9_]*)}/ig, (_, a, b) => process.env[a || b])
 }
 
 export function addVariablesToPath(pathWithoutVariables: string) {

src/utils/functions.ts

@@ -2,6 +2,8 @@ import { OS } from 'codify-schemas';
 import os from 'node:os';
 import path from 'node:path';
 
+import { getPty, SpawnStatus } from '../pty/index.js';
+
 export function isDebug(): boolean {
   return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }
@@ -40,6 +42,34 @@ export const Utils = {
     return os.platform() === 'linux';
   },
 
+  async isArmArch(): Promise<boolean> {
+    const $ = getPty();
+    if (!Utils.isMacOS()) {
+      // On Linux, check uname -m
+      const query = await $.spawn('uname -m');
+      return query.data.trim() === 'aarch64' || query.data.trim() === 'arm64';
+    }
+
+    const query = await $.spawn('sysctl -n machdep.cpu.brand_string');
+    return /M(\d)/.test(query.data);
+  },
+
+  async isHomebrewInstalled(): Promise<boolean> {
+    const $ = getPty();
+    const query = await $.spawnSafe('which brew', { interactive: true });
+    return query.status === SpawnStatus.SUCCESS;
+  },
+
+  async isRosetta2Installed(): Promise<boolean> {
+    if (!Utils.isMacOS()) {
+      return false;
+    }
+
+    const $ = getPty();
+    const query = await $.spawnSafe('arch -x86_64 /usr/bin/true 2> /dev/null', { interactive: true });
+    return query.status === SpawnStatus.SUCCESS;
+  },
+
   getShell(): Shell | undefined {
     const shell = process.env.SHELL || '';
 
@@ -138,6 +168,13 @@ export const Utils = {
       path.join(homeDir, '.profile'),
     ];
   },
+
+  async isDirectoryOnPath(directory: string): Promise<boolean> {
+    const $ = getPty();
+    const { data: pathQuery } = await $.spawn('echo $PATH', { interactive: true });
+    const lines = pathQuery.split(':');
+    return lines.includes(directory);
+  },
 };
 
 

src/utils/index.ts

@@ -8,6 +8,7 @@ describe('Utils tests', () => {
       type: 'type',
       name: 'name',
       dependsOn: ['a', 'b', 'c'],
+      os: ['linux'],
       propA: 'propA',
       propB: 'propB',
       propC: 'propC',