flo-mat 2.0.0 → 2.0.2

package/.eslintrc.cjs

@@ -0,0 +1,69 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "ignorePatterns": [
+        "*.cjs",
+        "*.min.js",
+        "node_modules/",
+        "dist/**/*",
+        "build/**/*",
+        "node/**/*",
+        "browser/**/*",
+        "unused/**/*",
+        "src-unused/**/*",
+        "test/**/*",
+        "docs/**/*",
+        "github assets/**/*",
+        "papers/**/*"
+    ],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "tree-shaking"
+    ],
+    "rules": {
+        'no-constant-condition': 'off',
+        'no-mixed-spaces-and-tabs': 'off',
+        'no-sparse-arrays': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/no-empty-interface': 'off',
+        '@typescript-eslint/no-loss-of-precision': 'off',
+        '@typescript-eslint/no-this-alias': 'off',
+        "tree-shaking/no-side-effects-in-initialization": [
+            2,
+            {
+                "noSideEffectsWhenCalled": [
+                    { "function": "Object.freeze" },
+                    {
+                        "module": "#local",
+                        "functions": [
+                            "drawMat",
+                            "getTotalBy"
+                        ]
+                    },
+                    {
+                        "module": "flo-memoize",
+                        "functions": ["memoize"],
+                    }
+                ]
+            }
+        ]
+    }
+}

package/README.md

@@ -52,12 +52,8 @@ the SAT is a subset of the MAT.
 This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
 and can be used in `Node.js` (or in a browser when bundled using e.g. Webpack).
 
-Additionally, self-contained `ECMAScript Module` (ESM) files `index.module.js` and
-`index.module.min.js` in the `./browser` folder is provided.
-
-Or, if you need a legacy browser script there is also `index.js`
-and `index.min.js` in the `./browser` folder. Either script exposes a global 
-variable.
+Additionally, self-contained `ECMAScript Module` (ESM) files `index.js` and
+`index.min.js` in the `./browser` folder are provided.
 
 # Code example
 
@@ -350,35 +346,21 @@ So whatever your target, at the the command line:
 npm install flo-mat
 ```
 
-## Node with JavaScript (or the browser (with [webpack](https://webpack.js.org/)) or similar) 
+## Node with JavaScript/TypeScript (or the browser (with [webpack](https://webpack.js.org/)) or similar) 
 
 In your project
+
 ```javascript
-let FloMat = require("flo-mat");
-```
-or if you only want to require specific functionality:
-```javascript
-let { findMats } = require('flo-mat');
+import { findMats } from 'flo-mat';
 ```
 
-## TypeScript
+## Browser - directly, without a bundler, using the pre-bundled minified .js file
 
-In your project
-```typescript
-import * as FloMat from "flo-mat";
-```
-or for specific functionalities:
-```typescript
-import { findMats } from "flo-mat";
-```
+Please note that no tree shaking will take place in this case.
 
-## Browser (using global var)
-
-After the npm installation simply include the script in your project:
-```html
-<script src='node_modules/flo-mat/browser/index.min.js'></script>
+```javascript
+import { findMats } from './node_modules/flo-mat/browser/index.min.js';
 ```
-A new global object will be available called `FloMat` representing the library. 
 
 # Usage