Merge pull request #68 from MatrixAI/feature-esm-migrate

ESM Migration

Author: tegefaulkes

.eslintrc

@@ -7,19 +7,18 @@
     "jest": true
   },
   "parser": "@typescript-eslint/parser",
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "prettier"
-  ],
-  "plugins": [
-    "import"
-  ],
   "parserOptions": {
     "project": "tsconfig.json",
     "sourceType": "module"
   },
+  "plugins": [
+    "import"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
   "rules": {
     "linebreak-style": ["error", "unix"],
     "no-empty": 1,

README.md

@@ -94,7 +94,7 @@ npm install
 # build the dist
 npm run build
 # run the repl (this allows you to import from ./src)
-npm run ts-node
+npm run tsx
 # run the tests
 npm run test
 # lint the source code

benches/db_1KiB.ts

@@ -2,12 +2,14 @@ import os from 'os';
 import fs from 'fs';
 import path from 'path';
 import crypto from 'crypto';
+import url from 'node:url';
 import b from 'benny';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
-import DB from '@/DB';
-import { suiteCommon } from './utils';
+import { suiteCommon } from './utils/utils.js';
+import DB from '#DB.js';
 
 const logger = new Logger('DB1KiB Bench', LogLevel.WARN, [new StreamHandler()]);
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const dataDir = await fs.promises.mkdtemp(
@@ -18,7 +20,7 @@ async function main() {
   const data0 = crypto.randomBytes(0);
   const data1KiB = crypto.randomBytes(1024);
   const summary = await b.suite(
-    path.basename(__filename, path.extname(__filename)),
+    path.basename(filename, path.extname(filename)),
     b.add('get 1 KiB of data', async () => {
       await db.put('1kib', data1KiB, true);
       return async () => {
@@ -44,8 +46,7 @@ async function main() {
   });
   return summary;
 }
-
-if (require.main === module) {
+if (process.argv[1] === url.fileURLToPath(import.meta.url)) {
   void main();
 }
 

benches/db_1MiB.ts

@@ -2,12 +2,14 @@ import os from 'os';
 import fs from 'fs';
 import path from 'path';
 import crypto from 'crypto';
+import url from 'node:url';
 import b from 'benny';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
-import DB from '@/DB';
-import { suiteCommon } from './utils';
+import { suiteCommon } from './utils/utils.js';
+import DB from '#DB.js';
 
 const logger = new Logger('DB1MiB Bench', LogLevel.WARN, [new StreamHandler()]);
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const dataDir = await fs.promises.mkdtemp(
@@ -18,7 +20,7 @@ async function main() {
   const data0 = crypto.randomBytes(0);
   const data1MiB = crypto.randomBytes(1024 * 1024);
   const summary = await b.suite(
-    path.basename(__filename, path.extname(__filename)),
+    path.basename(filename, path.extname(filename)),
     b.add('get 1 MiB of data', async () => {
       await db.put('1mib', data1MiB, true);
       return async () => {
@@ -45,7 +47,7 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
+if (process.argv[1] === url.fileURLToPath(import.meta.url)) {
   void main();
 }
 

benches/index.ts

@@ -2,26 +2,29 @@
 
 import fs from 'fs';
 import path from 'path';
+import url from 'node:url';
 import si from 'systeminformation';
-import DB1KiB from './db_1KiB';
-import DB1MiB from './db_1MiB';
+import DB1KiB from './db_1KiB.js';
+import DB1MiB from './db_1MiB.js';
+
+const dirname = url.fileURLToPath(new URL('.', import.meta.url));
 
 async function main(): Promise<void> {
-  await fs.promises.mkdir(path.join(__dirname, 'results'), { recursive: true });
+  await fs.promises.mkdir(path.join(dirname, 'results'), { recursive: true });
   await DB1KiB();
   await DB1MiB();
   const resultFilenames = await fs.promises.readdir(
-    path.join(__dirname, 'results'),
+    path.join(dirname, 'results'),
   );
   const metricsFile = await fs.promises.open(
-    path.join(__dirname, 'results', 'metrics.txt'),
+    path.join(dirname, 'results', 'metrics.txt'),
     'w',
   );
   let concatenating = false;
   for (const resultFilename of resultFilenames) {
     if (/.+_metrics\.txt$/.test(resultFilename)) {
       const metricsData = await fs.promises.readFile(
-        path.join(__dirname, 'results', resultFilename),
+        path.join(dirname, 'results', resultFilename),
       );
       if (concatenating) {
         await metricsFile.write('\n');
@@ -37,7 +40,7 @@ async function main(): Promise<void> {
     system: 'model, manufacturer',
   });
   await fs.promises.writeFile(
-    path.join(__dirname, 'results', 'system.json'),
+    path.join(dirname, 'results', 'system.json'),
     JSON.stringify(systemData, null, 2),
   );
 }

benches/results/db_1KiB.chart.html

@@ -28,7 +28,7 @@
   </head>
   <body>
     <div class="container">
-      <canvas id="chart1687684087088" width="16" height="9"></canvas>
+      <canvas id="chart1742452282334" width="16" height="9"></canvas>
     </div>
     <script>
       const format = (num) => {
@@ -51,18 +51,18 @@
           chunked.map((chunk) => chunk.join('')).join(' ') + fractionStr
         )
       }
-      const ctx1687684087088 = document
-        .getElementById('chart1687684087088')
+      const ctx1742452282334 = document
+        .getElementById('chart1742452282334')
         .getContext('2d')
-      const chart1687684087088 = new Chart(ctx1687684087088, {
+      const chart1742452282334 = new Chart(ctx1742452282334, {
         type: 'bar',
         data: {
           labels: ["get 1 KiB of data","put 1 KiB of data","put zero data","put zero data then del"],
           datasets: [
             {
-              data: [47519,32985,35687,17917],
-              backgroundColor: ["hsl(120, 85%, 55%)","hsl(83.29199999999999, 85%, 55%)","hsl(90.11999999999999, 85%, 55%)","hsl(45.24, 85%, 55%)"],
-              borderColor: ["hsl(120, 85%, 55%)","hsl(83.29199999999999, 85%, 55%)","hsl(90.11999999999999, 85%, 55%)","hsl(45.24, 85%, 55%)"],
+              data: [71704,40939,49028,19057],
+              backgroundColor: ["hsl(120, 85%, 55%)","hsl(68.50800000000001, 85%, 55%)","hsl(82.056, 85%, 55%)","hsl(31.895999999999997, 85%, 55%)"],
+              borderColor: ["hsl(120, 85%, 55%)","hsl(68.50800000000001, 85%, 55%)","hsl(82.056, 85%, 55%)","hsl(31.895999999999997, 85%, 55%)"],
               borderWidth: 2,
             },
           ],