feat: Added utils for managing different environments. Updated spawn to handle additional shells

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.180",
+  "version": "1.0.181",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -10,42 +10,47 @@
     "posttest": "tsc",
     "prepublishOnly": "tsc"
   },
+  "bin": {
+    "codify-deploy": "./dist/bin/deploy-plugin.js"
+  },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@homebridge/node-pty-prebuilt-multiarch": "^0.13.1",
+    "@npmcli/promise-spawn": "^7.0.1",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
+    "clean-deep": "^3.4.0",
     "codify-schemas": "1.0.83",
-    "@npmcli/promise-spawn": "^7.0.1",
-    "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
-    "uuid": "^10.0.0",
     "lodash.isequal": "^4.5.0",
     "nanoid": "^5.0.9",
     "strip-ansi": "^7.1.0",
-    "clean-deep": "^3.4.0"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
+    "@apidevtools/json-schema-ref-parser": "^11.7.2",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3",
-    "@types/npmcli__promise-spawn": "^6.0.3",
+    "@types/lodash.isequal": "^4.5.8",
     "@types/node": "^20",
+    "@types/npmcli__promise-spawn": "^6.0.3",
     "@types/semver": "^7.5.4",
     "@types/sinon": "^17.0.3",
     "@types/uuid": "^10.0.0",
-    "@types/lodash.isequal": "^4.5.8",
     "chai-as-promised": "^7.1.1",
-    "vitest": "^3.0.5",
-    "vitest-mock-extended": "^1.3.1",
-    "sinon": "^17.0.1",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",
     "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.0.0",
+    "merge-json-schemas": "^1.0.0",
     "shx": "^0.3.3",
+    "sinon": "^17.0.1",
     "ts-node": "^10.9.1",
     "tsc-watch": "^6.0.4",
     "typescript": "^5",
-    "eslint-config-prettier": "^9.0.0"
+    "vitest": "^3.0.5",
+    "vitest-mock-extended": "^1.3.1"
   },
   "engines": {
     "node": ">=18.0.0"

package.json

@@ -12,7 +12,7 @@ export * from './resource/parsed-resource-settings.js';
 export * from './resource/resource.js'
 export * from './resource/resource-settings.js'
 export * from './stateful-parameter/stateful-parameter.js'
-export * from './utils/utils.js'
+export * from './utils/index.js'
 
 export async function runPlugin(plugin: Plugin) {
   const messageHandler = new MessageHandler(plugin);

src/index.ts

@@ -24,7 +24,7 @@ import { getPty } from '../pty/index.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
-import { VerbosityLevel } from '../utils/utils.js';
+import { VerbosityLevel } from '../utils/internal-utils.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<any>>;

src/plugin/plugin.ts

@@ -6,7 +6,8 @@ import * as fs from 'node:fs/promises';
 import stripAnsi from 'strip-ansi';
 
 import { debugLog } from '../utils/debug.js';
-import { VerbosityLevel } from '../utils/utils.js';
+import { Shell, Utils } from '../utils/index.js';
+import { VerbosityLevel } from '../utils/internal-utils.js';
 import { IPty, SpawnError, SpawnOptions, SpawnResult } from './index.js';
 import { PromiseQueue } from './promise-queue.js';
 
@@ -19,7 +20,7 @@ EventEmitter.defaultMaxListeners = 1000;
  * without a tty (or even a stdin) attached so interactive commands will not work.
  */
 export class BackgroundPty implements IPty {
-  private basePty = pty.spawn('zsh', ['-i'], {
+  private basePty = pty.spawn(this.getDefaultShell(), ['-i'], {
     env: process.env, name: nanoid(6),
     handleFlowControl: true
   });
@@ -127,7 +128,19 @@ export class BackgroundPty implements IPty {
       let outputBuffer = '';
 
       return new Promise(resolve => {
-        this.basePty.write('setopt hist_ignore_space;\n');
+        // zsh-specific commands
+        switch (Utils.getShell()) {
+          case Shell.ZSH: {
+            this.basePty.write('setopt HIST_NO_STORE;\n');
+            break;
+          }
+
+          default: {
+            this.basePty.write('export HISTIGNORE=\'history*\';\n');
+            break;
+          }
+        }
+
         this.basePty.write(' unset PS1;\n');
         this.basePty.write(' unset PS0;\n')
         this.basePty.write(' echo setup complete\\"\n')
@@ -142,4 +155,8 @@ export class BackgroundPty implements IPty {
       })
     })
   }
+
+  private getDefaultShell(): string {
+    return process.env.SHELL!;
+  }
 }

src/pty/background-pty.ts

@@ -7,7 +7,7 @@ import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
 import { ParameterChange } from '../plan/change-set.js';
 import { ResourceController } from './resource-controller.js';
 import { TestConfig, testPlan, TestResource, TestStatefulParameter } from '../utils/test-utils.test.js';
-import { tildify, untildify } from '../utils/utils.js';
+import { tildify, untildify } from '../utils/internal-utils.js';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { Plan } from '../plan/plan.js';
 import os from 'node:os';

src/resource/resource-controller.test.ts

@@ -4,7 +4,13 @@ import isObjectsEqual from 'lodash.isequal'
 import path from 'node:path';
 
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
-import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
+import {
+  addVariablesToPath,
+  areArraysEqual,
+  resolvePathWithVariables,
+  tildify,
+  untildify
+} from '../utils/internal-utils.js';
 import { RefreshContext } from './resource.js';
 
 export interface InputTransformation {
@@ -350,8 +356,9 @@ const ParameterEqualsDefaults: Partial<Record<ParameterSettingType, (a: unknown,
       transformedB = path.resolve(transformedB)
     }
 
-    const notCaseSensitive = process.platform === 'darwin';
-    if (notCaseSensitive) {
+    // macOS has case-insensitive filesystem by default, Linux is case-sensitive
+    const isCaseSensitive = process.platform === 'linux';
+    if (!isCaseSensitive) {
       transformedA = transformedA.toLowerCase();
       transformedB = transformedB.toLowerCase();
     }

src/resource/resource-settings.ts

@@ -0,0 +1,139 @@
+import os from 'node:os';
+import path from 'node:path';
+
+export enum Shell {
+  ZSH = 'zsh',
+  BASH = 'bash',
+  SH = 'sh',
+  KSH = 'ksh',
+  CSH = 'csh',
+  FISH = 'fish',
+}
+
+export interface SystemInfo {
+  os: 'Darwin' | 'Linux' | 'Windows_NT';
+  shell: Shell;
+}
+
+export const Utils = {
+  getUser(): string {
+    return os.userInfo().username;
+  },
+
+  getSystemInfo() {
+    return {
+      os: os.type(),
+      shell: this.getShell(),
+    }
+  },
+
+  isMacOS(): boolean {
+    return os.platform() === 'darwin';
+  },
+
+  isLinux(): boolean {
+    return os.platform() === 'linux';
+  },
+
+  getShell(): Shell | undefined {
+    const shell = process.env.SHELL || '';
+
+    if (shell.endsWith('bash')) {
+      return Shell.BASH
+    }
+
+    if (shell.endsWith('zsh')) {
+      return Shell.ZSH
+    }
+
+    if (shell.endsWith('sh')) {
+      return Shell.SH
+    }
+
+    if (shell.endsWith('csh')) {
+      return Shell.CSH
+    }
+
+    if (shell.endsWith('ksh')) {
+      return Shell.KSH
+    }
+
+    if (shell.endsWith('fish')) {
+      return Shell.FISH
+    }
+
+    return undefined;
+  },
+
+
+  getPrimaryShellRc(): string {
+    return this.getShellRcFiles()[0];
+  },
+
+  getShellRcFiles(): string[] {
+    const shell = process.env.SHELL || '';
+    const homeDir = os.homedir();
+
+    if (shell.endsWith('bash')) {
+      // Linux typically uses .bashrc, macOS uses .bash_profile
+      if (Utils.isLinux()) {
+        return [
+          path.join(homeDir, '.bashrc'),
+          path.join(homeDir, '.bash_profile'),
+          path.join(homeDir, '.profile'),
+        ];
+      }
+
+      return [
+        path.join(homeDir, '.bash_profile'),
+        path.join(homeDir, '.bashrc'),
+        path.join(homeDir, '.profile'),
+      ];
+    }
+
+    if (shell.endsWith('zsh')) {
+      return [
+        path.join(homeDir, '.zshrc'),
+        path.join(homeDir, '.zprofile'),
+        path.join(homeDir, '.zshenv'),
+      ];
+    }
+
+    if (shell.endsWith('sh')) {
+      return [
+        path.join(homeDir, '.profile'),
+      ]
+    }
+
+    if (shell.endsWith('ksh')) {
+      return [
+        path.join(homeDir, '.profile'),
+        path.join(homeDir, '.kshrc'),
+      ]
+    }
+
+    if (shell.endsWith('csh')) {
+      return [
+        path.join(homeDir, '.cshrc'),
+        path.join(homeDir, '.login'),
+        path.join(homeDir, '.logout'),
+      ]
+    }
+
+    if (shell.endsWith('fish')) {
+      return [
+        path.join(homeDir, '.config/fish/config.fish'),
+      ]
+    }
+
+    // Default to bash-style files
+    return [
+      path.join(homeDir, '.bashrc'),
+      path.join(homeDir, '.bash_profile'),
+      path.join(homeDir, '.profile'),
+    ];
+  },
+};
+
+
+

src/utils/index.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { addVariablesToPath, resolvePathWithVariables, splitUserConfig } from './utils.js';
+import { addVariablesToPath, resolvePathWithVariables, splitUserConfig } from './internal-utils.js';
 import os from 'node:os';
 
 describe('Utils tests', () => {