Testing compatibility of HF with Excel and Sheets (#1537)

* Add test/compatibility subdirectory

* Install exceljs lib

* Compare evaluation results

* Use epsilon to compare numbers

* Handle cell errors

* Add script that runs all the test files in a loop

* Handle null-like values in xlsx files

* Update file-import guide in the docs to handle empty cells correctly

* Add test:compatibility to npm run test script

* Add test/compatibility/README.md file

Author: sequba

.eslintignore

@@ -11,6 +11,7 @@ src/interpreter/plugin/3rdparty
 *.config.js
 karma.*
 doc
+test/unit/_setupFiles/*.js
 
 # Auto-generated directories
 commonjs
@@ -25,4 +26,3 @@ test-jasmine
 test-jest
 typedoc
 typings
-test/_setupFiles/*.js

DEV_DOCS.md

@@ -0,0 +1,9 @@
+# Dev Docs
+
+Random notes and things to know useful for maintainers and contributors.
+
+## Sources of the function translations
+
+HF supports internationalization and provides the localized function names for all built-in languages. When looking for the valid translations for the new functions, try these sources:
+- https://support.microsoft.com/en-us/office/excel-functions-translator-f262d0c0-991c-485b-89b6-32cc8d326889
+- http://dolf.trieschnigg.nl/excel/index.php

docs/guide/file-import.md

@@ -16,7 +16,7 @@ To import XLSX files, use a third-party [XLSX parser](https://www.npmjs.com/sear
 
 ### Example: Import XLSX files in Node
 
-This example uses [ExcelJS](https://www.npmjs.com/package/exceljs) to import XLSX files into HyperFormula. 
+This example uses [ExcelJS](https://www.npmjs.com/package/exceljs) to import XLSX files into HyperFormula.
 
 See full example on [GitHub](https://github.com/handsontable/hyperformula-demos/tree/3.0.x/read-excel-file).
 
@@ -43,18 +43,21 @@ function convertXlsxWorkbookToJavascriptArrays(workbook) {
   const workbookData = {};
 
   workbook.eachSheet((worksheet) => {
+    const sheetDimensions = worksheet.dimensions
     const sheetData = [];
 
-    worksheet.eachRow((row) => {
+    for (let rowNum = sheetDimensions.top; rowNum <= sheetDimensions.bottom; rowNum++) {
       const rowData = [];
 
-      row.eachCell((cell) => {
+      for (let colNum = sheetDimensions.left; colNum <= sheetDimensions.right; colNum++) {
+        const cell = worksheet.getCell(rowNum, colNum)
+
         const cellData = cell.formula ? `=${cell.formula}` : cell.value;
         rowData.push(cellData);
-      });
+      }
 
       sheetData.push(rowData);
-    });
+    }
 
     workbookData[worksheet.name] = sheetData;
   })

jest.config.js

@@ -14,12 +14,12 @@ module.exports = {
   coverageDirectory: "coverage",
 
   // A path to a module which exports an async function that is triggered once before all test suites
-  globalSetup: '<rootDir>/test/_setupFiles/globalSetup.ts',
+  globalSetup: '<rootDir>/test/unit/_setupFiles/globalSetup.ts',
 
   // A set of global variables that need to be available in all test environments
   globals: {
     "ts-jest": {
-      "tsconfig": "./test/tsconfig.json"
+      "tsconfig": "./test/unit/tsconfig.json"
     }
   },
 
@@ -32,16 +32,16 @@ module.exports = {
 
   // The paths to modules that run some code to configure or set up the testing environment after each test
   setupFilesAfterEnv: [
-    '<rootDir>/test/_setupFiles/bootstrap.ts',
-    '<rootDir>/test/_setupFiles/jest/bootstrap.ts'
+    '<rootDir>/test/unit/_setupFiles/bootstrap.ts',
+    '<rootDir>/test/unit/_setupFiles/jest/bootstrap.ts'
   ],
 
   // The test environment that will be used for testing
   testEnvironment: "node",
 
   // The glob patterns Jest uses to detect test files
   testMatch: [
-    "<rootDir>/test/**/*spec.(ts|js)"
+    "<rootDir>/test/unit/**/*spec.(ts|js)"
   ],
 
   silent: true,

karma.starter.ts

@@ -1,11 +1,11 @@
-import './test/_setupFiles/bootstrap';
+import './test/unit/_setupFiles/bootstrap';
 
 //@ts-ignore
 const specArg: string = __karma__.config.spec;
 
 // require all modules ending in ".spec.ts" from the
 // './test' directory and all subdirectories
-const testsContext = require.context('./test', true, /.spec.ts$/);
+const testsContext = require.context('./test/unit', true, /.spec.ts$/);
 let files = testsContext.keys();
 
 if (specArg) {