feat!: setup typescript (#66)

Author: wadjih-bencheikh18

.babelrc

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

.eslintrc.yml

@@ -5,36 +5,9 @@ on:
     branches: master
   pull_request:
 
-env:
-  NODE_VERSION: 14.x
-
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-      - name: Install dependencies
-        run: npm install
-      - name: Run ESLint
-        run: npm run eslint
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-      fail-fast: false
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install dependencies
-        run: npm install
-      - name: Run tests
-        run: npm run test-coverage
-      - name: Send coverage report to Codecov
-        uses: codecov/codecov-action@v1
+  nodejs:
+    uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1
+    with:
+      node-version-matrix: '[14, 16]'
+      lint-check-types: true

.github/workflows/nodejs.yml

@@ -6,3 +6,4 @@ dist
 lib
 coverage
 .eslintcache
+lib-esm

.gitignore

@@ -10,7 +10,7 @@ import { join } from 'path';
 
 import { generateSpectrum } from 'spectrum-generator';
 
-import { gsd, optimizePeaks } from '../src';
+import { DataType, gsd, optimizePeaks } from '../src';
 
 const peaks = [
   { x: -0.1, y: 0.2, width: 0.3 },
@@ -20,14 +20,18 @@ const peaks = [
 const from = -1;
 const to = 1;
 
-const original = generateSpectrum(peaks, { from, to, nbPoints: 101 });
+const original = generateSpectrum(peaks, {
+  from,
+  to,
+  nbPoints: 101,
+});
 
 let peakList = gsd(original, {
   minMaxRatio: 0,
   realTopDetection: false,
   smoothY: false,
   heightFactor: 1,
-  shape: { kind: 'gaussian' },
+  shape: { kind: 'gaussian', width: 0 },
 });
 
 let optimizedPeaks = optimizePeaks(original, peakList);
@@ -63,8 +67,8 @@ let reconstructed = generateSpectrum(optimizedPeaks, {
   to,
   nbPoints: 5001,
 });
-reconstructed.x = Array.from(reconstructed.x)
-reconstructed.y = Array.from(reconstructed.y)
+reconstructed.x = Array.from(reconstructed.x);
+reconstructed.y = Array.from(reconstructed.y);
 
 original.x = Array.from(original.x);
 original.y = Array.from(original.y);

CHANGELOG.md

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

examples/data.json

@@ -2,27 +2,33 @@
   "name": "ml-gsd",
   "version": "7.0.1",
   "description": "Global Spectra Deconvolution",
-  "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"
   ],
   "env": {
     "jest": true
   },
   "scripts": {
     "build": "rollup -c && cheminfo-build --entry src/index.js --root GSD",
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib lib-esm",
     "example": "nodemon -w src -w examples/example.js -r esm examples/example.js",
     "eslint": "eslint src --cache",
     "eslint-fix": "npm run eslint -- --fix",
-    "compile": "rollup -c",
-    "prepack": "npm run compile",
+    "prepack": "npm run compile && 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,9 +51,6 @@
     "url": "https://github.com/mljs/global-spectral-deconvolution/issues"
   },
   "homepage": "https://github.com/mljs/global-spectral-deconvolution",
-  "jest": {
-    "testEnvironment": "node"
-  },
   "prettier": {
     "arrowParens": "always",
     "semi": true,
@@ -56,25 +59,28 @@
     "trailingComma": "all"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.15.4",
     "@types/jest": "^27.0.2",
     "chemcalc": "^3.4.1",
     "cheminfo-build": "^1.1.11",
-    "eslint": "^7.32.0",
-    "eslint-config-cheminfo": "^5.5.0",
+    "eslint": "^8.1.0",
+    "eslint-config-cheminfo-typescript": "^10.1.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-jest": "^25.2.2",
     "esm": "^3.2.25",
-    "jest": "^27.2.4",
-    "jest-matcher-deep-close-to": "^3.0.0",
-    "mf-global": "^1.4.6",
+    "jest": "^27.3.1",
+    "jest-matcher-deep-close-to": "^3.0.2",
+    "mf-global": "^1.4.7",
     "ml-stat": "^1.3.3",
-    "nodemon": "^2.0.13",
+    "nodemon": "^2.0.14",
     "prettier": "^2.4.1",
-    "rollup": "^2.58.0",
-    "spectrum-generator": "^5.4.0",
+    "rimraf": "^3.0.2",
+    "spectrum-generator": "^5.4.1",
+    "ts-jest": "^27.0.7",
+    "typescript": "^4.4.4",
     "xy-parser": "^3.2.0"
   },
   "dependencies": {
-    "cheminfo-types": "^0.5.0",
+    "cheminfo-types": "^0.6.0",
     "ml-peak-shape-generator": "^2.0.2",
     "ml-savitzky-golay-generalized": "2.0.3",
     "ml-spectra-fitting": "^2.0.0",