Native JS is package main, tidied up test code

Author: guyonroche

README.md

@@ -18,37 +18,24 @@ npm install exceljs
 
 # New Features!
 
-**Major Version Change**
+** Another Major Version Change**
 
-Introducing async/await to ExcelJS!
-The new async and await features of JavaScript can help a lot to make code more readable and maintainable.
-To avoid confusion, particularly with returned promises from async functions, we have had to remove the
-Promise class configuration option and from v2 onwards ExcelJS will use native Promises.
-Since this is potentially a breaking change we're bumping the major version for this release.
+Javascript has changed a lot over the years, and so have the modules and technologies surrounding it.
+To this end, this major version of ExcelJS changes the structure of the publish artefacts:
 
-**Changes**
+** Main Export is now the Original Javascript Source **
 
-<ul>
-  <li>
-    Merged <a href="https://github.com/exceljs/exceljs/pull/829">Introduce async/await #829</a>.
-    Many thanks to <a href="https://github.com/alubbe">Andreas Lubbe</a> for this contribution.
-  </li>
-  <li>
-    Merged <a href="https://github.com/exceljs/exceljs/pull/930">Update index.d.ts #930</a>.
-    Many thanks to <a href="https://github.com/cosmonovallc">cosmonovallc</a> for this contributions.
-  </li>
-  <li>
-    Merged <a href="https://github.com/exceljs/exceljs/pull/940">TS: Add types for addTable function #940</a>.
-    Many thanks to <a href="https://github.com/egmen">egmen</a> for this contributions.
-  </li>
-  <li>
-    Merged <a href="https://github.com/exceljs/exceljs/pull/926">added explicit return types to the type definitions of Worksheet.protect() and Worksheet.unprotect() #926</a>.
-    Many thanks to <a href="https://github.com/drjokepu">Tamas Czinege</a> for this contributions.
-  </li>
-  <li>
-    Dropped dependencies on Promise libraries.
-  </li>
-</ul>
+Prior to this release, the transpiled ES5 code was exported as the package main.
+From now on, the package main comes directly from the lib/ folder
+
+** ES5 and Browserify are Still Included **
+
+In order to support those that still require ES5 ready code (e.g. as dependencies in web apps)
+the source code will still be transpiled and available  in dist/es5.
+
+The ES5 code is also browserified and available as dist/exceljs.js or dist/exceljs.min.js
+
+* See the section <a href="#importing">Importing</a> for details *
 
 # Contributions
 
@@ -72,6 +59,7 @@ To be clear, all contributions added to this library will be included in the lib
 # Contents
 
 <ul>
+  <li><a href="#importing">Importing</a></li>
   <li>
     <a href="#interface">Interface</a>
     <ul>
@@ -164,6 +152,38 @@ To be clear, all contributions added to this library will be included in the lib
   <li><a href="#release-history">Release History</a></li>
 </ul>
 
+# Importing
+
+```javascript
+const ExcelJS = require('exceljs');
+```
+
+## ES5 Imports
+
+To use the ES5 transpiled code, use the dist/es5 path.
+
+```javascript
+const ExcelJS = require('exceljs/dist/es5');
+```
+
+**Note:** The ES5 build has an implicit dependency on a number of polyfills.
+ You will need to include the following requires in your code before the exceljs import:
+
+```javascript
+// polyfills required by exceljs
+require('core-js/modules/es.promise');
+require('core-js/modules/es.object.assign');
+require('core-js/modules/es.object.keys');
+require('regenerator-runtime/runtime');
+```
+
+## Browserify
+
+```html
+<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.js"></script>
+<script src="exceljs.js"></script>
+```
+
 # Interface
 
 ## Importing
@@ -2323,4 +2343,4 @@ If any splice operation affects a merged cell, the merge group will not be moved
 | 1.13.0  | <ul> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/862">zip: allow tuning compression for performance or size #862</a>. Many thanks to <a href="https://github.com/myfreeer">myfreeer</a> for this contribution. </li> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/863">Feat configure headers and footers #863</a>. Many thanks to <a href="https://github.com/autukill">autukill</a> for this contribution. </li> <li> Fixed an issue with defaultRowHeight where the default value resulted in 'customHeight' property being set. </li> </ul> |
 | 1.14.0  | <ul> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/874">Fix header and footer text format error in README.md #874</a>. Many thanks to <a href="https://github.com/autukill">autukill</a> for this contribution. </li> <li> Added Tables. See <a href="#tables">Tables</a> for details. </li> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/887">fix: #877 and #880</a>. Many thanks to <a href="https://github.com/aexei">Alexander Heinrich</a> for this contribution. This fixes <a href="https://github.com/exceljs/exceljs/pull/877">bug: Hyperlink without text crashes write #877</a> and <a href="https://github.com/exceljs/exceljs/pull/880">bug: malformed comment crashes on write #880</a> </li> </ul> |
 | 1.15.0  | <ul> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/889">Add Compression level option to WorkbookWriterOptions for streaming #889</a>. Many thanks to <a href="https://github.com/ABenassi87">Alfredo Benassi</a> for this contribution. </li> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/903">Feature/Cell Protection #903</a> and <a href="https://github.com/exceljs/exceljs/pull/907">Feature/Sheet Protection #907</a>. Many thanks to <a href="https://github.com/karabaesh">karabaesh</a> for these contributions. </li> </ul> |
-
+| 2.0.1   | <h2>Major Version Change</h2> <p>Introducing async/await to ExcelJS!</p> <p>The new async and await features of JavaScript can help a lot to make code more readable and maintainable. To avoid confusion, particularly with returned promises from async functions, we have had to remove the Promise class configuration option and from v2 onwards ExcelJS will use native Promises. Since this is potentially a breaking change we're bumping the major version for this release.</p> <h2>Changes</h2> <ul> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/829">Introduce async/await #829</a>. Many thanks to <a href="https://github.com/alubbe">Andreas Lubbe</a> for this contribution. </li> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/930">Update index.d.ts #930</a>. Many thanks to <a href="https://github.com/cosmonovallc">cosmonovallc</a> for this contributions. </li> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/940">TS: Add types for addTable function #940</a>. Many thanks to <a href="https://github.com/egmen">egmen</a> for this contributions. </li> <li> Merged <a href="https://github.com/exceljs/exceljs/pull/926">added explicit return types to the type definitions of Worksheet.protect() and Worksheet.unprotect() #926</a>. Many thanks to <a href="https://github.com/drjokepu">Tamas Czinege</a> for this contributions. </li> <li> Dropped dependencies on Promise libraries. </li> </ul> |

lib/exceljs.nodejs.js

@@ -1,8 +1,3 @@
-require('core-js/modules/es.promise');
-require('core-js/modules/es.object.assign');
-require('core-js/modules/es.object.keys');
-require('regenerator-runtime/runtime');
-
 const ExcelJS = {
   Workbook: require('./doc/workbook'),
   ModelContainer: require('./doc/modelcontainer'),

package.json

@@ -15,8 +15,8 @@
   "engines": {
     "node": ">=6.0.0"
   },
-  "main": "./dist/es5/index.js",
-  "browser": "./dist/es5/exceljs.browser.js",
+  "main": "./lib/exceljs.nodejs.js",
+  "browser": "./dist/exceljs.min.js",
   "types": "./index.d.ts",
   "files": [
     "dist",
@@ -31,11 +31,16 @@
     "pretest": "npm run build",
     "test": "npm run test:full",
     "test:full": "npm run test:unit && npm run test:integration && npm run test:end-to-end && npm run test:browser",
-    "test:unit": "mocha --require spec/config/setup spec/unit --require spec/config/setup-unit --recursive",
+    "test:all": "npm run test:native && npm run test:es5",
+    "test:native": "npm run test:full",
+    "test:es5": "export EXCEL_BUILD=es5 && npm run test:full",
+    "test:unit": "mocha --require spec/config/setup --require spec/config/setup-unit spec/unit --recursive",
     "test:integration": "mocha --require spec/config/setup spec/integration --recursive",
     "test:end-to-end": "mocha --require spec/config/setup spec/end-to-end --recursive",
-    "test:browser": "if [ ! -f .disable-test-browser ]; then ./node_modules/.bin/grunt jasmine; fi ",
-    "test:native-integration": "export EXCEL_NATIVE=yes && mocha --require spec/config/setup spec/integration --recursive",
+    "test:browser": "if [ ! -f .disable-test-browser ]; then ./node_modules/.bin/grunt jasmine; fi",
+    "test:unit:es5": "export EXCEL_BUILD=es5 && npm run test:unit",
+    "test:integration:es5": "export EXCEL_BUILD=es5 && npm run test:integration",
+    "test:end-to-end:es5": "export EXCEL_BUILD=es5 && npm run test:end-to-end",
     "test:manual": "node spec/manual/app.js",
     "clean-build": "npm run clean && npm run build",
     "lint": "eslint --format node_modules/eslint-friendly-formatter .",
@@ -84,11 +89,9 @@
   ],
   "dependencies": {
     "archiver": "^3.0.0",
-    "core-js": "^3.2.1",
     "fast-csv": "^2.4.1",
     "jszip": "^3.1.5",
     "dayjs": "^1.8.15",
-    "regenerator-runtime": "^0.13.3",
     "sax": "^1.2.4",
     "tmp": "^0.1.0",
     "unzipper": "^0.9.12"
@@ -102,6 +105,7 @@
     "chai": "^4.2.0",
     "chai-datetime": "^1.5.0",
     "chai-xml": "^0.3.2",
+    "core-js": "^3.2.1",
     "dirty-chai": "^2.0.1",
     "eslint": "^5.7.0",
     "eslint-config-airbnb": "^17.1.0",
@@ -125,6 +129,7 @@
     "mocha": "^5.2.0",
     "prettier-eslint": "^8.8.1",
     "prettier-eslint-cli": "^4.6.1",
+    "regenerator-runtime": "^0.13.3",
     "request": "^2.88.0",
     "semver": "^5.6.0",
     "uglify-js": "^3.4.9"

spec/.eslintrc

@@ -10,6 +10,7 @@
     "no-underscore-dangle": ["off"]
   },
   "globals": {
+    "verquire": true,
     "describe": true,
     "expect": true,
     "before": true,

spec/config/setup.js

@@ -3,7 +3,9 @@ const chai = require('chai');
 const chaiXml = require('chai-xml');
 const chaiDatetime = require('chai-datetime');
 const dirtyChai = require('dirty-chai');
+global.verquire = require('../utils/verquire');
 
 chai.use(chaiXml);
 chai.use(chaiDatetime);
 chai.use(dirtyChai);
+

spec/end-to-end/express.spec.js

@@ -1,11 +1,8 @@
-'use strict';
-
 const express = require('express');
 const request = require('request');
-const verquire = require('../utils/verquire');
 const testutils = require('../utils/index');
 
-const Excel = verquire('excel');
+const Excel = verquire('exceljs');
 
 // =============================================================================
 // Tests

spec/integration/gold.spec.js

@@ -1,11 +1,6 @@
-'use strict';
+const {expect} = require('chai');
 
-const chai = require('chai');
-const verquire = require('../utils/verquire');
-
-const Excel = verquire('excel');
-
-const { expect } = chai;
+const ExcelJS = verquire('exceljs');
 
 // =============================================================================
 // This spec is based around a gold standard Excel workbook 'gold.xlsx'
@@ -14,7 +9,7 @@ describe('Gold Book', () => {
   describe('Read', () => {
     let wb;
     before(() => {
-      wb = new Excel.Workbook();
+      wb = new ExcelJS.Workbook();
       return wb.xlsx.readFile(`${__dirname}/data/gold.xlsx`);
     });
 
@@ -40,6 +35,7 @@ describe('Gold Book', () => {
       });
     });
 
-    it('Styles', () => {});
+    it('Styles', () => {
+    });
   });
 });

spec/integration/issues/issue-163-xlsx-read-file.spec.js

@@ -1,15 +1,10 @@
-'use strict';
+const {expect} = require('chai');
 
-const chai = require('chai');
-const verquire = require('../../utils/verquire');
-
-const Excel = verquire('excel');
-
-const { expect } = chai;
+const ExcelJS = verquire('exceljs');
 
 describe('github issues', () => {
   it('issue 163 - Error while using xslx readFile method', () => {
-    const wb = new Excel.Workbook();
+    const wb = new ExcelJS.Workbook();
     return wb.xlsx
       .readFile('./spec/integration/data/test-issue-163.xlsx')
       .then(() => {

spec/integration/issues/issue-176-unexpected-xml-node.spec.js

@@ -1,16 +1,10 @@
-'use strict';
+const {expect} = require('chai');
 
-const chai = require('chai');
-
-const verquire = require('../../utils/verquire');
-
-const Excel = verquire('excel');
-
-const { expect } = chai;
+const ExcelJS = verquire('exceljs');
 
 describe('github issues', () => {
   it('issue 176 - Unexpected xml node in parseOpen', () => {
-    const wb = new Excel.Workbook();
+    const wb = new ExcelJS.Workbook();
     return wb.xlsx
       .readFile('./spec/integration/data/test-issue-176.xlsx')
       .then(() => {

spec/integration/issues/issue-219-1904-dates.spec.js

@@ -1,20 +1,14 @@
-'use strict';
+const {expect} = require('chai');
 
-const chai = require('chai');
-
-const verquire = require('../../utils/verquire');
-
-const Excel = verquire('excel');
-
-const { expect } = chai;
+const ExcelJS = verquire('exceljs');
 
 // this file to contain integration tests created from github issues
 const TEST_XLSX_FILE_NAME = './spec/out/wb.test.xlsx';
 
 describe('github issues', () => {
   describe('issue 219 - 1904 dates not supported', () => {
     it('Reading 1904.xlsx', () => {
-      const wb = new Excel.Workbook();
+      const wb = new ExcelJS.Workbook();
       return wb.xlsx.readFile('./spec/integration/data/1904.xlsx').then(() => {
         expect(wb.properties.date1904).to.equal(true);
 
@@ -25,14 +19,14 @@ describe('github issues', () => {
       });
     });
     it('Writing and Reading', () => {
-      const wb = new Excel.Workbook();
+      const wb = new ExcelJS.Workbook();
       wb.properties.date1904 = true;
       const ws = wb.addWorksheet('Sheet1');
       ws.getCell('B4').value = new Date('1904-01-01T00:00:00.000Z');
       return wb.xlsx
         .writeFile(TEST_XLSX_FILE_NAME)
         .then(() => {
-          const wb2 = new Excel.Workbook();
+          const wb2 = new ExcelJS.Workbook();
           return wb2.xlsx.readFile(TEST_XLSX_FILE_NAME);
         })
         .then(wb2 => {

spec/integration/issues/issue-234-vertical-tab-char.spec.js

@@ -1,19 +1,13 @@
-'use strict';
+const {expect} = require('chai');
 
-const chai = require('chai');
-
-const verquire = require('../../utils/verquire');
-
-const Excel = verquire('excel');
-
-const { expect } = chai;
+const ExcelJS = verquire('exceljs');
 
 // this file to contain integration tests created from github issues
 const TEST_XLSX_FILE_NAME = './spec/out/wb.test.xlsx';
 
 describe('github issues', () => {
   it('issue 234 - Broken XLSX because of "vertical tab" ascii character in a cell', () => {
-    const wb = new Excel.Workbook();
+    const wb = new ExcelJS.Workbook();
     const ws = wb.addWorksheet('Sheet1');
 
     // Start of Heading
@@ -25,7 +19,7 @@ describe('github issues', () => {
     return wb.xlsx
       .writeFile(TEST_XLSX_FILE_NAME)
       .then(() => {
-        const wb2 = new Excel.Workbook();
+        const wb2 = new ExcelJS.Workbook();
         return wb2.xlsx.readFile(TEST_XLSX_FILE_NAME);
       })
       .then(wb2 => {

spec/integration/issues/issue-257-sheet-order.spec.js

@@ -1,15 +1,10 @@
-'use strict';
+const {expect} = require('chai');
 
-const chai = require('chai');
-const verquire = require('../../utils/verquire');
-
-const Excel = verquire('excel');
-
-const { expect } = chai;
+const ExcelJS = verquire('exceljs');
 
 describe('github issues', () => {
   it('issue 257 - worksheet order is not respected', () => {
-    const wb = new Excel.Workbook();
+    const wb = new ExcelJS.Workbook();
     return wb.xlsx
       .readFile('./spec/integration/data/test-issue-257.xlsx')
       .then(() => {