readlineq 2.0.3 → 3.0.0

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2017 Hai Liang Wang <hailiang.hl.wang@gmail.com> 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.OF
+Copyright 2017 Hai Liang Wang <hailiang.hl.wang@gmail.com> 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.OF

package/README.md

@@ -1,16 +1,21 @@
-# readlineq
-read or write file by lines with promise.
-
-```
-var readlineq = require('readlineq');
-# read lines
-var lines = await readlineq('./tmp/stopwords.txt');
-// console.log(lines);
-
-# write lines
-await readlineq('./tmp/test.txt', ["foo\n", "bar\n"]);
-// console.log(lines);
-```
-
-# LICENSE
-MIT
+# readlineq
+read or write file by lines with promise.
+
+```
+var readlineq = require('readlineq');
+# read lines with Promise
+var lines = await readlineq('./tmp/stopwords.txt');
+// console.log(lines);
+
+# write lines which is sync by default
+readlineq('./tmp/test.txt', ["foo\n", "bar\n"]);
+// console.log(lines);
+```
+
+# LICENSE
+MIT
+
+[![chatoper banner][co-banner-image]][co-url]
+
+[co-banner-image]: https://user-images.githubusercontent.com/3538629/135558449-9739c98c-30aa-4b49-916b-87182520c0c6.png
+[co-url]: https://www.chatopera.com

package/index.js

@@ -1,92 +1,49 @@
-/**
- * read lines by file path
- */
-const debug = require("debug")("readlineq");
-const fs = require("fs");
-
-/**
- * read file into lines
- * @param  {[type]} file_path [description]
- * @return {[type]}           [description]
- */
-function _read(file_path) {
-  var lines = [];
-  return new Promise((resolve, reject) => {
-    var lineReader = require("readline").createInterface({
-      input: require("fs").createReadStream(file_path),
-    });
-
-    lineReader.on("line", function (line) {
-      debug("Line from file: %s", line);
-      lines.push(line);
-    });
-
-    lineReader.on("close", function (err) {
-      debug("all lines are read, line size %d", lines.length);
-      resolve(lines);
-    });
-
-    lineReader.on("error", function (err) {
-      debug("error happens", err);
-      reject(err);
-    });
-  });
-}
-
-// const JSONStream = require('JSONStream');
-/**
- * Dump huge array to file
- * @param {*} to dump obj to file path
- * @param {*} obj JSONObject or JSONArray
- */
-// function _write(to, obj) {
-//     return new Promise((resolve, reject) => {
-//         var records = obj
-//         var transformStream = JSONStream.stringify();
-//         var outputStream = fs.createWriteStream(to);
-//         transformStream.pipe(outputStream);
-//         records.forEach(transformStream.write);
-//         transformStream.end();
-
-//         outputStream.on(
-//             "finish",
-//             function handleFinish() {
-//                 resolve();
-//             }
-//         );
-
-//         outputStream.on(
-//             "error",
-//             function handleFinish(err) {
-//                 reject(err);
-//             }
-//         );
-//     });
-// }
-//
-/**
- * Write lines to file
- * @param  {[type]} from_ [description]
- * @param  {[type]} to_   [description]
- * @return {[type]}       [description]
- */
-function _write(lines, to_) {
-  if (typeof lines === "string") {
-    fs.writeFileSync(to_, lines);
-  } else if (lines.length > 0) {
-    fs.writeFileSync(to_, lines.join(""));
-  }
-}
-
-/**
- * write or read data
- * @param  {[type]} file_path [description]
- * @param  {[type]} obj       [description]
- * @return {[type]}           [description]
- */
-exports = module.exports = function (file_path, obj) {
-  if (obj) {
-    return _write(obj, file_path);
-  }
-  return _read(file_path);
-};
+/**
+ * read lines by file path
+ */
+import Debug from "debug";
+import fs from "fs";
+
+const debug = Debug("readlineq");
+
+/**
+ * read file into lines
+ * @param  {[type]} file_path [description]
+ * @return {[type]}           [description]
+ */
+function _read(file_path) {
+  let lines = [];
+  const allFileContents = fs.readFileSync(file_path, 'utf-8');
+  allFileContents.split(/\r?\n/).forEach(line => {
+    lines.push(line + "\n");
+  });
+
+  return lines;
+}
+
+/**
+ * Write lines to file
+ * @param  {[type]} from_ [description]
+ * @param  {[type]} to_   [description]
+ * @return {[type]}       [description]
+ */
+function _write(lines, to_) {
+  if (typeof lines === "string") {
+    fs.writeFileSync(to_, lines);
+  } else if (lines.length > 0) {
+    fs.writeFileSync(to_, lines.join(""));
+  }
+}
+
+/**
+ * write or read data
+ * @param  {[type]} file_path [description]
+ * @param  {[type]} obj       [description]
+ * @return {[type]}           [description]
+ */
+export default function (file_path, obj) {
+  if (obj) {
+    return _write(obj, file_path);
+  }
+  return _read(file_path);
+};

package/package.json

@@ -1,33 +1,37 @@
-{
-  "name": "readlineq",
-  "version": "2.0.3",
-  "description": "Read file by lines",
-  "main": "index.js",
-  "directories": {
-    "test": "test"
-  },
-  "scripts": {
-    "test": "ava"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/Samurais/node-readlineq.git"
-  },
-  "keywords": [
-    "text",
-    "read-text",
-    "write-text"
-  ],
-  "author": "Hai Liang Wang <hailiang.hl.wang@gmail.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Samurais/node-readlineq/issues"
-  },
-  "homepage": "https://github.com/Samurais/node-readlineq#readme",
-  "dependencies": {
-    "debug": "^2.6.8"
-  },
-  "devDependencies": {
-    "ava": "^0.21.0"
-  }
-}
+{
+  "name": "readlineq",
+  "version": "3.0.0",
+  "description": "Read or write file by lines with promise.",
+  "main": "index.js",
+  "type": "module",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "ava"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/chatopera/node-readlineq.git"
+  },
+  "keywords": [
+    "text",
+    "read-text",
+    "write-text"
+  ],
+  "author": "Hai Liang Wang <hailiang.hl.wang@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/chatopera/node-readlineq/issues"
+  },
+  "homepage": "https://github.com/chatopera/node-readlineq#readme",
+  "dependencies": {
+    "debug": "^4.4.3"
+  },
+  "devDependencies": {
+    "ava": "^6.4.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/test/index.js

@@ -1,15 +1,14 @@
-var test = require('ava')
-
-test('Readlines # read', async (t)=>{
-    var readlineq = require('../index.js');
-    var lines = await readlineq('./tmp/stopwords.txt');
-    // console.log(lines);
-    t.pass()
-})
-
-test('Readlines # write', async (t)=>{
-    var readlineq = require('../index.js');
-    var lines = await readlineq('./tmp/test.txt', ["foo\n", "bar\n"]);
-    // console.log(lines);
-    t.pass()
+import test from "ava";
+import readlineq from "../index.js";
+
+test('Readlines # read', async (t) => {
+    var lines = readlineq('./tmp/stopwords.txt');
+    console.log(lines);
+    t.pass()
+})
+
+test('Readlines # write', async (t) => {
+    var lines = readlineq('./tmp/test.txt', ["foo\n", "bar\n"]);
+    console.log(lines);
+    t.pass()
 })