Edit docs, add standard for code style, bulk npm version

Author: kikill95

README.md

@@ -1,4 +1,7 @@
 # xlsx-stream-reader
+
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
 ======
 
 Memory efficinet minimalist streaming XLSX reader that can handle piped 
@@ -79,57 +82,56 @@ fs.createReadStream(fileName).pipe(workBookReader);
 
 ```
 
-
 Beta Warning
+
 -------
 This module is currently in use on a live internal business system for product 
 management. That being said this should still be considered beta. More usage 
 and input from users will be needed due to the numerous differences/incompatibilities/flukes 
 I have already run into with XLSX files.
 
-
 Limitations
+
 -------
 The row reader currently returns stored values for formulas (these are normally available)
 and does not calculate the formula itself. As time permits the row handler will be more capable 
 but was enough for currrent purposes (loading values from large worksheets fast)
 
-
-
 Inspiration
+
 -----------
-Need a simple XLSX file streaming reader to handle large excel sheets but only 
-one available/compatible was by guyonroche/exceljs. The stream reader module at 
-the time was unfinished/unusable and rewrite attempts exposed column shifting I 
+Need a simple XLSX file streaming reader to handle large excel sheets but only
+one available/compatible was by guyonroche/exceljs. The stream reader module at
+the time was unfinished/unusable and rewrite attempts exposed column shifting I
 could not solve
 
-
 More Information
+
 -----------
-Events are emmited as pertinent parts of the workbook and worksheet are receieved 
-in the stream. Theoretically you could pause the input stream if events are being 
+Events are emmited as pertinent parts of the workbook and worksheet are receieved
+in the stream. Theoretically you could pause the input stream if events are being
 receieved too fast but this has not been tested
 
-Events can potentially (even though I have not seen it) be receieved out of order, 
-if you receive a worksheet end event while still receieving rows be sure to make sure 
+Events can potentially (even though I have not seen it) be receieved out of order,
+if you receive a worksheet end event while still receieving rows be sure to make sure
 your number of rows receieved equals the `workSheetReader.rowCount` 
 
-Theoretically you could process an excel sheet as it is being uploaded, depending 
-on the sheet type, but untried (I encountered some XLSX files that have a different 
-zip format that requires having the entire file to read the archive contents properly), 
+Theoretically you could process an excel sheet as it is being uploaded, depending
+on the sheet type, but untried (I encountered some XLSX files that have a different
+zip format that requires having the entire file to read the archive contents properly),
 but still probably better to save temp first and read streasm from there.
 
-Currently if the zip archive does not have the shared strings at the begining of the 
-archive then the input stream for each sheet is pied into a temp file until the shared 
-string are encountered and processed, then re-read the temp worksheets with the shared 
-strings. 
-
+Currently if the zip archive does not have the shared strings at the begining of the
+archive then the input stream for each sheet is pied into a temp file until the shared
+string are encountered and processed, then re-read the temp worksheets with the shared
+strings.
 
 API Information
+
 -----------
 #### new XlsxStreamReader()
 
-Create a new XlsxStreamReader object (workBookReader). After attaching handlers you 
+Create a new XlsxStreamReader object (workBookReader). After attaching handlers you
 can `pipe()` your input stream into the reader to begin processing
 
 #### Event: 'error'
@@ -150,7 +152,7 @@ are available via array `workBookReader.workBookSharedStrings`.
 
 #### Event: 'styles'
 
-After the workbook styles have been parsed this event is emmited. Styles are available 
+After the workbook styles have been parsed this event is emmited. Styles are available
 via array `workBookReader.workBookStyles`
 
 #### Event: 'worksheet'
@@ -161,8 +163,8 @@ Emmitted when a worksheet is reached. The sheet number is availble via
 {Number} `workSheetReader.id`. You can either process or skip at this point, 
 but you must do one for the processing to the next sheet to continue/finish.
 
-Once event is recieved you can attach worksheet on handlers (end, row) then you 
-would `workSheetReader.process()`. If you do not want to process a sheet and instead 
+Once event is recieved you can attach worksheet on handlers (end, row) then you
+would `workSheetReader.process()`. If you do not want to process a sheet and instead
 want to skip entirely, you would `workSheetReader.skip()` without attaching any handlers.
 
 #### Worksheet Event: 'end'
@@ -178,44 +180,43 @@ Emmitted on every row encountered in the worksheet. for more details on what
 is in the row object attributes, see the [Row class][msdnRows] on MSDN.  
 
 For example:
+
 * `row.values`: sparse array containing all cell values
 * `row.formulas`: sparse array containing all cell formulas
 * `row.attributes.r`: row index
 * `row.attributes.ht`: Row height measured in point size
 * `row.attributes.customFormat`: '1' if the row style should be applied.
 * `row.attributes.hidden`: '1' if the row is hidden
 
-
 References
+
 -----------
 * [Working with sheets (Open XML SDK)][msdnSheets]
 * [Row class][msdnRows]
 * [ExcelJS][ExcelJS]
 
-
 Used Modules
+
 -----------
 * [Path][modPath]
 * [Util][modUtil]
 * [Stream][modStream]
 * [Sax][modSax]
-* [Unzip2][modUnzip2]
+* [unzipper][modUnzipper]
 * [Temp][modTemp]
 
-
 Authors
+
 -----------
-Written by [Brian Taber](https://github.com/DaSpawn) 
+Written by [Brian Taber](https://github.com/DaSpawn) and [Kirill Husyatin](https://github.com/kikill95)
 
 [![DaSpawn's Gratipay][gratipay-image-daspawn]][gratipay-url-daspawn]
 
-
 License
+
 -----------
 [MIT](LICENSE)
 
-
-
 [gratipay-url-daspawn]: https://gratipay.com/~DaSpawn
 [gratipay-image-daspawn]: https://img.shields.io/gratipay/team/daspawn.svg
 [msdnRows]: https://msdn.microsoft.com/EN-US/library/office/documentformat.openxml.spreadsheet.row.aspx
@@ -226,5 +227,5 @@ License
 [modStream]: https://nodejs.org/api/stream.html
 [modUtil]: https://nodejs.org/api/util.html
 [modSax]: https://github.com/isaacs/sax-js
-[modUnzip2]: https://github.com/glebdmitriew/node-unzip-2
+[modUnzipper]: https://github.com/ZJONSSON/node-unzipper
 [modTemp]: https://github.com/bruce/node-temp

example/example1.js

@@ -2,46 +2,45 @@
  * xlsx-stream-reader
  * Copyright(c) 2016 Brian Taber
  * MIT Licensed
- * 
+ *
  * example1
- * 
+ *
  */
 
-'use strict';
+'use strict'
 
+const fs = require('fs')
+const XlsxStreamReader = require('../')
 
-const fs = require("fs");
-const XlsxStreamReader = require("../");
-
-var workBookReader = new XlsxStreamReader();
+var workBookReader = new XlsxStreamReader()
 workBookReader.on('error', function (error) {
-    throw(error);
-});
+  throw (error)
+})
 
 workBookReader.on('worksheet', function (workSheetReader) {
-    if (workSheetReader.id > 1){
-        // we only want first sheet
-        console.log("Skip Worksheet:",workSheetReader.id)
-        workSheetReader.skip();
-        return; 
-    }
-    console.log("Worksheet:",workSheetReader.id)
-
-    workSheetReader.on('row', function (row) {
-        row.values.forEach(function(rowVal, colNum){
-            console.log("RowNum", row.attributes.r, "colNum", colNum, "rowValLen", rowVal.length, "rowVal", "'" + rowVal + "'")
-        });
-    });
-
-    workSheetReader.on('end', function () {
-        console.log("Worksheet",workSheetReader.id,"rowCount:",workSheetReader.rowCount)
-    });
-
-    // call process after registering handlers
-    workSheetReader.process();
-});
+  if (workSheetReader.id > 1) {
+    // we only want first sheet
+    console.log('Skip Worksheet:', workSheetReader.id)
+    workSheetReader.skip()
+    return
+  }
+  console.log('Worksheet:', workSheetReader.id)
+
+  workSheetReader.on('row', function (row) {
+    row.values.forEach(function (rowVal, colNum) {
+      console.log('RowNum', row.attributes.r, 'colNum', colNum, 'rowValLen', rowVal.length, 'rowVal', "'" + rowVal + "'")
+    })
+  })
+
+  workSheetReader.on('end', function () {
+    console.log('Worksheet', workSheetReader.id, 'rowCount:', workSheetReader.rowCount)
+  })
+
+  // call process after registering handlers
+  workSheetReader.process()
+})
 workBookReader.on('end', function () {
-    console.log("finished!")
-});
+  console.log('finished!')
+})
 
-fs.createReadStream('example/example1.xlsx').pipe(workBookReader);
+fs.createReadStream('example/example1.xlsx').pipe(workBookReader)

example/example2.js

@@ -2,46 +2,45 @@
  * xlsx-stream-reader
  * Copyright(c) 2016 Brian Taber
  * MIT Licensed
- * 
+ *
  * example1
- * 
+ *
  */
 
-'use strict';
+'use strict'
 
+const fs = require('fs')
+const XlsxStreamReader = require('../')
 
-const fs = require("fs");
-const XlsxStreamReader = require("../");
-
-var workBookReader = new XlsxStreamReader();
+var workBookReader = new XlsxStreamReader()
 workBookReader.on('error', function (error) {
-    throw(error);
-});
+  throw (error)
+})
 
 workBookReader.on('worksheet', function (workSheetReader) {
-    if (workSheetReader.id > 1){
-        // we only want first sheet
-        console.log("Skip Worksheet:",workSheetReader.id)
-        workSheetReader.skip();
-        return; 
-    }
-    console.log("Worksheet:",workSheetReader.id)
-
-    workSheetReader.on('row', function (row) {
-        row.values.forEach(function(rowVal, colNum){
-            console.log("RowNum", row.attributes.r, "colNum", colNum, "rowValLen", rowVal.length, "rowVal", "'" + rowVal + "'")
-        });
-    });
-
-    workSheetReader.on('end', function () {
-        console.log("Worksheet",workSheetReader.id,"rowCount:",workSheetReader.rowCount)
-    });
-
-    // call process after registering handlers
-    workSheetReader.process();
-});
+  if (workSheetReader.id > 1) {
+    // we only want first sheet
+    console.log('Skip Worksheet:', workSheetReader.id)
+    workSheetReader.skip()
+    return
+  }
+  console.log('Worksheet:', workSheetReader.id)
+
+  workSheetReader.on('row', function (row) {
+    row.values.forEach(function (rowVal, colNum) {
+      console.log('RowNum', row.attributes.r, 'colNum', colNum, 'rowValLen', rowVal.length, 'rowVal', "'" + rowVal + "'")
+    })
+  })
+
+  workSheetReader.on('end', function () {
+    console.log('Worksheet', workSheetReader.id, 'rowCount:', workSheetReader.rowCount)
+  })
+
+  // call process after registering handlers
+  workSheetReader.process()
+})
 workBookReader.on('end', function () {
-    console.log("finished!")
-});
+  console.log('finished!')
+})
 
-fs.createReadStream('example2.xlsx').pipe(workBookReader);
+fs.createReadStream('example2.xlsx').pipe(workBookReader)