feat: added "resolve" option for smartRead

Author: simlu

README.md

@@ -38,7 +38,7 @@ Will only return entries where `fs.lstatSync(...).isFile()` evaluates to true (t
 
 Delete file and all empty parent directories.
 
-### smartRead(filepath, options = { treatAs = null })
+### smartRead(filepath, options = { treatAs = null, resolve = true })
 
 Read and parse file based on file extension.
 
@@ -54,6 +54,8 @@ Note that the [required cache](https://nodejs.org/api/modules.html#modules_requi
 
 To ignore file extension and force treat the file as a certain type, you can pass the option `treatAs` as e.g. `json`.
 
+To simply load yml files without resolving them pass `resolve` as `false`
+
 ### smartWrite(filepath. content, options = { treatAs = null, mergeStrategy = (existing, changeset) => changeset, create = true, pretty = false, keepOrder = true })
 
 Serialize and write content to file based on file extension.

package.json

@@ -107,6 +107,7 @@
   ],
   "dependencies": {
     "fs-extra": "8.1.0",
+    "js-yaml": "3.13.1",
     "json-stringify-pretty-compact": "2.0.0",
     "lodash.clonedeep": "4.5.0",
     "lodash.isequal": "4.5.0",

src/logic/smart-read.js

@@ -1,6 +1,7 @@
 const assert = require('assert');
 const fs = require('fs');
-const yaml = require('yaml-boost');
+const yamlBoost = require('yaml-boost');
+const yaml = require('js-yaml');
 const xmlParser = require('../util/xml-parser');
 const getExt = require('../util/get-ext');
 
@@ -9,9 +10,10 @@ module.exports = (filepath, options = {}) => {
   assert(typeof filepath === 'string');
   assert(options instanceof Object && !Array.isArray(options));
 
-  const ctx = { treatAs: null, ...options };
-  assert(Object.keys(ctx).length === 1, 'Unexpected Option provided!');
+  const ctx = { treatAs: null, resolve: true, ...options };
+  assert(Object.keys(ctx).length === 2, 'Unexpected Option provided!');
   assert(ctx.treatAs === null || typeof ctx.treatAs === 'string');
+  assert(typeof ctx.resolve === 'boolean');
 
   let result;
   switch (ctx.treatAs || getExt(filepath)) {
@@ -23,7 +25,9 @@ module.exports = (filepath, options = {}) => {
       break;
     case 'yml':
     case 'yaml':
-      result = yaml.load(filepath, {});
+      result = ctx.resolve
+        ? yamlBoost.load(filepath, {})
+        : yaml.load(fs.readFileSync(filepath, 'utf8'));
       break;
     case 'js':
       // eslint-disable-next-line import/no-dynamic-require,global-require

test/logic/smart-read.spec.js

@@ -44,8 +44,12 @@ describe('Testing smartRead', { useTmpDir: true }, () => {
     );
   });
 
-  it('Testing .yml', () => {
-    executeTest('file.yml', 'key: value', { key: 'value' });
+  it('Testing .yml (resolve)', () => {
+    executeTest('file.yml', '<<<:\n  - key: value', { key: 'value' });
+  });
+
+  it('Testing .yml (no resolve)', () => {
+    executeTest('file.yml', '<<<:\n  - key: value', { '<<<': [{ key: 'value' }] }, { resolve: false });
   });
 
   it('Testing .js', () => {