Merge branch 'release/2.2.0'

Author: sequba

.config/webpack/languages.js

@@ -11,8 +11,6 @@ const WebpackOnBuildPlugin = require('on-build-webpack');
 const fs  = require('fs');
 const fsExtra  = require('fs-extra');
 
-const PACKAGE_FILENAME = process.env.HOT_FILENAME;
-
 function getEntryJsFiles() {
   const entryObject = {};
   const filesInLanguagesDirectory = fs.readdirSync(SOURCE_LANGUAGES_DIRECTORY);

.eslintrc.js

@@ -4,6 +4,7 @@ module.exports = {
   plugins: [
     '@typescript-eslint',
     'license-header',
+    'jsdoc',
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
@@ -67,6 +68,42 @@ module.exports = {
     '@typescript-eslint/no-unused-vars': ['warn', { 'argsIgnorePattern': '^_' }],
     '@typescript-eslint/no-explicit-any': 'warn',
     '@typescript-eslint/interface-name-prefix': 'warn',
+
+    "jsdoc/check-access": 'warn',
+    "jsdoc/check-alignment": 'warn',
+    "jsdoc/check-param-names": 'warn',
+    "jsdoc/check-property-names": 'warn',
+    "jsdoc/check-tag-names": 'warn',
+    "jsdoc/check-types": 'warn',
+    "jsdoc/empty-tags": 'warn',
+    "jsdoc/implements-on-classes": 'warn',
+    "jsdoc/multiline-blocks": 'warn',
+    "jsdoc/newline-after-description": 'warn',
+    "jsdoc/no-multi-asterisks": 'warn',
+    "jsdoc/no-undefined-types": 'warn',
+    "jsdoc/require-param-description": 'warn',
+    "jsdoc/require-param-name": 'warn',
+    "jsdoc/require-param-type": 'warn',
+    "jsdoc/require-property-description": 'warn',
+    "jsdoc/require-property-name": 'warn',
+    "jsdoc/require-property-type": 'warn',
+    "jsdoc/require-returns-check": 'warn',
+    "jsdoc/require-returns-description": 'warn',
+    "jsdoc/require-returns-type": 'warn',
+    "jsdoc/require-yields": 'warn',
+    "jsdoc/require-yields-check": 'warn',
+    "jsdoc/tag-lines": 'warn',
+    "jsdoc/valid-types": 'warn',
+    "jsdoc/require-jsdoc": ['warn', {
+      require: {
+        ArrowFunctionExpression: true,
+        ClassDeclaration: true,
+        ClassExpression: true,
+        FunctionDeclaration: true,
+        FunctionExpression: true,
+        MethodDefinition: true,
+      }
+    }],
   },
   overrides: [
     {

.github/workflows/publish.yml

@@ -35,3 +35,4 @@ jobs:
           publish_dir: docs/.vuepress/dist
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages
+          cname: hyperformula.handsontable.com # as in https://github.com/peaceiris/actions-gh-pages/blob/ba0b7df03e25ff29c924be8149041119e9421ea6/README.md#%EF%B8%8F-cname

.gitignore

@@ -1,23 +1,23 @@
 .idea/
-commonjs/
-coverage/
-dist/
-doc/
-docs/api/
-docs/functions/
-docs/.vuepress/dist/
-docs/.vuepress/api-sidebar-relative.json
-docs/.vuepress/api-sidebar.json
-typedoc/
-es/
-languages/
-lib/
-test-jasmine/
-test-jest/
+.vscode
+/commonjs/
+/coverage/
+/dist/
+/doc/
+/docs/api/
+/docs/functions/
+/docs/.vuepress/dist/
+/docs/.vuepress/api-sidebar-relative.json
+/docs/.vuepress/api-sidebar.json
+/typedoc/
+/es/
+/languages/
+/lib/
+/test-jasmine/
+/test-jest/
 node_modules/
-typings/
+/typings/
 
 *.iml
 dev*.html
-yarn-error.log
 .DS_Store

CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.2.0] - 2022-11-17
+
+### Added
+- Added an American English (`enUS`) language pack. It's a convenience alias: it contains the same translations as the existing British English (`enGB`) language pack. [#1025](https://github.com/handsontable/hyperformula/issues/1025)
+
+### Fixed
+- Fixed functions VLOOKUP and HLOOKUP to handle duplicates in the way specified by the [OpenDocument](https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part4-formula/OpenDocument-v1.3-os-part4-formula.html#HLOOKUP) standard. [#1072](https://github.com/handsontable/hyperformula/issues/1072)
+- Fixed the MATCH function to handle descending ranges in the way specified by the [OpenDocument](https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part4-formula/OpenDocument-v1.3-os-part4-formula.html#MATCH) standard. [#1063](https://github.com/handsontable/hyperformula/issues/1063)
+
 ## [2.1.0] - 2022-09-08
 
 ### Added

README.md

@@ -25,7 +25,8 @@
 
 HyperFormula is a headless spreadsheet built on top of TypeScript. It is a parser and evaluator of Excel formulas for web applications. You can use it in a browser or as a service, with Node.js as your back-end technology.
 - High-speed Excel formula parsing and evaluating
-- A library of [380+ built-in functions](https://hyperformula.handsontable.com/guide/built-in-functions.html) available in 16 languages
+- A library of nearly [400 built-in functions](https://hyperformula.handsontable.com/guide/built-in-functions.html)
+- Support for [internationalization](https://hyperformula.handsontable.com/guide/i18n-features.html) with 17 built-in languages
 - Support for [custom functions](https://hyperformula.handsontable.com/guide/custom-functions.html)
 - Function syntax compatible with [Microsoft Excel](https://hyperformula.handsontable.com/guide/compatibility-with-microsoft-excel.html) and [Google Sheets](https://hyperformula.handsontable.com/guide/compatibility-with-google-sheets.html)
 - [Support for Node.js](https://hyperformula.handsontable.com/guide/server-side-installation.html#install-with-npm-or-yarn)

circle.yml

@@ -203,6 +203,7 @@ module.exports = {
           title: 'Internationalization',
           collapsable: false,
           children: [
+            ['/guide/i18n-features', 'Internationalization features'],
             ['/guide/localizing-functions', 'Localizing functions'],
             ['/guide/date-and-time-handling', 'Date and time handling'],
           ]
@@ -226,6 +227,7 @@ module.exports = {
             ['/guide/custom-functions', 'Custom functions'],
             ['/guide/performance', 'Performance'],
             ['/guide/known-limitations', 'Known limitations'],
+            ['/guide/file-import', 'File import'],
           ]
         },
         {

docs/.vuepress/config.js

@@ -14,7 +14,7 @@ This section contains information about the class for creating HyperFormula inst
 The snippet shows an example how to use `buildFromArray` which is one of [three static methods](/api/classes/hyperformula.html#factories) for creating an instance of HyperFormula:
 ```javascript
 const sheetData = [
-  ['0', '=SUM(1,2,3)', '52'],
+  ['0', '=SUM(1, 2, 3)', '52'],
   ['=SUM(A1:C1)', '', '=A1'],
   ['2', '=SUM(A1:C1)', '91'],
 ];

docs/api-template.md

@@ -122,7 +122,7 @@ console.log(winningTeam)
 ## Demo
 
 <iframe
-     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.1.x/advanced-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
+     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.2.x/advanced-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
      style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
      title="handsontable/hyperformula-demos: advanced-usage"
      allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"

docs/guide/advanced-usage.md

@@ -7,7 +7,7 @@ Use array formulas to perform an operation (or call a function) on multiple cell
 In HyperFormula, an array can be:
 * A range of cell addresses (e.g. `A1:A10`)
 * A result of an arithmetic operation (e.g. `5*A1:B5`)
-* A result of a function (e.g. `=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5,2,2))`)
+* A result of a function (e.g. `=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5, 2, 2))`)
 * An **inline array**: an ad-hoc array that doesn't refer to any range of cells (e.g. `{1, 3, 5}`)
 
 An array is inherently a two-dimensional object.
@@ -28,7 +28,7 @@ Every row must be of equal length.
 If an inline array contains a cell reference, and the cell's value changes, the array is not updated.
 :::
 
-```js
+```
 = {1, 2, 3} // an inline array with a single row
 = {1, 2 ; 3, 4} // an inline array with two rows
 = SUM({1, 2, 3}) // an inline array as an argument of a function
@@ -49,20 +49,20 @@ You can enable the array arithmetic mode:
 
 To enable the array arithmetic mode once, within a particular function or formula, use the `ARRAYFORMULA` function:
 
-| Syntax | Example |
-| :--- | :--- |
-| `ARRAYFORMULA(your_array_formula)` | `=ARRAYFORMULA(A2:A5*B2:B5)` |
+| Syntax                                            | Example                           |
+|:--------------------------------------------------|:----------------------------------|
+| `ARRAYFORMULA(your_array_formula)`                | `=ARRAYFORMULA(A2:A5*B2:B5)`      |
 | `ARRAYFORMULA(YOUR_FUNCTION(your_array_formula))` | `=ARRAYFORMULA(ISEVEN(A2:A5*10))` |
 
 ### Enabling the array arithmetic mode globally
 
 To enable the array arithmetic mode by default, everywhere in your HyperFormula instance:
 
-* In your HyperFormula [configuration](../api/interfaces/configparams.html#usearrayarithmetic), set the `useArrayArithmetic` option to `true`.
+* In your HyperFormula [configuration](../api/interfaces/configparams.md#usearrayarithmetic), set the `useArrayArithmetic` option to `true`.
 
 With the array arithmetic mode enabled globally, you can operate on arrays without using the `ARRAYFORMULA` function:
 
-```js
+```
 =A2:A5*B2:B5
 
 ISEVEN(A2:A5*10)
@@ -85,7 +85,7 @@ You can operate on arrays just like on single values.
 
 When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is enabled, each output array value is the result of your operation on the corresponding input array value.
 
-```js
+```
 =ARRAYFORMULA(A2:A5*B2:B5)
 
 // calculates:
@@ -100,7 +100,7 @@ You can pass arrays to functions that would normally accept [scalars](#about-arr
 
 When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is enabled, and you pass an array to a [scalar](#about-arrays) function, that function produces an array on the output as well.
 
-```js
+```
 =ARRAYFORMULA(ISEVEN(A2:A5*10))
 
 // calculates:
@@ -114,7 +114,7 @@ When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is enabled
 
 If an input array has a dimension of `1`, it's automatically repeated ("broadcast") on that dimension to match the size of the output.
 
-```js
+```
 =ARRAYFORMULA(ISEVEN(A2:A5*B2))
 
 // calculates:
@@ -128,17 +128,17 @@ If an input array has a dimension of `1`, it's automatically repeated ("broadcas
 
 When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is enabled, you can filter an array, based on boolean arrays, using the `FILTER` function:
 
-| Syntax | Example |
-| :--- | :--- |
-| `FILTER(your_array, BoolArray1[; BoolArray2[; ...]]` | `=ARRAYFORMULA(FILTER(A2:A5*10), {1,0,0,1})` |
+| Syntax                                               | Example                                         |
+|:-----------------------------------------------------|:------------------------------------------------|
+| `FILTER(your_array, BoolArray1[, BoolArray2[, ...]]` | `=ARRAYFORMULA(FILTER(A2:A5*10), {1, 0, 0, 1})` |
 
 ### Constraining an array's size
 
 When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is enabled, you can constrain the size of the output array, using the `ARRAY_CONSTRAIN` function:
 
-| Syntax | Example |
-| :--- | :--- |
-| `ARRAY_CONSTRAIN(your_array,height,width)` | `=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5,2,2))` |
+| Syntax                                     | Example                                       |
+|:-------------------------------------------|:----------------------------------------------|
+| `ARRAY_CONSTRAIN(your_array,height,width)` | `=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5, 2, 2))` |
 
 If your specified output array size is smaller than the input array size, only the corresponding top-left cells of the input array are taken into account.
 
@@ -160,7 +160,7 @@ When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is disable
 
 When the [array arithmetic mode](#enabling-the-array-arithmetic-mode) is disabled, and you operate on a range of width/height equal to `1`, the behavior depends on your array formula's location:
 
-| Your array formula's location | Behavior |
-| :--- | :--- |
+| Your array formula's location                     | Behavior                               |
+|:--------------------------------------------------|:---------------------------------------|
 | In the same row as as one of the range's elements | Only that particular element is taken. |
-| Any other cell | `#VALUE!` error |
+| Any other cell                                    | `#VALUE!` error                        |

docs/guide/arrays.md

@@ -389,7 +389,7 @@ This demo presents several basic operations integrated with a
 sample UI.
 
 <iframe
-     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.1.x/basic-operations?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
+     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.2.x/basic-operations?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
      style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
      title="handsontable/hyperformula-demos: basic-operations"
      allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"

docs/guide/basic-operations.md

@@ -65,7 +65,7 @@ works. It's time to move on to a more
 ## Demo
 
 <iframe
-     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.1.x/basic-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
+     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.2.x/basic-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
      style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
      title="handsontable/hyperformula-demos: basic-usage"
      allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"

docs/guide/basic-usage.md

@@ -118,7 +118,7 @@ can be sent as a single one.
 ## Demo
 
 <iframe
-     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.1.x/batch-operations?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
+     src="https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.2.x/batch-operations?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview"
      style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
      title="handsontable/hyperformula-demos: batch-operations"
      allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"