feat: Jest Test Runner (#2170)

.github/workflows/nodejs.yml

@@ -57,7 +57,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x, 18.x]
+        node-version: [14.x, 16.x, 18.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -98,7 +98,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x, 18.x]
+        node-version: [14.x, 16.x, 18.x]
 
     services:
       rippled:

.ncurc.json

@@ -0,0 +1,4 @@
+{
+  "reject": [
+  ]
+}

.nvmrc

@@ -1 +1 @@
-v12
+v14

.vscode/settings.json

@@ -39,4 +39,12 @@
         "**/.git/subtree-cache/**": true,
         "**/.hg/store/**": true
     },
+    "search.exclude": {
+        "**/.git": true,
+        "**/node_modules": true,
+        "**/tmp": true,
+        "**/docs/**/*.html": true,
+        "**/fixtures/**/*.json": true,
+        "**/docs/assets": true
+    },
 }

CONTRIBUTING.md

@@ -122,8 +122,6 @@ If your code connects to the ledger (ex. Adding a new transaction type) it's han
 
 All integration tests should be written in the `test/integration` folder, with new `Requests` and `Transactions` tests being in their respective folders.
 
-One last note for integration tests is that all imports from `xrpl.js` should be from `xrpl-local` instead of `../../src`. This is required for the integraiton tests to run in the browser.
-
 For an example of how to write an integration test for `xrpl.js`, you can look at the [Payment integration test](./packages/xrpl/test/integration/transactions/payment.ts).
 
 ## Generate reference docs

README.md

@@ -25,7 +25,7 @@ All of which works in Node.js (tested for v14+) & web browsers (tested for Chrom
 
 ### Requirements
 
-- **[Node.js v14](https://nodejs.org/)** is recommended. We also support v12 and v16. Other versions may work but are not frequently tested.
++ **[Node.js v14](https://nodejs.org/)** is recommended. We also support v16 and v18. Other versions may work but are not frequently tested.
 
 ### Installing xrpl.js
 

jest.config.base.js

@@ -0,0 +1,20 @@
+const { TextDecoder, TextEncoder } = require("util");
+
+module.exports = {
+  roots: ["<rootDir>/src"],
+  transform: {
+    "^.+\\.ts$": "ts-jest",
+  },
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  collectCoverage: true,
+  verbose: true,
+  testEnvironment: "node",
+  globals: {
+    TextDecoder: TextDecoder,
+    TextEncoder: TextEncoder,
+    error: console.error,
+    warn: console.warn,
+    info: console.info,
+    debug: console.debug,
+  },
+};

jest.config.js

@@ -0,0 +1,8 @@
+const path = require("path");
+const base = require("./jest.config.base.js");
+
+module.exports = {
+  ...base,
+  projects: ["<rootDir>/packages/**/jest.config.js"],
+  coverageDirectory: "<rootDir>/coverage/",
+};