refactor: Convert to Typescript (#388)

.eslintignore

@@ -0,0 +1,4 @@
+dist/
+node_modules/
+docs/
+types/

.eslintrc.json

@@ -0,0 +1,43 @@
+{
+  "root": true,
+  "extends": [
+    "eslint:recommended",
+    "plugin:prettier/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint"
+  ],
+  "env": {
+    "node": true
+  },
+  "globals": {
+    "Promise": true,
+    "Uint8Array": true,
+    "ArrayBuffer": true,
+    "Set": true,
+    "Map": false
+  },
+  "parserOptions": {
+    "ecmaVersion": 2017
+  },
+  "plugins": [
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": "error",
+    "no-console": "off",
+    "eqeqeq": [
+      "error",
+      "always",
+      {
+        "null": "ignore"
+      }
+    ],
+    "strict": [
+      "error",
+      "global"
+    ],
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-var-requires": "off"
+  }
+}

.evergreen/config.yml

@@ -71,6 +71,16 @@ functions:
           ${PREPARE_SHELL}
           echo "NODE_VERSION=${NODE_VERSION} TEST_TARGET=${TEST_TARGET}"
           NODE_VERSION=${NODE_VERSION} ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh ${TEST_TARGET}
+  run checks:
+    - command: shell.exec
+      type: test
+      params:
+        working_dir: src
+        script: |
+          ${PREPARE_SHELL}
+          echo "NODE_VERSION=${NODE_VERSION} TEST_TARGET=${TEST_TARGET}"
+          bash ${PROJECT_DIRECTORY}/.evergreen/run-checks.sh
+
 
 tasks:
   - name: node-tests-v6
@@ -133,6 +143,15 @@ tasks:
       - func: run tests
         vars:
           TEST_TARGET: browser
+  - name: run-checks
+    tags:
+      - run-checks
+    commands:
+      - func: fetch source
+        vars:
+          NODE_MAJOR_VERSION: 12
+      - func: install dependencies
+      - func: run checks
 
 buildvariants:
   - name: linux
@@ -147,3 +166,8 @@ buildvariants:
     display_name: Windows 64
     run_on: windows-64-vsMulti-small
     tasks: [".node"]
+  - name: lint
+    display_name: lint
+    run_on: rhel70
+    tasks:
+      - run-checks

.evergreen/install-dependencies.sh

@@ -41,14 +41,16 @@ path: $NVM_SYMLINK
 EOT
 
   nvm install ${NODE_VERSION}
+  nvm install 10.22.0 # install lts for compilation only
   nvm on
 else
   curl -o- $NVM_URL | bash
   [ -s "${NVM_DIR}/nvm.sh" ] && \. "${NVM_DIR}/nvm.sh"
 
   nvm install --no-progress ${NODE_VERSION}
+  nvm install --no-progress 10.22.0 # install lts for compilation only
 fi
-nvm use ${NODE_VERSION}
+nvm use 10.22.0 # use lts for setup, runtime node can be different
 
 # setup npm cache in a local directory
 cat <<EOT > .npmrc
@@ -60,4 +62,5 @@ registry=https://registry.npmjs.org
 EOT
 
 # install node dependencies
-npm install
+npm install # npm prepare runs after install and will compile the library
+nvm use ${NODE_VERSION} # Switch to the node version we want to test against

.evergreen/run-checks.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -o errexit  # Exit the script with error if any of the commands fail
+
+export PROJECT_DIRECTORY="$(pwd)"
+NODE_ARTIFACTS_PATH="${PROJECT_DIRECTORY}/node-artifacts"
+export NVM_DIR="${NODE_ARTIFACTS_PATH}/nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+
+npm run lint

.evergreen/run-tests.sh

@@ -18,10 +18,10 @@ fi
 
 case $1 in
   "node")
-    npm run lint && npm run test-node
+    npm run test-node
     ;;
   "browser")
-    npm run lint && npm run test-browser
+    npm run test-browser
     ;;
   *)
     npm test

.gitignore

@@ -15,3 +15,11 @@ builderror.log
 
 bson.sublime-project
 bson.sublime-workspace
+
+lib
+types/
+.nyc_output/
+coverage/
+*.d.ts
+*.tgz
+docs/public

.mocharc.json

@@ -0,0 +1,13 @@
+{
+  "extension": [
+    "js"
+  ],
+  "require": [
+    "ts-node/register",
+    "chai/register-expect",
+    "source-map-support/register"
+  ],
+  "timeout": 10000,
+  "throw-deprecation": true,
+  "parallel": false
+}

.nycrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "include": ["src/**/*.ts"],
+  "reporter": ["lcovonly", "text-summary"]
+}

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "tabWidth": 2,
+  "printWidth": 100,
+  "arrowParens": "avoid",
+  "trailingComma": "none"
+}

api-extractor.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/bson.d.ts",
+  "apiReport": {
+    "enabled": false
+  },
+  "docModel": {
+    "enabled": false
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "<projectFolder>/<unscopedPackageName>.d.ts"
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+  "newlineKind": "lf",
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "error"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+      "ae-internal-missing-underscore": {
+        "logLevel": "none",
+        "addToApiReportFile": false
+      },
+      "ae-missing-release-tag": {
+        "logLevel": "none",
+        "addToApiReportFile": false
+      },
+      "ae-incompatible-release-tags": {
+        "logLevel": "none",
+        "addToApiReportFile": false
+      },
+      "ae-unresolved-link": {
+        "addToApiReportFile": false,
+        "logLevel": "none"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    }
+  }
+}

bower.json

@@ -1,18 +1,11 @@
 {
   "name": "bson",
   "description": "A bson parser for node.js and the browser",
-  "keywords": [
-    "mongodb",
-    "bson",
-    "parser"
-  ],
+  "keywords": ["mongodb", "bson", "parser"],
   "author": "Christian Amor Kvalheim <[email protected]>",
   "main": "./dist/bson.js",
   "license": "Apache-2.0",
-  "moduleType": [
-    "globals",
-    "node"
-  ],
+  "moduleType": ["globals", "node"],
   "ignore": [
     "**/.*",
     "alternate_parsers",

etc/prepare.js

@@ -0,0 +1,19 @@
+#! /usr/bin/env node
+var cp = require('child_process');
+var fs = require('fs');
+
+var nodeMajorVersion = +process.version.match(/^v(\d+)\.\d+/)[1];
+
+if (fs.existsSync('src') && nodeMajorVersion >= 10) {
+  cp.spawnSync('npm', ['run', 'build'], { stdio: 'inherit', shell: true });
+} else {
+  if (!fs.existsSync('lib')) {
+    console.warn('BSON: No compiled javascript present, the library is not installed correctly.');
+    if (nodeMajorVersion < 10) {
+      console.warn(
+        'This library can only be compiled in nodejs version 10 or later, currently running: ' +
+          nodeMajorVersion
+      );
+    }
+  }
+}