smart-fs - npm Package Compare versions

Comparing version 1.9.14 to 1.10.0

lib/logic/smart-read.js

@@ -11,4 +11,6 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
 
-const yaml = require('yaml-boost');
+const yamlBoost = require('yaml-boost');
 
+const yaml = require('js-yaml');
+
 const xmlParser = require('../util/xml-parser');
@@ -23,7 +25,9 @@
   const ctx = _objectSpread({
-    treatAs: null
+    treatAs: null,
+    resolve: true
   }, options);
 
-  assert(Object.keys(ctx).length === 1, 'Unexpected Option provided!');
+  assert(Object.keys(ctx).length === 2, 'Unexpected Option provided!');
   assert(ctx.treatAs === null || typeof ctx.treatAs === 'string');
+  assert(typeof ctx.resolve === 'boolean');
   let result;
@@ -42,3 +46,3 @@
     case 'yaml':
-      result = yaml.load(filepath, {});
+      result = ctx.resolve ? yamlBoost.load(filepath, {}) : yaml.load(fs.readFileSync(filepath, 'utf8'));
       break;
@@ -63,2 +67,2 @@
 };
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9sb2dpYy9zbWFydC1yZWFkLmpzIl0sIm5hbWVzIjpbImFzc2VydCIsInJlcXVpcmUiLCJmcyIsInlhbWwiLCJ4bWxQYXJzZXIiLCJnZXRFeHQiLCJtb2R1bGUiLCJleHBvcnRzIiwiZmlsZXBhdGgiLCJvcHRpb25zIiwiT2JqZWN0IiwiQXJyYXkiLCJpc0FycmF5IiwiY3R4IiwidHJlYXRBcyIsImtleXMiLCJsZW5ndGgiLCJyZXN1bHQiLCJKU09OIiwicGFyc2UiLCJyZWFkRmlsZVN5bmMiLCJsb2FkIiwic3BsaXQiLCJ0cmltIiwicG9wIl0sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSxNQUFNQSxNQUFNLEdBQUdDLE9BQU8sQ0FBQyxRQUFELENBQXRCOztBQUNBLE1BQU1DLEVBQUUsR0FBR0QsT0FBTyxDQUFDLElBQUQsQ0FBbEI7O0FBQ0EsTUFBTUUsSUFBSSxHQUFHRixPQUFPLENBQUMsWUFBRCxDQUFwQjs7QUFDQSxNQUFNRyxTQUFTLEdBQUdILE9BQU8sQ0FBQyxvQkFBRCxDQUF6Qjs7QUFDQSxNQUFNSSxNQUFNLEdBQUdKLE9BQU8sQ0FBQyxpQkFBRCxDQUF0Qjs7QUFHQUssTUFBTSxDQUFDQyxPQUFQLEdBQWlCLENBQUNDLFFBQUQsRUFBV0MsT0FBTyxHQUFHLEVBQXJCLEtBQTRCO0FBQzNDVCxFQUFBQSxNQUFNLENBQUMsT0FBT1EsUUFBUCxLQUFvQixRQUFyQixDQUFOO0FBQ0FSLEVBQUFBLE1BQU0sQ0FBQ1MsT0FBTyxZQUFZQyxNQUFuQixJQUE2QixDQUFDQyxLQUFLLENBQUNDLE9BQU4sQ0FBY0gsT0FBZCxDQUEvQixDQUFOOztBQUVBLFFBQU1JLEdBQUc7QUFBS0MsSUFBQUEsT0FBTyxFQUFFO0FBQWQsS0FBdUJMLE9BQXZCLENBQVQ7O0FBQ0FULEVBQUFBLE1BQU0sQ0FBQ1UsTUFBTSxDQUFDSyxJQUFQLENBQVlGLEdBQVosRUFBaUJHLE1BQWpCLEtBQTRCLENBQTdCLEVBQWdDLDZCQUFoQyxDQUFOO0FBQ0FoQixFQUFBQSxNQUFNLENBQUNhLEdBQUcsQ0FBQ0MsT0FBSixLQUFnQixJQUFoQixJQUF3QixPQUFPRCxHQUFHLENBQUNDLE9BQVgsS0FBdUIsUUFBaEQsQ0FBTjtBQUVBLE1BQUlHLE1BQUo7O0FBQ0EsVUFBUUosR0FBRyxDQUFDQyxPQUFKLElBQWVULE1BQU0sQ0FBQ0csUUFBRCxDQUE3QjtBQUNFLFNBQUssTUFBTDtBQUNFUyxNQUFBQSxNQUFNLEdBQUdDLElBQUksQ0FBQ0MsS0FBTCxDQUFXakIsRUFBRSxDQUFDa0IsWUFBSCxDQUFnQlosUUFBaEIsRUFBMEIsTUFBMUIsQ0FBWCxDQUFUO0FBQ0E7O0FBQ0YsU0FBSyxLQUFMO0FBQ0VTLE1BQUFBLE1BQU0sR0FBR2IsU0FBUyxDQUFDZSxLQUFWLENBQWdCakIsRUFBRSxDQUFDa0IsWUFBSCxDQUFnQlosUUFBaEIsRUFBMEIsTUFBMUIsQ0FBaEIsRUFBbURDLE9BQW5ELENBQVQ7QUFDQTs7QUFDRixTQUFLLEtBQUw7QUFDQSxTQUFLLE1BQUw7QUFDRVEsTUFBQUEsTUFBTSxHQUFHZCxJQUFJLENBQUNrQixJQUFMLENBQVViLFFBQVYsRUFBb0IsRUFBcEIsQ0FBVDtBQUNBOztBQUNGLFNBQUssSUFBTDtBQUNFO0FBQ0FTLE1BQUFBLE1BQU0sR0FBR2hCLE9BQU8sQ0FBQ08sUUFBRCxDQUFoQjtBQUNBOztBQUNGO0FBQ0VTLE1BQUFBLE1BQU0sR0FBR2YsRUFBRSxDQUFDa0IsWUFBSCxDQUFnQlosUUFBaEIsRUFBMEIsTUFBMUIsRUFBa0NjLEtBQWxDLENBQXdDLElBQXhDLENBQVQ7O0FBQ0EsVUFBSUwsTUFBTSxDQUFDQSxNQUFNLENBQUNELE1BQVAsR0FBZ0IsQ0FBakIsQ0FBTixDQUEwQk8sSUFBMUIsT0FBcUMsRUFBekMsRUFBNkM7QUFDM0NOLFFBQUFBLE1BQU0sQ0FBQ08sR0FBUDtBQUNEOztBQUNEO0FBcEJKOztBQXNCQSxTQUFPUCxNQUFQO0FBQ0QsQ0FoQ0QiLCJzb3VyY2VzQ29udGVudCI6WyJjb25zdCBhc3NlcnQgPSByZXF1aXJlKCdhc3NlcnQnKTtcbmNvbnN0IGZzID0gcmVxdWlyZSgnZnMnKTtcbmNvbnN0IHlhbWwgPSByZXF1aXJlKCd5YW1sLWJvb3N0Jyk7XG5jb25zdCB4bWxQYXJzZXIgPSByZXF1aXJlKCcuLi91dGlsL3htbC1wYXJzZXInKTtcbmNvbnN0IGdldEV4dCA9IHJlcXVpcmUoJy4uL3V0aWwvZ2V0LWV4dCcpO1xuXG5cbm1vZHVsZS5leHBvcnRzID0gKGZpbGVwYXRoLCBvcHRpb25zID0ge30pID0+IHtcbiAgYXNzZXJ0KHR5cGVvZiBmaWxlcGF0aCA9PT0gJ3N0cmluZycpO1xuICBhc3NlcnQob3B0aW9ucyBpbnN0YW5jZW9mIE9iamVjdCAmJiAhQXJyYXkuaXNBcnJheShvcHRpb25zKSk7XG5cbiAgY29uc3QgY3R4ID0geyB0cmVhdEFzOiBudWxsLCAuLi5vcHRpb25zIH07XG4gIGFzc2VydChPYmplY3Qua2V5cyhjdHgpLmxlbmd0aCA9PT0gMSwgJ1VuZXhwZWN0ZWQgT3B0aW9uIHByb3ZpZGVkIScpO1xuICBhc3NlcnQoY3R4LnRyZWF0QXMgPT09IG51bGwgfHwgdHlwZW9mIGN0eC50cmVhdEFzID09PSAnc3RyaW5nJyk7XG5cbiAgbGV0IHJlc3VsdDtcbiAgc3dpdGNoIChjdHgudHJlYXRBcyB8fCBnZXRFeHQoZmlsZXBhdGgpKSB7XG4gICAgY2FzZSAnanNvbic6XG4gICAgICByZXN1bHQgPSBKU09OLnBhcnNlKGZzLnJlYWRGaWxlU3luYyhmaWxlcGF0aCwgJ3V0ZjgnKSk7XG4gICAgICBicmVhaztcbiAgICBjYXNlICd4bWwnOlxuICAgICAgcmVzdWx0ID0geG1sUGFyc2VyLnBhcnNlKGZzLnJlYWRGaWxlU3luYyhmaWxlcGF0aCwgJ3V0ZjgnKSwgb3B0aW9ucyk7XG4gICAgICBicmVhaztcbiAgICBjYXNlICd5bWwnOlxuICAgIGNhc2UgJ3lhbWwnOlxuICAgICAgcmVzdWx0ID0geWFtbC5sb2FkKGZpbGVwYXRoLCB7fSk7XG4gICAgICBicmVhaztcbiAgICBjYXNlICdqcyc6XG4gICAgICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgaW1wb3J0L25vLWR5bmFtaWMtcmVxdWlyZSxnbG9iYWwtcmVxdWlyZVxuICAgICAgcmVzdWx0ID0gcmVxdWlyZShmaWxlcGF0aCk7XG4gICAgICBicmVhaztcbiAgICBkZWZhdWx0OlxuICAgICAgcmVzdWx0ID0gZnMucmVhZEZpbGVTeW5jKGZpbGVwYXRoLCAndXRmOCcpLnNwbGl0KCdcXG4nKTtcbiAgICAgIGlmIChyZXN1bHRbcmVzdWx0Lmxlbmd0aCAtIDFdLnRyaW0oKSA9PT0gJycpIHtcbiAgICAgICAgcmVzdWx0LnBvcCgpO1xuICAgICAgfVxuICAgICAgYnJlYWs7XG4gIH1cbiAgcmV0dXJuIHJlc3VsdDtcbn07XG4iXX0=
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9sb2dpYy9zbWFydC1yZWFkLmpzIl0sIm5hbWVzIjpbImFzc2VydCIsInJlcXVpcmUiLCJmcyIsInlhbWxCb29zdCIsInlhbWwiLCJ4bWxQYXJzZXIiLCJnZXRFeHQiLCJtb2R1bGUiLCJleHBvcnRzIiwiZmlsZXBhdGgiLCJvcHRpb25zIiwiT2JqZWN0IiwiQXJyYXkiLCJpc0FycmF5IiwiY3R4IiwidHJlYXRBcyIsInJlc29sdmUiLCJrZXlzIiwibGVuZ3RoIiwicmVzdWx0IiwiSlNPTiIsInBhcnNlIiwicmVhZEZpbGVTeW5jIiwibG9hZCIsInNwbGl0IiwidHJpbSIsInBvcCJdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsTUFBTUEsTUFBTSxHQUFHQyxPQUFPLENBQUMsUUFBRCxDQUF0Qjs7QUFDQSxNQUFNQyxFQUFFLEdBQUdELE9BQU8sQ0FBQyxJQUFELENBQWxCOztBQUNBLE1BQU1FLFNBQVMsR0FBR0YsT0FBTyxDQUFDLFlBQUQsQ0FBekI7O0FBQ0EsTUFBTUcsSUFBSSxHQUFHSCxPQUFPLENBQUMsU0FBRCxDQUFwQjs7QUFDQSxNQUFNSSxTQUFTLEdBQUdKLE9BQU8sQ0FBQyxvQkFBRCxDQUF6Qjs7QUFDQSxNQUFNSyxNQUFNLEdBQUdMLE9BQU8sQ0FBQyxpQkFBRCxDQUF0Qjs7QUFHQU0sTUFBTSxDQUFDQyxPQUFQLEdBQWlCLENBQUNDLFFBQUQsRUFBV0MsT0FBTyxHQUFHLEVBQXJCLEtBQTRCO0FBQzNDVixFQUFBQSxNQUFNLENBQUMsT0FBT1MsUUFBUCxLQUFvQixRQUFyQixDQUFOO0FBQ0FULEVBQUFBLE1BQU0sQ0FBQ1UsT0FBTyxZQUFZQyxNQUFuQixJQUE2QixDQUFDQyxLQUFLLENBQUNDLE9BQU4sQ0FBY0gsT0FBZCxDQUEvQixDQUFOOztBQUVBLFFBQU1JLEdBQUc7QUFBS0MsSUFBQUEsT0FBTyxFQUFFLElBQWQ7QUFBb0JDLElBQUFBLE9BQU8sRUFBRTtBQUE3QixLQUFzQ04sT0FBdEMsQ0FBVDs7QUFDQVYsRUFBQUEsTUFBTSxDQUFDVyxNQUFNLENBQUNNLElBQVAsQ0FBWUgsR0FBWixFQUFpQkksTUFBakIsS0FBNEIsQ0FBN0IsRUFBZ0MsNkJBQWhDLENBQU47QUFDQWxCLEVBQUFBLE1BQU0sQ0FBQ2MsR0FBRyxDQUFDQyxPQUFKLEtBQWdCLElBQWhCLElBQXdCLE9BQU9ELEdBQUcsQ0FBQ0MsT0FBWCxLQUF1QixRQUFoRCxDQUFOO0FBQ0FmLEVBQUFBLE1BQU0sQ0FBQyxPQUFPYyxHQUFHLENBQUNFLE9BQVgsS0FBdUIsU0FBeEIsQ0FBTjtBQUVBLE1BQUlHLE1BQUo7O0FBQ0EsVUFBUUwsR0FBRyxDQUFDQyxPQUFKLElBQWVULE1BQU0sQ0FBQ0csUUFBRCxDQUE3QjtBQUNFLFNBQUssTUFBTDtBQUNFVSxNQUFBQSxNQUFNLEdBQUdDLElBQUksQ0FBQ0MsS0FBTCxDQUFXbkIsRUFBRSxDQUFDb0IsWUFBSCxDQUFnQmIsUUFBaEIsRUFBMEIsTUFBMUIsQ0FBWCxDQUFUO0FBQ0E7O0FBQ0YsU0FBSyxLQUFMO0FBQ0VVLE1BQUFBLE1BQU0sR0FBR2QsU0FBUyxDQUFDZ0IsS0FBVixDQUFnQm5CLEVBQUUsQ0FBQ29CLFlBQUgsQ0FBZ0JiLFFBQWhCLEVBQTBCLE1BQTFCLENBQWhCLEVBQW1EQyxPQUFuRCxDQUFUO0FBQ0E7O0FBQ0YsU0FBSyxLQUFMO0FBQ0EsU0FBSyxNQUFMO0FBQ0VTLE1BQUFBLE1BQU0sR0FBR0wsR0FBRyxDQUFDRSxPQUFKLEdBQ0xiLFNBQVMsQ0FBQ29CLElBQVYsQ0FBZWQsUUFBZixFQUF5QixFQUF6QixDQURLLEdBRUxMLElBQUksQ0FBQ21CLElBQUwsQ0FBVXJCLEVBQUUsQ0FBQ29CLFlBQUgsQ0FBZ0JiLFFBQWhCLEVBQTBCLE1BQTFCLENBQVYsQ0FGSjtBQUdBOztBQUNGLFNBQUssSUFBTDtBQUNFO0FBQ0FVLE1BQUFBLE1BQU0sR0FBR2xCLE9BQU8sQ0FBQ1EsUUFBRCxDQUFoQjtBQUNBOztBQUNGO0FBQ0VVLE1BQUFBLE1BQU0sR0FBR2pCLEVBQUUsQ0FBQ29CLFlBQUgsQ0FBZ0JiLFFBQWhCLEVBQTBCLE1BQTFCLEVBQWtDZSxLQUFsQyxDQUF3QyxJQUF4QyxDQUFUOztBQUNBLFVBQUlMLE1BQU0sQ0FBQ0EsTUFBTSxDQUFDRCxNQUFQLEdBQWdCLENBQWpCLENBQU4sQ0FBMEJPLElBQTFCLE9BQXFDLEVBQXpDLEVBQTZDO0FBQzNDTixRQUFBQSxNQUFNLENBQUNPLEdBQVA7QUFDRDs7QUFDRDtBQXRCSjs7QUF3QkEsU0FBT1AsTUFBUDtBQUNELENBbkNEIiwic291cmNlc0NvbnRlbnQiOlsiY29uc3QgYXNzZXJ0ID0gcmVxdWlyZSgnYXNzZXJ0Jyk7XG5jb25zdCBmcyA9IHJlcXVpcmUoJ2ZzJyk7XG5jb25zdCB5YW1sQm9vc3QgPSByZXF1aXJlKCd5YW1sLWJvb3N0Jyk7XG5jb25zdCB5YW1sID0gcmVxdWlyZSgnanMteWFtbCcpO1xuY29uc3QgeG1sUGFyc2VyID0gcmVxdWlyZSgnLi4vdXRpbC94bWwtcGFyc2VyJyk7XG5jb25zdCBnZXRFeHQgPSByZXF1aXJlKCcuLi91dGlsL2dldC1leHQnKTtcblxuXG5tb2R1bGUuZXhwb3J0cyA9IChmaWxlcGF0aCwgb3B0aW9ucyA9IHt9KSA9PiB7XG4gIGFzc2VydCh0eXBlb2YgZmlsZXBhdGggPT09ICdzdHJpbmcnKTtcbiAgYXNzZXJ0KG9wdGlvbnMgaW5zdGFuY2VvZiBPYmplY3QgJiYgIUFycmF5LmlzQXJyYXkob3B0aW9ucykpO1xuXG4gIGNvbnN0IGN0eCA9IHsgdHJlYXRBczogbnVsbCwgcmVzb2x2ZTogdHJ1ZSwgLi4ub3B0aW9ucyB9O1xuICBhc3NlcnQoT2JqZWN0LmtleXMoY3R4KS5sZW5ndGggPT09IDIsICdVbmV4cGVjdGVkIE9wdGlvbiBwcm92aWRlZCEnKTtcbiAgYXNzZXJ0KGN0eC50cmVhdEFzID09PSBudWxsIHx8IHR5cGVvZiBjdHgudHJlYXRBcyA9PT0gJ3N0cmluZycpO1xuICBhc3NlcnQodHlwZW9mIGN0eC5yZXNvbHZlID09PSAnYm9vbGVhbicpO1xuXG4gIGxldCByZXN1bHQ7XG4gIHN3aXRjaCAoY3R4LnRyZWF0QXMgfHwgZ2V0RXh0KGZpbGVwYXRoKSkge1xuICAgIGNhc2UgJ2pzb24nOlxuICAgICAgcmVzdWx0ID0gSlNPTi5wYXJzZShmcy5yZWFkRmlsZVN5bmMoZmlsZXBhdGgsICd1dGY4JykpO1xuICAgICAgYnJlYWs7XG4gICAgY2FzZSAneG1sJzpcbiAgICAgIHJlc3VsdCA9IHhtbFBhcnNlci5wYXJzZShmcy5yZWFkRmlsZVN5bmMoZmlsZXBhdGgsICd1dGY4JyksIG9wdGlvbnMpO1xuICAgICAgYnJlYWs7XG4gICAgY2FzZSAneW1sJzpcbiAgICBjYXNlICd5YW1sJzpcbiAgICAgIHJlc3VsdCA9IGN0eC5yZXNvbHZlXG4gICAgICAgID8geWFtbEJvb3N0LmxvYWQoZmlsZXBhdGgsIHt9KVxuICAgICAgICA6IHlhbWwubG9hZChmcy5yZWFkRmlsZVN5bmMoZmlsZXBhdGgsICd1dGY4JykpO1xuICAgICAgYnJlYWs7XG4gICAgY2FzZSAnanMnOlxuICAgICAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIGltcG9ydC9uby1keW5hbWljLXJlcXVpcmUsZ2xvYmFsLXJlcXVpcmVcbiAgICAgIHJlc3VsdCA9IHJlcXVpcmUoZmlsZXBhdGgpO1xuICAgICAgYnJlYWs7XG4gICAgZGVmYXVsdDpcbiAgICAgIHJlc3VsdCA9IGZzLnJlYWRGaWxlU3luYyhmaWxlcGF0aCwgJ3V0ZjgnKS5zcGxpdCgnXFxuJyk7XG4gICAgICBpZiAocmVzdWx0W3Jlc3VsdC5sZW5ndGggLSAxXS50cmltKCkgPT09ICcnKSB7XG4gICAgICAgIHJlc3VsdC5wb3AoKTtcbiAgICAgIH1cbiAgICAgIGJyZWFrO1xuICB9XG4gIHJldHVybiByZXN1bHQ7XG59O1xuIl19

package.json

 {
   "name": "smart-fs",
-  "version": "1.9.14",
+  "version": "1.10.0",
   "description": "Abstraction Layer for File Management.",
@@ -46,8 +46,8 @@ "main": "lib/index.js",
   "devDependencies": {
-    "@babel/cli": "7.6.0",
-    "@babel/core": "7.6.0",
-    "@babel/plugin-proposal-object-rest-spread": "7.5.5",
-    "@babel/register": "7.6.0",
-    "@blackflux/eslint-plugin-rules": "1.3.10",
-    "@blackflux/robo-config-plugin": "2.6.7",
+    "@babel/cli": "7.6.2",
+    "@babel/core": "7.6.2",
+    "@babel/plugin-proposal-object-rest-spread": "7.6.2",
+    "@babel/register": "7.6.2",
+    "@blackflux/eslint-plugin-rules": "1.3.12",
+    "@blackflux/robo-config-plugin": "2.6.13",
     "babel-eslint": "10.0.3",
@@ -62,4 +62,4 @@ "chai": "4.2.0",
     "eslint-plugin-mocha": "6.1.1",
-    "js-gardener": "2.0.89",
-    "node-tdd": "2.5.5",
+    "js-gardener": "2.0.102",
+    "node-tdd": "2.5.12",
     "nyc": "14.1.1",
@@ -112,2 +112,3 @@ "semantic-release": "15.13.24"
     "fs-extra": "8.1.0",
+    "js-yaml": "3.13.1",
     "json-stringify-pretty-compact": "2.0.0",
@@ -114,0 +115,0 @@ "lodash.clonedeep": "4.5.0",

README.md

@@ -41,3 +41,3 @@ # smart-fs
 
-### smartRead(filepath, options = { treatAs = null })
+### smartRead(filepath, options = { treatAs = null, resolve = true })
 
@@ -58,2 +58,4 @@ Read and parse file based on file extension.
 
+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 })
@@ -60,0 +62,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40098

increased by2.24%

Lines of code

192

increased by1.59%

Number of lines in readme file

90

increased by2.27%

Worsened metrics

Dependency count

8

increased by14.29%

Dependency changes

• + Addedjs-yaml@3.13.1