chore!: upgrade to typescript

* chore: migrate project to TypeScript

* chore: migrate project to TypeScript

* docs: create documentation with typedoc and add a plugin to display mathematical expressions properly

* docs: add correction to "dice distance" in the documentation

* docs: remove type of parameter and return description

* docs: make math expressions align to the left

* docs: remove the rest of parameter types in documentation

* chore: change the delimiters of math expressions to "$" instead of "$$"

* chore: build ts doc in github action and other CI and release actions

Author: EscapedGibbon

.babelrc

@@ -1,4 +1,4 @@
-extends: cheminfo
+extends: cheminfo-typescript
 parserOptions:
   sourceType: module
 env:

.eslintrc.yml

@@ -0,0 +1,14 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+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/nodejs.yml

@@ -0,0 +1,16 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    # Documentation: https://github.com/zakodium/workflows#release
+    uses: zakodium/workflows/.github/workflows/release.yml@release-v1
+    with:
+      npm: true
+    secrets:
+      github-token: ${{ secrets.BOT_TOKEN }}
+      npm-token: ${{ secrets.NPM_BOT_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Deploy TypeDoc on GitHub pages
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Install dependencies
+        run: npm install
+      - name: Build documentation
+        uses: zakodium/typedoc-action@feat-katex
+        with:
+          entry: src/index.ts
+
+      - 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/typedoc.yml

@@ -4,3 +4,7 @@ lib
 coverage
 
 .DS_Store
+
+lib-esm
+
+docs

.gitignore

@@ -0,0 +1,4 @@
+module.exports = {
+  presets: ['@babel/preset-typescript'],
+  plugins: ['@babel/plugin-transform-modules-commonjs'],
+};

.travis.yml

@@ -3,21 +3,27 @@
   "version": "3.0.0",
   "description": "Distance and similarity functions to compare vectors",
   "main": "lib/index.js",
-  "module": "src/index.js",
+  "module": "./lib-esm/index.js",
   "files": [
     "src",
-    "lib"
+    "lib",
+    "lib-esm"
   ],
+  "types": "./lib/index.d.ts",
   "scripts": {
-    "compile": "rollup -c",
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib lib-esm",
     "eslint": "eslint src",
     "eslint-fix": "npm run eslint -- --fix",
-    "prepublishOnly": "npm run compile",
+    "prepack": "npm run tsc",
     "prettier": "prettier --check src",
     "prettier-write": "prettier --write src",
-    "test": "npm run test-coverage && npm run eslint",
+    "test": "npm run test-coverage && npm run eslint && npm run check-types",
     "test-only": "jest",
-    "test-coverage": "jest --coverage"
+    "test-coverage": "jest --coverage",
+    "tsc": "npm run clean && npm run tsc-cjs && npm run tsc-esm",
+    "tsc-cjs": "tsc --project tsconfig.cjs.json",
+    "tsc-esm": "tsc --project tsconfig.esm.json"
   },
   "repository": {
     "type": "git",
@@ -45,17 +51,18 @@
   "homepage": "https://github.com/mljs/distance",
   "devDependencies": {
     "@babel/plugin-transform-modules-commonjs": "^7.20.7",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^29.2.4",
+    "cheminfo-types": "^1.4.0",
     "eslint": "^8.30.0",
-    "eslint-config-cheminfo": "^8.1.3",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.1.7",
+    "eslint-config-cheminfo-typescript": "^11.2.2",
     "esm": "^3.2.25",
     "jest": "^29.3.1",
     "prettier": "^2.8.1",
-    "rollup": "^3.8.1"
+    "rimraf": "^3.0.2",
+    "typescript": "^4.9.4"
   },
   "dependencies": {
-    "cheminfo-types": "^1.4.0",
     "ml-array-mean": "^1.1.6",
     "ml-distance-euclidean": "^2.0.0",
     "ml-tree-similarity": "^1.0.0"