feat: Added variable resolution for paths. Changed match length to be greater than 1

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.152",
+  "version": "1.0.154",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/plan/plan.ts

@@ -263,7 +263,7 @@ export class Plan<T extends StringIndexedObject> {
     const { matcher: parameterMatcher, id } = settings;
     const matcher = (desired: Partial<T>, currentArray: Partial<T>[]): Partial<T> | undefined => {
       const matched = currentArray.filter((c) => parameterMatcher(desired, c))
-      if (matched.length > 0) {
+      if (matched.length > 1) {
         console.log(`Resource: ${id} did not uniquely match resources when allow multiple is set to true`)
       }
 

src/resource/resource-settings.ts

@@ -4,7 +4,7 @@ import isObjectsEqual from 'lodash.isequal'
 import path from 'node:path';
 
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
-import { areArraysEqual, tildify, untildify } from '../utils/utils.js';
+import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
 
 export interface InputTransformation {
   to: (input: any) => Promise<any> | any;
@@ -302,7 +302,13 @@ export interface StatefulParameterSetting extends DefaultParameterSetting {
 
 const ParameterEqualsDefaults: Partial<Record<ParameterSettingType, (a: unknown, b: unknown) => boolean>> = {
   'boolean': (a: unknown, b: unknown) => Boolean(a) === Boolean(b),
-  'directory': (a: unknown, b: unknown) => path.resolve(untildify(String(a))) === path.resolve(untildify(String(b))),
+  'directory': (a: unknown, b: unknown) => {
+    const notCaseSensitive = process.platform === 'darwin';
+    const transformedA = path.resolve(resolvePathWithVariables(untildify(notCaseSensitive ? String(a).toLowerCase() : String(a))))
+    const transformedB = path.resolve(resolvePathWithVariables(untildify(notCaseSensitive ? String(b).toLowerCase() : String(b))))
+
+    return transformedA === transformedB;
+  },
   'number': (a: unknown, b: unknown) => Number(a) === Number(b),
   'string': (a: unknown, b: unknown) => String(a) === String(b),
   'version': (desired: unknown, current: unknown) => String(current).includes(String(desired)),
@@ -362,8 +368,8 @@ export function resolveFnFromEqualsFnOrString(
 
 const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, InputTransformation>> = {
   'directory': {
-    to: (a: unknown) => path.resolve(untildify(String(a))),
-    from: (a: unknown) => tildify(String(a)),
+    to: (a: unknown) => path.resolve(resolvePathWithVariables((untildify(String(a))))),
+    from: (a: unknown) => addVariablesToPath(tildify(String(a))),
   },
   'string': {
     to: String,

src/utils/utils.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect, it } from 'vitest';
-import { splitUserConfig } from './utils.js';
+import { addVariablesToPath, resolvePathWithVariables, splitUserConfig } from './utils.js';
+import os from 'node:os';
 
 describe('Utils tests', () => {
   it('Can split a config correctly', () => {
@@ -26,4 +27,25 @@ describe('Utils tests', () => {
       propD: 'propD',
     })
   })
+
+  it('Can remove variables from a path', () => {
+    const testPath1 = '$HOME/my/path';
+    const result1 = resolvePathWithVariables(testPath1);
+
+    const home = os.homedir();
+    expect(result1).to.eq(home + '/my/path');
+
+
+    const testPath2 = '/var$HOME/my/path';
+    const result2 = resolvePathWithVariables(testPath2);
+    expect(result2).to.eq('/var' + home + '/my/path');
+  })
+
+  it('Can add variables to a path', () => {
+    const testPath1 = os.homedir() + '/my/path';
+    const result1 = addVariablesToPath(testPath1);
+
+    const home = os.homedir();
+    expect(result1).to.eq('$HOME/my/path');
+  })
 })

src/utils/utils.ts

@@ -1,5 +1,6 @@
 import { ResourceConfig, StringIndexedObject } 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
@@ -37,6 +38,28 @@ export function tildify(pathWithTilde: string) {
   return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
 }
 
+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])
+}
+
+export function addVariablesToPath(pathWithoutVariables: string) {
+  let result = pathWithoutVariables;
+  for (const [key, value] of Object.entries(process.env)) {
+    if (!value || !path.isAbsolute(value) || value === '/') {
+      continue;
+    }
+
+    result = result.replaceAll(value, `$${key}`)
+  }
+
+  return result;
+}
+
+export function unhome(pathWithHome: string): string {
+  return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
+}
+
 export function areArraysEqual(
   isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined,
   desired: unknown,