refactor!: migrate to TypeScript and ESM

Author: targos

.babelrc.json

@@ -10,3 +10,5 @@ jobs:
   nodejs:
     # Documentation: https://github.com/zakodium/workflows#nodejs-ci
     uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1
+    with:
+      lint-check-types: true

.github/workflows/documentationjs.yml

@@ -0,0 +1,32 @@
+name: Deploy TypeDoc on GitHub pages
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+env:
+  NODE_VERSION: 22.x
+  ENTRY_FILE: 'src/index.js'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Install dependencies
+        run: npm install
+      - name: Build documentation
+        uses: zakodium/typedoc-action@v2
+        with:
+          entry: ${{ env.ENTRY_FILE }}
+      - name: Deploy to GitHub pages
+        uses: JamesIves/github-pages-deploy-action@releases/v4
+        with:
+          token: ${{ secrets.BOT_TOKEN }}
+          branch: gh-pages
+          folder: docs
+          clean: true

.github/workflows/nodejs.yml

@@ -0,0 +1 @@
+CHANGELOG.md

.github/workflows/typedoc.yml

@@ -1,4 +1,4 @@
-# sparse-matrix
+# ml-sparse-matrix
 
 [![NPM version][npm-image]][npm-url]
 [![coverage status][codecov-image]][codecov-url]
@@ -13,7 +13,7 @@ Sparse matrix library.
 ## Usage
 
 ```js
-import { SparseMatrix } from "ml-sparse-matrix";
+import { SparseMatrix } from 'ml-sparse-matrix';
 
 const matrix1 = new SparseMatrix([
   [1, 2],

.prettierignore

@@ -14,6 +14,5 @@ for (let i = 0; i < size; i++) {
     sum += product.get(i, j);
   }
 }
-console.log(sum)
+console.log(sum);
 console.timeEnd('dense');
-

README.md

@@ -1,24 +1,24 @@
-
-
 import { SparseMatrix } from '../lib/index.js';
 
 let size = 200;
 
-
-
 console.time('dense');
 
 const matrix1 = new SparseMatrix(size, size);
-fillSparseMatrix(matrix1)
+fillSparseMatrix(matrix1);
 
 const matrix2 = new SparseMatrix(size, size);
-fillSparseMatrix(matrix2)
+fillSparseMatrix(matrix2);
 
 const product = new SparseMatrix(size, size);
 for (let i = 0; i < size; i++) {
   for (let j = 0; j < size; j++) {
     for (let k = 0; k < size; k++) {
-      product.set(i, j, product.get(i, j) + matrix1.get(i, k) * matrix2.get(k, j));
+      product.set(
+        i,
+        j,
+        product.get(i, j) + matrix1.get(i, k) * matrix2.get(k, j),
+      );
     }
   }
 }
@@ -30,12 +30,12 @@ for (let i = 0; i < size; i++) {
   }
 }
 console.timeEnd('dense');
-console.log(sum)
+console.log(sum);
 
 function fillSparseMatrix(matrix) {
   for (let row = 0; row < matrix.rows; row++) {
     for (let column = 0; column < matrix.columns; column++) {
       matrix.set(row, column, 1);
     }
   }
-}
+}

benchmark/denseMatrix.mjs renamed to benchmark/denseMatrix.js

@@ -5,10 +5,10 @@ let size = 200;
 console.time('dense');
 
 const matrix = new SparseMatrix(size, size);
-fillSparseMatrix(matrix)
+fillSparseMatrix(matrix);
 
 const matrix2 = new SparseMatrix(size, size);
-fillSparseMatrix(matrix2)
+fillSparseMatrix(matrix2);
 
 const product = matrix.mmul(matrix2);
 // sum of all the elements
@@ -19,12 +19,12 @@ for (let i = 0; i < size; i++) {
   }
 }
 console.timeEnd('dense');
-console.log(sum)
+console.log(sum);
 
 function fillSparseMatrix(matrix) {
   for (let row = 0; row < matrix.rows; row++) {
     for (let column = 0; column < matrix.columns; column++) {
       matrix.set(row, column, 1);
     }
   }
-}
+}

benchmark/sparseMatrix.byhand.mjs renamed to benchmark/sparseMatrix.byhand.js

@@ -1,11 +1,9 @@
-import cheminfo from 'eslint-config-cheminfo';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import ts from 'eslint-config-cheminfo-typescript/base';
 
-export default [
-  ...cheminfo,
-  {
-    languageOptions: {
-    },
-    rules: {
-    }
-  }
-]
+export default defineConfig(globalIgnores(['lib']), ts, {
+  files: ['benchmark/**'],
+  rules: {
+    'no-console': 'off',
+  },
+});

benchmark/sparseMatrix.mjs renamed to benchmark/sparseMatrix.js

@@ -2,21 +2,24 @@
   "name": "ml-sparse-matrix",
   "version": "2.1.0",
   "description": "Sparse matrix library",
-  "main": "lib/index.js",
-  "module": "src/index.js",
+  "type": "module",
+  "exports": "./lib/index.js",
   "files": [
     "lib",
     "src"
   ],
   "scripts": {
-    "compile": "rollup -c",
-    "eslint": "eslint src",
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib",
+    "eslint": "eslint .",
     "eslint-fix": "npm run eslint -- --fix",
-    "prepack": "npm run compile",
-    "prettier": "prettier --check src",
-    "prettier-write": "prettier --write src",
-    "test": "npm run test-only && npm run eslint && npm run prettier",
-    "test-only": "vitest run --coverage"
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check .",
+    "prettier-write": "prettier --write .",
+    "test": "npm run test-only && npm run check-types && npm run eslint && npm run prettier",
+    "test-only": "vitest run --coverage",
+    "tsc": "npm run clean && npm run tsc-build",
+    "tsc-build": "tsc --project tsconfig.build.json"
   },
   "repository": {
     "type": "git",
@@ -33,13 +36,14 @@
     "ml-hash-table": "^1.0.0"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.24.8",
-    "@vitest/coverage-v8": "^2.0.5",
-    "eslint": "^8.10.0",
-    "eslint-config-cheminfo": "^11.1.1",
-    "ml-matrix": "^6.11.1",
-    "prettier": "^3.3.3",
-    "rollup": "^4.21.0",
-    "vitest": "^2.0.5"
+    "@types/node": "^22.15.21",
+    "@vitest/coverage-v8": "^3.1.4",
+    "eslint": "^9.27.0",
+    "eslint-config-cheminfo-typescript": "^18.0.1",
+    "ml-matrix": "^6.12.1",
+    "prettier": "^3.5.3",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.4"
   }
 }

eslint.config.mjs

@@ -1,6 +1,6 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
 
-import { SparseMatrix } from '..';
+import { SparseMatrix } from '../index.js';
 
 describe('Sparse Matrix', () => {
   it('mmul', () => {

package.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["**/__tests__", "**/*.test.ts"]
+}

rollup.config.mjs

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "lib": ["ES2022", "WebWorker"],
+    "types": [],
+    "target": "ES2022",
+    "outDir": "lib",
+    "module": "NodeNext",
+    "strict": true,
+    "skipLibCheck": false,
+    "resolveJsonModule": false,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "checkJs": true,
+    "noImplicitAny": false,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true
+  },
+  "include": ["src"]
+}