@ygracs/chn-alias-list 0.0.3

package/lib/file-helper.js

@@ -0,0 +1,245 @@
+// [v0.1.026-20241021]
+
+// === module init block ===
+
+const fs = require('fs');
+
+const {
+  isPlainObject,
+} = require('@ygracs/bsfoc-lib-js');
+
+// === module extra block (helper functions) ===
+
+/**
+ * @typedef {Object} fsoDescr
+ * @property {boolean} isERR - flag
+ * @property {number|undefined} errCode - error code
+ * @property {string} errEvent - event ID
+ * @property {string} errMsg - event message
+ * @property {string} source - path to file
+ * @property {any} content - file content
+ * @description A fs ops description.
+ */
+
+/**
+ * @typedef {Object} VCOR_evalerrfs
+ * @property {boolean} isSucceed - ops flag
+ * @property {fsoDescr} descr - description
+ * @description A result of an error check ops.
+ */
+
+/**
+ * @function checkFsError
+ * @param {fsoDescr} descr
+ * @param {Error} err
+ * @returns {VCOR_evalerrfs}
+ * @inner
+ * @description Checks an error code of a fs ops and sets descr info if succeed
+ */
+function checkFsError(descr, err) {
+  let isSucceed = false;
+  if (isPlainObject(err) && isPlainObject(descr)) {
+    switch (err.code) {
+      case 'ENOENT':
+      case 'EISDIR':
+      case 'ENOTDIR':
+      case 'EPERM': {
+        descr.errCode = err.errno;
+        descr.errEvent = err.code;
+        descr.errMsg = `ERR_FILE_${err.code}`;
+        isSucceed = true;
+        break;
+      }
+      default: {}
+    };
+    if (isSucceed) descr.isERR = true;
+  };
+  return { isSucceed, descr };
+};
+
+/**
+ * @function loadFileSync
+ * @param {string} src - a path to some file
+ * @returns {fsoDescr}
+ * @inner
+ * @description Loads file by a given path
+ */
+function loadFileSync(src) {
+  /** @type {fsoDescr} */
+  const data = {
+    isERR: false,
+    errCode: 0,
+    errEvent: '',
+    errMsg: '',
+    source: '',
+    content: '',
+  };
+  if (typeof src !== 'string') {
+    if (src !== undefined) {
+      data.isERR = true;
+      data.errEvent = 'ERR_INVARG';
+      data.errMsg = 'The "source" argument must be a string';
+    };
+  } else {
+    const srcPath = src.trim();
+    if (srcPath !== '') {
+      data.source = srcPath;
+      try {
+        data.content = fs.readFileSync(srcPath, 'utf8');
+      } catch (err) {
+        const { isSucceed } = checkFsError(data, err);
+        if (!isSucceed) {
+          // // TODO: [?] consider check others
+          //console.log(`TEST_ERR-MSG:loadFileSync: ${err}`);
+          //throw err;
+        };
+      };
+    };
+  };
+  return data;
+};
+
+/**
+ * @function saveToFileSync
+ * @param {string} src - a path to some file
+ * @param {string} content - some file content
+ * @param {any} [opt] - <reserved>
+ * @returns {fsoDescr}
+ * @inner
+ * @description Saves a content to a file
+ */
+function saveToFileSync(src, content = '', opt) {
+  /** @type {fsoDescr} */
+  const data = {
+    isERR: false,
+    errCode: 0,
+    errEvent: '',
+    errMsg: '',
+    source: '',
+    content: '',
+  };
+  if (typeof src !== 'string') {
+    data.isERR = true;
+    data.errEvent = src === undefined ? 'ERR_NOSRC' : 'ERR_INVARG';
+    data.errMsg = 'The "source" argument must be a string';
+  } else if (typeof content === 'string') {
+    const srcPath = src.trim();
+    if (srcPath === '') {
+      data.isERR = true;
+      data.errEvent = 'ERR_NOSRC';
+      data.errMsg = 'No "source" path given';
+    } else {
+      data.source = srcPath;
+      try {
+        fs.writeFileSync(srcPath, content, 'utf8');
+      } catch (err) {
+        const { isSucceed } = checkFsError(data, err);
+        if (!isSucceed) {
+          // // TODO: [?] consider check others
+          //console.log(`TEST_ERR-MSG:saveToFileSync: ${err}`);
+          //throw err;
+        };
+      };
+    };
+  } else {
+    data.isERR = true;
+    data.errEvent = 'ERR_INVARG';
+    data.errMsg = 'The "content" argument must be a string';
+  };
+  return data;
+};
+
+// === module main block ===
+
+/***
+ * (* constant definitions *)
+ */
+
+/***
+ * (* function definitions *)
+ */
+
+/**
+ * @typedef {Object} RVAL_loadjsonff
+ * @property {fsoDescr} descr - ops description
+ * @property {any} obj - loaded content
+ * @description A result of `loadJSONFromFileSync`
+ */
+
+/**
+ * @function loadJSONFromFileSync
+ * @param {string} src - a path to some file
+ * @param {any} [opt] - <reserved>
+ * @returns {RVAL_loadjsonff}
+ * @inner
+ * @description Loads a JSON-object from a file
+ */
+function loadJSONFromFileSync(src, opt) {
+  const data = loadFileSync(src);
+  let obj = null;
+  if (!data.isERR) {
+    if (data.content !== '') {
+      try {
+        obj = JSON.parse(data.content);
+        // if succeed clear <data.content>
+        data.content = '';
+      } catch (err) {
+        data.isERR = true;
+        //console.log(`TEST_ERR-CODE: [${err.code}](${err.errno})`);
+        //console.log(`TEST_ERR-MSG: ${err}`);
+        if (err instanceof SyntaxError) {
+          data.errEvent = 'ERR_JSON_BADDATA';
+          data.errMsg = err.message;
+        } else {
+          data.errEvent = 'ERR_JSON_UNKNOWN';
+        };
+      };
+    };
+  };
+  return { descr: data, obj };
+};
+
+/**
+ * @function saveJSONToFileSync
+ * @param {string} src - a path to some file
+ * @param {object} obj - some content
+ * @param {any} [opt] - <reserved>
+ * @returns {fsoDescr}
+ * @inner
+ * @description Saves a JSON-object to a file
+ */
+function saveJSONToFileSync(src, obj, opt) {
+  /** @type {fsoDescr} */
+  let data = {
+    isERR: false,
+    errCode: 0,
+    errEvent: '',
+    errMsg: '',
+    source: '',
+    content: '',
+  };
+  try {
+    data.content = JSON.stringify(obj, null, 2);
+  } catch (err) {
+    data.isERR = true;
+    //console.log(`TEST_ERR-CODE: [${err.code}](${err.errno})`);
+    //console.log(`TEST_ERR-MSG: ${err}`);
+    data.errEvent = 'ERR_JSON_UNKNOWN';
+  };
+  if (!data.isERR) {
+    data = saveToFileSync(src, data.content, opt);
+  };
+  return data;
+};
+
+/***
+ * (* class definitions *)
+ */
+
+// === module exports block ===
+
+module.exports.checkFsError = checkFsError;
+module.exports.loadFileSync = loadFileSync;
+module.exports.saveToFileSync = saveToFileSync;
+module.exports.loadJSONFromFileSync = loadJSONFromFileSync;
+module.exports.saveJSONToFileSync = saveJSONToFileSync;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@ygracs/chn-alias-list",
+  "version": "0.0.3",
+  "description": "A small library which provides some helper classes for EPG-tools",
+  "author": "ygracs <cs70th-om@rambler.ru>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/ygracs/chn-alias-list.git"
+  },
+  "main": "./index.js",
+  "files": [
+    "doc/chn-alias-list.md",
+    "lib/chn-alias-list.js",
+    "lib/file-helper.js",
+    "index.js",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "test": "jest",
+    "build-doc-md": "jsdoc2md",
+    "build-doc-html": "jsdoc"
+  },
+  "imports": {
+    "#lib/*": "./lib/*",
+    "#test-dir/*": "./__test__/*"
+  },
+  "dependencies": {
+    "@ygracs/bsfoc-lib-js": "^0.2.1"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0",
+    "jsdoc-to-markdown": "^9.0.4",
+    "minimist": "^1.2.8"
+  }
+}