codify-plugin-lib 1.0.181 → 1.0.182-beta10

package/src/resource/resource-settings.test.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import { Plan } from '../plan/plan.js';
 import { spy } from 'sinon';
-import { ParameterOperation, ResourceOperation } from 'codify-schemas';
+import { OS, ParameterOperation, ResourceOperation } from 'codify-schemas';
 import {
   TestArrayStatefulParameter,
   TestConfig,
@@ -26,6 +26,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameter }
           },
@@ -71,6 +72,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy }
           },
@@ -105,6 +107,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy },
             propB: { canModify: true },
@@ -137,7 +140,8 @@ describe('Resource parameter tests', () => {
     const statefulParameter = spy(new class extends TestStatefulParameter {
       getSettings(): ParameterSetting {
         return {
-          default: 'abc'
+          default: 'abc',
+          operatingSystems: [OS.Darwin],
         };
       }
 
@@ -150,6 +154,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameter }
           },
@@ -191,6 +196,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy },
           },
@@ -225,6 +231,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy }
           },
@@ -251,6 +258,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             hosts: {
               type: 'array',
@@ -360,6 +368,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy }
           },
@@ -416,6 +425,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterA, order: 3 },
             propB: { type: 'stateful', definition: statefulParameterB, order: 1 },
@@ -494,6 +504,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterA, order: 3 },
             propB: { type: 'stateful', definition: statefulParameterB, order: 1 },
@@ -569,6 +580,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           transformation: {
             to: (desired) => ({
               propA: 'propA',
@@ -610,6 +622,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           transformation: {
             to: (desired) => ({
               propA: 'propA',
@@ -649,6 +662,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           importAndDestroy: {
             requiredParameters: [
               'propA',
@@ -668,6 +682,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'directory' }
           }
@@ -695,6 +710,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string', setting: true },
             propB: { type: 'number' }
@@ -737,6 +753,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           importAndDestroy: {
             requiredParameters: ['propA'],
             refreshKeys: ['propB', 'propA'],
@@ -754,6 +771,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string', isEqual: 'version' }
           }
@@ -780,6 +798,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'object' }
           }
@@ -822,6 +841,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'object' }
           }
@@ -863,6 +883,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: {
               type: 'array',
@@ -968,6 +989,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'stateful', definition: sp }
           }
@@ -1007,6 +1029,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'version' }
           }
@@ -1036,6 +1059,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'directory' }
           }
@@ -1065,6 +1089,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'directory' }
           },
@@ -1101,6 +1126,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'directory' }
           },
@@ -1127,6 +1153,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'directory' }
           },

package/src/resource/resource-settings.ts

@@ -1,10 +1,16 @@
 import { JSONSchemaType } from 'ajv';
-import { StringIndexedObject } from 'codify-schemas';
+import { OS, StringIndexedObject } from 'codify-schemas';
 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/functions.js';
 import { RefreshContext } from './resource.js';
 
 export interface InputTransformation {
@@ -22,6 +28,11 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    */
   id: string;
 
+  /**
+   * List of supported operating systems
+   */
+  operatingSystems: Array<OS>;
+
   /**
    * Schema to validate user configs with. Must be in the format JSON Schema draft07
    */

package/src/utils/file-utils.test.ts

@@ -0,0 +1,7 @@
+import { describe, it } from 'vitest';
+
+describe('File utils tests', { timeout: 100_000_000 }, () => {
+  it('Can download a file', async () => {
+    // await FileUtils.downloadFile('https://download.jetbrains.com/webstorm/WebStorm-2025.3.1-aarch64.dmg?_gl=1*1huoi7o*_gcl_aw*R0NMLjE3NjU3NDAwMTcuQ2p3S0NBaUEzZm5KQmhBZ0Vpd0F5cW1ZNVhLVENlbHJOcTk2YXdjZVlfMS1wdE91MXc0WDk2bFJkVDM3QURhUFNJMUtwNVVSVUhxWTJob0NuZ0FRQXZEX0J3RQ..*_gcl_au*MjA0MDQ0MjE2My4xNzYzNjQzNzMz*FPAU*MjA0MDQ0MjE2My4xNzYzNjQzNzMz*_ga*MTYxMDg4MTkzMi4xNzYzNjQzNzMz*_ga_9J976DJZ68*czE3NjYzNjI5ODAkbzEyJGcxJHQxNzY2MzYzMDQwJGo2MCRsMCRoMA..', path.join(process.cwd(), 'google.html'));
+  })
+})

package/src/utils/file-utils.ts

@@ -0,0 +1,216 @@
+import * as fsSync from 'node:fs';
+import * as fs from 'node:fs/promises';
+import path from 'node:path';
+import { Readable } from 'node:stream';
+import { finished } from 'node:stream/promises';
+
+import { Utils } from './index.js';
+
+const SPACE_REGEX = /^\s*$/
+
+export class FileUtils {
+  static async downloadFile(url: string, destination: string): Promise<void> {
+    console.log(`Downloading file from ${url} to ${destination}`);
+    const { body } = await fetch(url)
+
+    const dirname = path.dirname(destination);
+    if (!await fs.stat(dirname).then((s) => s.isDirectory()).catch(() => false)) {
+      await fs.mkdir(dirname, { recursive: true });
+    }
+
+    const ws = fsSync.createWriteStream(destination)
+    // Different type definitions here for readable stream (NodeJS vs DOM). Small hack to fix that
+    await finished(Readable.fromWeb(body as never).pipe(ws));
+
+    console.log(`Finished downloading to ${destination}`);
+  }
+
+  static async addToStartupFile(line: string): Promise<void> {
+    const lineToInsert = addLeadingSpacer(
+      addTrailingSpacer(line)
+    );
+
+    await fs.appendFile(Utils.getPrimaryShellRc(), lineToInsert)
+
+    function addLeadingSpacer(line: string): string {
+      return line.startsWith('\n')
+        ? line
+        : '\n' + line;
+    }
+
+    function addTrailingSpacer(line: string): string {
+      return line.endsWith('\n')
+        ? line
+        : line + '\n';
+    }
+  }
+
+  static async addAllToStartupFile(lines: string[]): Promise<void> {
+    const formattedLines = '\n' + lines.join('\n') + '\n';
+    const shellRc = Utils.getPrimaryShellRc();
+
+    console.log(`Adding to ${path.basename(shellRc)}:
+${lines.join('\n')}`)
+
+    await fs.appendFile(shellRc, formattedLines)
+  }
+
+  static async addPathToPrimaryShellRc(value: string, prepend: boolean): Promise<void> {
+    const shellRc = Utils.getPrimaryShellRc();
+    console.log(`Saving path: ${value} to ${shellRc}`);
+
+    if (prepend) {
+      await fs.appendFile(shellRc, `\nexport PATH=$PATH:${value};`, { encoding: 'utf8' });
+      return;
+    }
+
+    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');
+
+    let searchRegex;
+    let searchString;
+
+    if (typeof search === 'object') {
+      const startRegex = /^([\t ]*)?/;
+      const endRegex = /([\t ]*)?/;
+
+      // Augment regex with spaces criteria to make sure this function is not deleting lines that are comments or has other content.
+      searchRegex = search
+        ? new RegExp(
+          startRegex.source + search.source + endRegex.source,
+          search.flags
+        )
+        : search;
+    }
+
+    if (typeof search === 'string') {
+      searchString = search;
+    }
+
+    for (let counter = lines.length; counter >= 0; counter--) {
+      if (!lines[counter]) {
+        continue;
+      }
+
+      if (searchString && lines[counter].includes(searchString)) {
+        lines.splice(counter, 1);
+        continue;
+      }
+
+      if (searchRegex && lines[counter].search(searchRegex) !== -1) {
+        lines.splice(counter, 1);
+      }
+    }
+
+    await fs.writeFile(filePath, lines.join('\n'));
+    console.log(`Removed line: ${search} from ${filePath}`)
+  }
+
+  static async removeLineFromPrimaryShellRc(search: RegExp | string): Promise<void> {
+    return 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;
+  //
+  // newline;
+  static appendToFileWithSpacing(file: string, textToInsert: string): string {
+    const lines = file.trimEnd().split(/\n/);
+    if (lines.length === 0) {
+      return textToInsert;
+    }
+
+    const endingNewLines = FileUtils.calculateEndingNewLines(lines);
+    const numNewLines = endingNewLines === -1
+      ? 0
+      : Math.max(0, 2 - endingNewLines);
+    return lines.join('\n') + '\n'.repeat(numNewLines) + textToInsert
+  }
+
+  // This is overly complicated but it can be used to insert into any
+  // position in the future
+  private static calculateEndingNewLines(lines: string[]): number {
+    let counter = 0;
+    while (true) {
+      const line = lines.at(-counter - 1);
+
+      if (!line) {
+        return -1
+      }
+
+      if (!SPACE_REGEX.test(line)) {
+        return counter;
+      }
+
+      counter++;
+
+      // Short circuit here because we don't need to check over 2;
+      if (counter > 2) {
+        return counter;
+      }
+    }
+  }
+}

package/src/utils/{utils.ts → functions.ts}

@@ -2,22 +2,6 @@ import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
 import os from 'node:os';
 import path from 'node:path';
 
-export const VerbosityLevel = new class {
-  level = 0;
-
-  get() {
-    return this.level;
-  }
-
-  set(level: number) {
-    this.level = level;
-  }
-}
-
-export function isDebug(): boolean {
-  return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
-}
-
 export function splitUserConfig<T extends StringIndexedObject>(
   config: ResourceConfig & T
 ): { parameters: T; coreParameters: ResourceConfig } {

package/src/utils/index.ts

@@ -0,0 +1,144 @@
+import { OS } from 'codify-schemas';
+import os from 'node:os';
+import path from 'node:path';
+
+export function isDebug(): boolean {
+  return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
+}
+
+export enum Shell {
+  ZSH = 'zsh',
+  BASH = 'bash',
+  SH = 'sh',
+  KSH = 'ksh',
+  CSH = 'csh',
+  FISH = 'fish',
+}
+
+export interface SystemInfo {
+  os: OS;
+  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'),
+    ];
+  },
+};
+
+
+

package/src/utils/{utils.test.ts → internal-utils.test.ts}

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

package/src/utils/test-utils.test.ts

@@ -1,4 +1,4 @@
-import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+import { OS, ResourceConfig, StringIndexedObject } from 'codify-schemas';
 import { ResourceSettings } from '../resource/resource-settings.js';
 import { Plan } from '../plan/plan.js';
 import { Resource } from '../resource/resource.js';
@@ -35,7 +35,10 @@ export interface TestConfig extends StringIndexedObject {
 
 export class TestResource extends Resource<TestConfig> {
   getSettings(): ResourceSettings<TestConfig> {
-    return { id: 'type' }
+    return {
+      id: 'type',
+      operatingSystems: [OS.Darwin]
+    }
   }
 
   create(plan: CreatePlan<TestConfig>): Promise<void> {

package/src/utils/verbosity-level.ts

@@ -0,0 +1,11 @@
+export const VerbosityLevel = new class {
+  level = 0;
+
+  get() {
+    return this.level;
+  }
+
+  set(level: number) {
+    this.level = level;
+  }
+}