Convert CLI to ES Module

Author: rien

cli/package.json

@@ -2,9 +2,10 @@
   "name": "@dodona/dolos",
   "version": "2.3.0",
   "description": "Code similarity detection based on the Winnowing algorithm",
-  "main": "dist/index.js",
+  "type": "module",
+  "export": "./dist/index.js",
   "engines": {
-    "node": ">12"
+    "node": ">=16"
   },
   "bin": {
     "dolos": "dist/cli.js"

cli/src/cli.ts

@@ -1,19 +1,16 @@
 #!/usr/bin/env node
-import * as Utils from "./cli/util/utils";
+import * as Utils from "./cli/util/utils.js";
 import { Command } from "commander";
-import { runCommand } from "./cli/commands/run";
-import { serveCommand } from "./cli/commands/serve";
-import * as path from "path";
+import { runCommand } from "./cli/commands/run.js";
+import { serveCommand } from "./cli/commands/serve.js";
+import { readFileSync } from "fs";
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const pkg = require("../package.json");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const treeSitterPkg = require(path.dirname(require.resolve("tree-sitter")) + "/package.json");
+const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf-8"));
 
 const versions = [
   `Dolos v${pkg.version}`,
   `Node ${process.version}`,
-  `Tree-sitter v${treeSitterPkg.version}`
+  `Tree-sitter ${pkg.dependencies["tree-sitter"]}`
 ];
 
 const program = new Command();

cli/src/cli/commands/run.ts

@@ -3,14 +3,14 @@ import {
   setLogging,
   tryCatch,
   warning
-} from "../util/utils";
+} from "../util/utils.js";
 
-import { DEFAULT_HOST, DEFAULT_PORT } from "../server";
-import { TerminalView } from "../views/terminalView";
-import { FileView } from "../views/fileView";
-import { WebView } from "../views/webView";
+import { DEFAULT_HOST, DEFAULT_PORT } from "../server.js";
+import { TerminalView } from "../views/terminalView.js";
+import { FileView } from "../views/fileView.js";
+import { WebView } from "../views/webView.js";
 import { Command } from "commander";
-import * as Utils from "../util/utils";
+import * as Utils from "../util/utils.js";
 import { Dolos, Options } from "@dodona/dolos-lib";
 
 export function runCommand(program: Command): Command {

cli/src/cli/commands/serve.ts

@@ -1,9 +1,10 @@
 import { Command } from "commander";
-import { promises as fs, constants } from "fs";
-import * as path from "path";
-import runServer, { DEFAULT_HOST, DEFAULT_PORT } from "../server";
-import * as Utils from "../util/utils";
-import { tryCatch, error, setLogging } from "../util/utils";
+import { constants } from "node:fs";
+import fs from "node:fs/promises";
+import path from "node:path";
+import runServer, { DEFAULT_HOST, DEFAULT_PORT } from "../server.js";
+import * as Utils from "../util/utils.js";
+import { tryCatch, error, setLogging } from "../util/utils.js";
 
 export function serveCommand(program: Command): Command {
   return new Command("serve")

cli/src/cli/server.ts

@@ -1,12 +1,16 @@
-import { error } from "./util/utils";
+import { error } from "./util/utils.js";
 import { default as express, Express } from "express";
 import http from "http";
 import path from "path";
 import open from "open";
+// @ts-ignore
+import * as web from "@dodona/dolos-web";
+
 
 function assets(): string {
   try {
-    return require.resolve("@dodona/dolos-web");
+    console.debug(web);
+    return web;
   } catch (e) {
     if (e.code === "MODULE_NOT_FOUND") {
       error("Module '@dodona/dolos-web' was not found on your system, " +

cli/src/cli/views/fileView.ts

@@ -1,4 +1,4 @@
-import { View } from "./view";
+import { View } from "./view.js";
 import { stringify } from "csv-stringify";
 import { Writable } from "stream";
 import { createWriteStream, promises as fs } from "fs";

cli/src/cli/views/terminalView.ts

@@ -1,11 +1,12 @@
-import { View } from "./view";
+import { View } from "./view.js";
 
 /// <reference types="../../../typings/cliui" />
 import UI from "cliui";
-import { Chalk, Instance as ChalkInstance, bold, red } from "chalk";
 import { Writable } from "stream";
-import { closestMatch } from "../util/utils";
+import { closestMatch } from "../util/utils.js";
 import { Report, Fragment, Region, Pair } from "@dodona/dolos-lib";
+import chalk from "chalk";
+const { Instance: ChalkInstance, bold, red } = chalk;
 
 /**
  * This {@link View} will print the results of an analysis to the terminal.
@@ -17,7 +18,7 @@ export class TerminalView extends View {
   private readonly fragmentSortBy?: string;
   private readonly compare: boolean;
   private readonly width: number;
-  private readonly c: Chalk;
+  private readonly c: chalk.Chalk;
   private readonly context: number = 3;
 
   constructor(

cli/src/cli/views/webView.ts

@@ -1,5 +1,5 @@
-import { FileView, Options as FVOptions } from "./fileView";
-import runServer, { Options as ServerOptions } from "../server";
+import { FileView, Options as FVOptions } from "./fileView.js";
+import runServer, { Options as ServerOptions } from "../server.js";
 import { Report } from "@dodona/dolos-lib";
 
 /**

cli/src/index.ts

@@ -1 +1 @@
-//export { FileView } from "./cli/views/fileView";
+//export { FileView } from "./cli/views/fileView.js";

cli/tsconfig.json

@@ -5,6 +5,6 @@
     "rootDir": "src/",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     "composite": true                        /* Enable project compilation */
   },
-  "exclude": [ "web/", "dist/" ],
+  "exclude": [ "dist/" ],
   "references": [{ "path": "../lib"}]
 }

lib/src/lib/analyze/fragment.ts

@@ -1,4 +1,4 @@
-import assert from "node:assert";
+import assert from "assert";
 import { PairedOccurrence } from "./pairedOccurrence.js";
 import { Region } from "../util/region.js";
 import { Range } from "../util/range.js";

lib/src/lib/analyze/index.ts

@@ -1,4 +1,4 @@
-import assert from "node:assert";
+import assert from "assert";
 import { HashFilter } from "../hashing/hashFilter.js";
 import { Options } from "../util/options.js";
 import { Range } from "../util/range.js";

lib/src/lib/file/file.ts

@@ -1,7 +1,7 @@
 import { Result } from "../util/result.js";
 import Identifiable from "../util/identifiable.js";
-import fs from "node:fs/promises";
-import path from "node:path";
+import fs from "fs/promises";
+import path from "path";
 
 export interface ExtraInfo {
   filename: string;

lib/src/lib/tokenizer/codeTokenizer.ts

@@ -2,7 +2,7 @@ import { default as Parser, SyntaxNode } from "tree-sitter";
 import { Region } from "../util/region.js";
 import { Token, Tokenizer } from "./tokenizer.js";
 import { ProgrammingLanguage } from "../util/language.js";
-import assert from "node:assert";
+import assert from "assert";
 
 export class CodeTokenizer extends Tokenizer {
 

lib/src/lib/util/range.ts

@@ -1,4 +1,4 @@
-import assert from "node:assert";
+import assert from "assert";
 
 /**
  * A range of whole numbers starting at `from` (inclusive) and ending at `to`

lib/src/lib/util/region.ts

@@ -1,4 +1,4 @@
-import assert from "node:assert";
+import assert from "assert";
 
 /**
  * Defines a selection in a file.

lib/tsconfig.json

@@ -4,8 +4,6 @@
         "outDir": "dist",                        /* Redirect output structure to the directory. */
         "rootDir": "src/",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
         "composite": true,                        /* Enable project compilation */
-        "module": "node16",
-        "moduleResolution": "node16"
   },
   "exclude": [ "dist/" ]
 }

tsconfig.global.json

@@ -25,9 +25,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
+    "module": "node16",                                /* Specify what module code is generated. */
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    "moduleResolution": "node",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    "moduleResolution": "node16",                     /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */