read-data-file 2.0.9 → 2.0.11

package/README.md

@@ -9,6 +9,13 @@ Read data/config files in various formats (parsers list is configurable).
 <!--/#echo -->
 
 
+Usage
+-----
+
+see [test/usage.mjs](test/usage.mjs)
+
+
+
 API
 ---
 
@@ -17,6 +24,10 @@ This module exports one function:
 ### readDataFile(path)
 
 Return a promise for data read from the file at path `path`.
+If no reader and parser can be determined from config, the promise will be
+rejected with error name `ReadDataFileUnsupportedFext`.
+
+
 
 ### readDataFile.cfg(opts)
 
@@ -68,10 +79,7 @@ Default parsers:
 
 
 
-Usage
------
 
-see [test/usage.js](test/usage.js)
 
 
 <!--#toc stop="scan" -->

package/package.json

@@ -1,5 +1,5 @@
 { "name": "read-data-file",
-  "version": "2.0.9",
+  "version": "2.0.11",
   "description": "Read data/config files in various formats (parsers list is configurable).",
   "keywords": [
     "read data file",
@@ -39,7 +39,7 @@
     "map-assoc-core": "^0.1.3",
     "merge-options": "^3.0.4",
     "p-each-series": "^2.2.0",
-    "p-fatal": "^0.1.3",
+    "p-fatal": "^0.1.5",
     "pify": "^5.0.0",
     "safeload-yaml-pmb": "^4.210519.0",
     "strip-bom": "^4.0.0",
@@ -48,12 +48,12 @@
   },
   "devDependencies": {
     "absdir": "^1.0.6",
-    "equal-pmb": "^0.1.24",
-    "eslint-config-nodejs-pmb": "^0.3.4",
+    "equal-pmb": "^0.1.27",
+    "eslint-config-nodejs-pmb": "^0.3.5",
     "eslint-plugin-json-light-pmb": "^1.0.7",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-n": "^15.2.4",
     "eslint-pretty-pmb": "^1.0.5",
-    "nodemjs": "^0.1.12"
+    "nodemjs": "^0.1.14"
   },
 
 

package/rdf.mjs

@@ -1,7 +1,8 @@
 // -*- coding: utf-8, tab-width: 2 -*-
 
-import pathLib from 'path';
 import nodeFs from 'fs';
+import pathLib from 'path';
+import zlib from 'zlib';
 
 import getOwn from 'getown';
 import ifFun from 'if-fun';
@@ -19,6 +20,10 @@ import tomlLib from 'toml';
 import yamlSafeLoad from 'safeload-yaml-pmb';
 
 
+const readRawFilePr = pify(nodeFs.readFile);
+const decodeGzipBuffer = pify(zlib.gunzip);
+
+
 function makeReaderFunc() {
   const f = function readDataFile(path) { return f.readFile(path); };
   return f;
@@ -35,6 +40,15 @@ function dlookup(dict, key) {
 function identity(x) { return x; }
 
 
+async function readGzippedUtf8(path) {
+  let d = await readRawFilePr(path);
+  d = await decodeGzipBuffer(d);
+  d = String(d);
+  d = stripBom(d);
+  return d;
+}
+
+
 const defaultImpl = {
 
   // #BEGIN# default opts
@@ -50,6 +64,7 @@ const defaultImpl = {
 
   readersByFext: {
     // qar(path) { return this.readFile(path + '.meta.json'); },
+    gz: readGzippedUtf8,
   },
   // #ENDOF# default opts
 
@@ -86,16 +101,15 @@ const defaultImpl = {
       let parser;
       pathDotParts.forEach(function lookup(dotPart) {
         fext = dotPart + (fext ? '.' + fext : '');
-        if (reader === undefined) { reader = dlookup(readersByFext, fext); }
-        if (parser === undefined) { parser = dlookup(parsersByFext, fext); }
+        if (reader === undefined) { reader = dlookup(readersByFext, dotPart); }
+        if (parser === undefined) { parser = dlookup(parsersByFext, dotPart); }
       });
       if (reader || parser) { return { reader, parser }; }
       return false;
     },
 
     async defaultReader(path) {
-      const text = stripBom(await pify(nodeFs.readFile)(path,
-        { encoding: 'UTF-8' }));
+      const text = stripBom(await readRawFilePr(path, { encoding: 'UTF-8' }));
       return text;
     },
 
@@ -120,7 +134,8 @@ const defaultImpl = {
         return data;
       } catch (err) {
         err.dataFilePath = path;
-        err.message += ' — Error occurred while trying to read file ' + path;
+        const trace = 'While reading file ' + JSON.stringify(path) + ': ';
+        err.message = trace + err.message;
         throw err;
       }
     },

package/test/cats.ndjson

@@ -0,0 +1,3 @@
+{ "name": "Cassy", "color": "black" }
+{ "name": "Milly", "color": "white" }
+{ "name": "Nero", "color": "orange" }

package/test/cats.yaml.gz.base64.txt

@@ -0,0 +1,3 @@
+H4sICMvmI14AA2NhdHMueWFtbABTjXT09VEw1DPiUlbQ1dJVSM5PycxLt1IIDXHTtdBRKElM0i3P
+TCnJsFIwAclz6erqcnE5JxYXV1pxKQBBcn5OfpGVQlJOYnI2F5dvZk4OqkR5RmZJKheXX2pRPop4
+flFiXjpQQk9PjwsAjJGvX4QAAAA=

package/test/usage.mjs

@@ -35,8 +35,10 @@ async function verifyAllFixtures() {
 
   await verifyOneFixture('cats.ceson');
   await verifyOneFixture('cats.ini');
+  await verifyOneFixture('cats.json.gz');
   await verifyOneFixture('cats.json5');
   await verifyOneFixture('cats.toml');
+  await verifyOneFixture('cats.yaml.gz');
   await verifyOneFixture('cats.yaml');
   await verifyOneFixture('cats.yml');