codify-plugin-lib 1.0.153 → 1.0.154

package/dist/plan/plan.js

@@ -159,7 +159,7 @@ export class Plan {
         const { matcher: parameterMatcher, id } = settings;
         const matcher = (desired, currentArray) => {
             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`);
             }
             return matched[0];

package/dist/resource/resource-settings.js

@@ -1,12 +1,12 @@
 import isObjectsEqual from 'lodash.isequal';
 import path from 'node:path';
-import { areArraysEqual, tildify, unhome, untildify } from '../utils/utils.js';
+import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
 const ParameterEqualsDefaults = {
     'boolean': (a, b) => Boolean(a) === Boolean(b),
     'directory': (a, b) => {
         const notCaseSensitive = process.platform === 'darwin';
-        const transformedA = path.resolve(unhome(untildify(notCaseSensitive ? String(a).toLowerCase() : String(a))));
-        const transformedB = path.resolve(unhome(untildify(notCaseSensitive ? String(b).toLowerCase() : String(b))));
+        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, b) => Number(a) === Number(b),
@@ -53,8 +53,8 @@ export function resolveFnFromEqualsFnOrString(fnOrString) {
 }
 const ParameterTransformationDefaults = {
     'directory': {
-        to: (a) => path.resolve(unhome(untildify(String(a)))),
-        from: (a) => tildify(String(a)),
+        to: (a) => path.resolve(resolvePathWithVariables((untildify(String(a))))),
+        from: (a) => addVariablesToPath(tildify(String(a))),
     },
     'string': {
         to: String,

package/dist/utils/utils.d.ts

@@ -7,5 +7,7 @@ export declare function splitUserConfig<T extends StringIndexedObject>(config: R
 export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
 export declare function untildify(pathWithTilde: string): string;
 export declare function tildify(pathWithTilde: string): string;
+export declare function resolvePathWithVariables(pathWithVariables: string): string;
+export declare function addVariablesToPath(pathWithoutVariables: string): string;
 export declare function unhome(pathWithHome: string): string;
 export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;

package/dist/utils/utils.js

@@ -1,4 +1,5 @@
 import os from 'node:os';
+import path from 'node:path';
 export function isDebug() {
     return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }
@@ -25,6 +26,20 @@ export function untildify(pathWithTilde) {
 export function tildify(pathWithTilde) {
     return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
 }
+export function resolvePathWithVariables(pathWithVariables) {
+    // @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) {
+    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) {
     return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
 }

package/package.json

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

package/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`)
       }
 

package/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, unhome, untildify } from '../utils/utils.js';
+import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
 
 export interface InputTransformation {
   to: (input: any) => Promise<any> | any;
@@ -304,8 +304,8 @@ const ParameterEqualsDefaults: Partial<Record<ParameterSettingType, (a: unknown,
   'boolean': (a: unknown, b: unknown) => Boolean(a) === Boolean(b),
   'directory': (a: unknown, b: unknown) => {
     const notCaseSensitive = process.platform === 'darwin';
-    const transformedA = path.resolve(unhome(untildify(notCaseSensitive ? String(a).toLowerCase() : String(a))))
-    const transformedB = path.resolve(unhome(untildify(notCaseSensitive ? String(b).toLowerCase() : String(b))))
+    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;
   },
@@ -368,8 +368,8 @@ export function resolveFnFromEqualsFnOrString(
 
 const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, InputTransformation>> = {
   'directory': {
-    to: (a: unknown) => path.resolve(unhome(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,

package/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');
+  })
 })

package/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,24 @@ 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;
 }