Merge pull request #11 from simlu/develop

Develop

README.md

@@ -31,6 +31,28 @@ yaml.load("config.yaml");
 
 Works identical to how this is defined for serverless [here](https://serverless.com/framework/docs/providers/aws/guide/variables/).
 
+#### Extensions
+
+##### Bake variables when loading files
+
+```yaml
+${file(./path/to/file.yml), key1=value1&key2=value2}
+```
+
+##### Reference Js files
+
+Reference js instead of yaml files.
+
+```yaml
+${file(./path/to/file.js)}
+```
+
+The reference file needs to export simple object containing configuration
+
+```js
+module.exports = {};
+```
+
 ### Deep Merge
 
 Analogue to the `<<` yaml syntax we can use `<<<` to deep merge into the current nesting level.

lib/index.js

@@ -12,13 +12,26 @@ const loadRecursive = (dir, data, vars) => {
   let result = data;
   if (typeof result === 'string' || result instanceof String) {
     // replace yaml variables with defaults
-    result = result.replace(/\${opt:([a-zA-Z0-9]+?)(?:, ["']([a-zA-Z0-9]+?)["'])?}/g, (_, k, v) => get(vars, k, v));
+    result = result.replace(
+      /\${opt:([a-zA-Z0-9]+?)(?:, ["']([a-zA-Z0-9-]+?)["'])?}/g,
+      (match, k, v) => get(vars, k, v || match)
+    );
     // load referenced yaml file
-    const match = /^\${file\((~?[a-zA-Z0-9._\-/]+?)\)(?::([a-zA-Z0-9.]+?))?}$/g.exec(result);
+    const match = (
+      /^\${file\((~?[a-zA-Z0-9._/-]+?)\)(?::([a-zA-Z0-9.]+?))?(?:, ([a-zA-Z0-9=&-]+?))?}$/g.exec(result)
+    );
     if (match) {
       const filePath = path.join(dir, match[1]);
-      const loaded = yaml.safeLoad(fs.readFileSync(filePath, 'utf8'));
-      result = loadRecursive(dir, match[2] ? get(loaded, match[2]) : loaded, vars);
+      const loaded = filePath.endsWith(".yml")
+        ? yaml.safeLoad(fs.readFileSync(filePath, 'utf8'))
+        // eslint-disable-next-line global-require, import/no-dynamic-require
+        : require(filePath);
+      result = loadRecursive(
+        dir,
+        match[2] ? get(loaded, match[2]) : loaded,
+        Object.assign({}, vars, match[3] ? JSON
+          .parse(`{"${match[3].replace(/&/g, "\",\"").replace(/=/g, "\":\"")}"}`) : {})
+      );
     }
   }
   if (result instanceof Object) {

test/resources/child.js

@@ -0,0 +1,3 @@
+module.exports = {
+  key: "value"
+};

test/resources/childVariable.yml

@@ -0,0 +1 @@
+key: ${opt:variable}

test/resources/parent.yml

@@ -4,3 +4,10 @@ child:
 
 childValue:
   ${file(./child.yml):key}
+
+
+childBaked:
+  ${file(./childVariable.yml), variable=value}
+
+childJs:
+  ${file(./child.js)}

test/test_index.js

@@ -9,7 +9,8 @@ const parentFile = path.join(__dirname, "resources", 'parent.yml');
 describe("Testing Yaml", () => {
   it("Testing Variable Undefined", () => {
     expect(yaml.load(variablesFile)).to.deep.equal({
-      plain: 'undefined', default: 'default'
+      // eslint-disable-next-line no-template-curly-in-string
+      plain: '${opt:test}', default: 'default'
     });
   });
 
@@ -27,7 +28,10 @@ describe("Testing Yaml", () => {
 
   it("Testing File Resolution", () => {
     expect(yaml.load(parentFile)).to.deep.equal({
-      child: { key: "value" }, childValue: "value"
+      child: { key: "value" },
+      childValue: "value",
+      childBaked: { key: "value" },
+      childJs: { key: "value" }
     });
   });
 });