chore!: migrate project to TypeScript (#18)

close: #17
close: #19

Author: EscapedGibbon

.eslintrc.yml

@@ -1,3 +1,6 @@
-extends: cheminfo
+extends: cheminfo-typescript
+root: true
 parserOptions:
   sourceType: module
+env:
+  jest: true

.github/workflows/nodejs.yml

@@ -11,4 +11,4 @@ jobs:
     # Documentation: https://github.com/zakodium/workflows#nodejs-ci
     uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1
     with:
-      node-version-matrix: '[12, 14, 16]'
+      lint-check-types: true

.gitignore

@@ -40,3 +40,4 @@ jspm_packages
 .node_repl_history
 
 lib
+lib-esm

babel.config.js

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

package.json

@@ -2,20 +2,27 @@
   "name": "ml-rolling-ball-baseline",
   "version": "1.1.0",
   "description": "Rolling ball baseline correction",
-  "main": "lib/index.js",
-  "module": "src/index.js",
+  "main": "./lib/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./lib/index.d.ts",
   "files": [
     "lib",
-    "src"
+    "src",
+    "lib-esm"
   ],
   "scripts": {
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib lib-esm",
     "eslint": "eslint src",
     "eslint-fix": "npm run eslint -- --fix",
-    "prepack": "rollup -c",
+    "prepack": "npm run tsc",
     "prettier": "prettier --check src",
     "prettier-write": "prettier --write src",
-    "test": "npm run test-only && npm run eslint && npm run prettier",
-    "test-only": "jest --coverage"
+    "test": "npm run test-only && npm run eslint && npm run prettier && npm run check-types",
+    "test-only": "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",
@@ -29,13 +36,15 @@
   },
   "homepage": "https://github.com/mljs/rolling-ball-baseline#readme",
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.17.7",
-    "@types/jest": "^27.4.1",
+    "@babel/plugin-transform-modules-commonjs": "^7.19.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^27.5.2",
+    "cheminfo-types": "^1.4.0",
     "eslint": "^8.12.0",
-    "eslint-config-cheminfo": "^7.3.0",
+    "eslint-config-cheminfo-typescript": "^11.2.2",
     "jest": "^27.5.1",
     "prettier": "^2.6.1",
-    "rollup": "^2.70.1"
+    "rimraf": "^3.0.2"
   },
   "dependencies": {
     "is-any-array": "^2.0.0",

rollup.config.js

@@ -1,3 +1,4 @@
+import { NumberArray } from 'cheminfo-types';
 import { isAnyArray } from 'is-any-array';
 import { xMean, xMaxValue, xMinValue } from 'ml-spectra-processing';
 
@@ -23,7 +24,15 @@ import { xMean, xMaxValue, xMinValue } from 'ml-spectra-processing';
  * @param {Number} [options.windowM] - width of local window for minimization/maximization, defaults to 4% of the spectrum length
  * @param {Number} [options.windowS] - width of local window for smoothing, defaults to 8% of the spectrum length
  */
-export function rollingBall(spectrum, options = {}) {
+
+interface Options {
+  windowM: number;
+  windowS: number;
+}
+export function rollingBall(
+  spectrum: NumberArray,
+  options: Partial<Options> = {},
+): NumberArray {
   if (!isAnyArray(spectrum)) {
     throw new Error('Spectrum must be an array');
   }