feat: migrate to ES modules

Author: hlxid

.prettierrc.js renamed to .prettierrc.cjs

@@ -5,4 +5,4 @@
 // but the entry-point needs to be executable so we can't have it in src/index.ts directly
 // because the resulting file won't have the executable flag and you can't properly use it that way.
 
-require("./build/src/index");
+import "./build/index.js";

index.js

@@ -0,0 +1,12 @@
+/** @type {import("ts-jest").JestConfigWithTsJest} */
+module.exports = {
+    preset: "ts-jest/presets/default-esm",
+    testEnvironment: "node",
+    // We don't want to test nodecg, and without including this jest fails because it includes a invalid json
+    modulePathIgnorePatterns: ["/nodecg/"],
+    testMatch: ["<rootDir>/test/**/*.ts", "!**/*.util.ts"],
+    extensionsToTreatAsEsm: [".ts"],
+    moduleNameMapper: {
+        "^(\\.{1,2}/.*)\\.js$": "$1"
+    },
+};

jest.config.cjs

@@ -3,6 +3,7 @@
     "version": "0.3.1",
     "description": "The CLI to install and manage nodecg-io installations. Also helps you with nodecg-io bundle related development.",
     "main": "index.js",
+    "type": "module",
     "scripts": {
         "build": "tsc -b",
         "run": "tsc -b && node build/index.js",

jest.config.js

@@ -1,8 +1,8 @@
 import CodeBlockWriter from "code-block-writer";
-import { getServiceClientName } from "../nodecgIOVersions";
-import { Installation } from "../utils/installation";
-import { CodeLanguage, GenerationOptions } from "./prompt";
-import { writeBundleFile } from "./utils";
+import { getServiceClientName } from "../nodecgIOVersions.js";
+import { Installation } from "../utils/installation.js";
+import { CodeLanguage, GenerationOptions } from "./prompt.js";
+import { writeBundleFile } from "./utils.js";
 
 interface ServiceNames {
     name: string;
@@ -39,7 +39,11 @@ export async function genExtension(opts: GenerationOptions, install: Installatio
     // the service names for each version are hardcoded and unknown for a development version.
     const services = install.dev === false ? opts.services.map((svc) => getServiceNames(svc, install.version)) : [];
 
-    const writer = new CodeBlockWriter();
+    // FIXME: Types and jest(running via node.js) require "new CodeBlockWriter()", but when running with node.js
+    // this needs to be "new CodeBlockWriter.default()" to function, wtf?!.
+    // Needs figuring out why this is happening.
+    //@ts-ignore
+    const writer = new CodeBlockWriter.default();
 
     // imports
     genImport(writer, "requireService", opts.corePackage.name, opts.language);

package.json

@@ -1,17 +1,17 @@
 import { CommandModule } from "yargs";
-import * as fs from "fs";
-import { logger } from "../utils/log";
-import { directoryExists } from "../utils/fs";
-import { Installation, readInstallInfo } from "../utils/installation";
-import { corePackages } from "../nodecgIOVersions";
-import { GenerationOptions, promptGenerationOpts } from "./prompt";
-import { runNpmBuild, runNpmInstall } from "../utils/npm";
-import { genExtension } from "./extension";
-import { findNodeCGDirectory, getNodeCGIODirectory } from "../utils/nodecgInstallation";
-import { genDashboard, genGraphic } from "./panel";
-import { genTsConfig } from "./tsConfig";
-import { writeBundleFile, yellowInstallCommand } from "./utils";
-import { genPackageJson } from "./packageJson";
+import { promises as fs } from "fs";
+import { logger } from "../utils/log.js";
+import { directoryExists } from "../utils/fs.js";
+import { Installation, readInstallInfo } from "../utils/installation.js";
+import { corePackages } from "../nodecgIOVersions.js";
+import { GenerationOptions, promptGenerationOpts } from "./prompt.js";
+import { runNpmBuild, runNpmInstall } from "../utils/npm.js";
+import { genExtension } from "./extension.js";
+import { findNodeCGDirectory, getNodeCGIODirectory } from "../utils/nodecgInstallation.js";
+import { genDashboard, genGraphic } from "./panel.js";
+import { genTsConfig } from "./tsConfig.js";
+import { writeBundleFile, yellowInstallCommand } from "./utils.js";
+import { genPackageJson } from "./packageJson.js";
 
 export const generateModule: CommandModule = {
     command: "generate",
@@ -64,11 +64,11 @@ export function ensureValidInstallation(install: Installation | undefined): inst
 export async function generateBundle(opts: GenerationOptions, install: Installation): Promise<void> {
     // Create dir if necessary
     if (!(await directoryExists(opts.bundlePath))) {
-        await fs.promises.mkdir(opts.bundlePath);
+        await fs.mkdir(opts.bundlePath);
     }
 
     // In case some re-executes the command in a already used bundle name we should not overwrite their stuff and error instead.
-    const filesInBundleDir = await fs.promises.readdir(opts.bundlePath);
+    const filesInBundleDir = await fs.readdir(opts.bundlePath);
     if (filesInBundleDir.length > 0) {
         throw new Error(
             `Directory for bundle at ${opts.bundlePath} already exists and contains files.\n` +

src/generate/extension.ts

@@ -1,10 +1,10 @@
-import { GenerationOptions } from "./prompt";
-import { logger } from "../utils/log";
-import { getLatestPackageVersion } from "../utils/npm";
-import { genNodeCGDashboardConfig, genNodeCGGraphicConfig } from "./panel";
+import { GenerationOptions } from "./prompt.js";
+import { logger } from "../utils/log.js";
+import { getLatestPackageVersion } from "../utils/npm.js";
+import { genNodeCGDashboardConfig, genNodeCGGraphicConfig } from "./panel.js";
 import { SemVer } from "semver";
-import { writeBundleFile } from "./utils";
-import { Installation } from "../utils/installation";
+import { writeBundleFile } from "./utils.js";
+import { Installation } from "../utils/installation.js";
 
 // Loaction where the development tarballs are hosted.
 export const developmentPublishRootUrl = "https://codeoverflow-org.github.io/nodecg-io-publish/";

src/generate/index.ts

@@ -1,5 +1,5 @@
-import { GenerationOptions } from "./prompt";
-import { writeBundleFile } from "./utils";
+import { GenerationOptions } from "./prompt.js";
+import { writeBundleFile } from "./utils.js";
 
 type PanelType = "graphic" | "dashboard";
 

src/generate/packageJson.ts

@@ -1,13 +1,13 @@
-import * as semver from "semver";
-import * as inquirer from "inquirer";
+import semver from "semver";
+import inquirer from "inquirer";
 import * as path from "path";
-import { directoryExists } from "../utils/fs";
-import { Installation } from "../utils/installation";
-import { getServicesFromInstall } from "../install/prompt";
-import { yellowInstallCommand } from "./utils";
-import { findNpmPackages, NpmPackage } from "../utils/npm";
-import { corePackage } from "../nodecgIOVersions";
-import { getNodeCGIODirectory } from "../utils/nodecgInstallation";
+import { directoryExists } from "../utils/fs.js";
+import { Installation } from "../utils/installation.js";
+import { getServicesFromInstall } from "../install/prompt.js";
+import { yellowInstallCommand } from "./utils.js";
+import { findNpmPackages, NpmPackage } from "../utils/npm.js";
+import { corePackage } from "../nodecgIOVersions.js";
+import { getNodeCGIODirectory } from "../utils/nodecgInstallation.js";
 
 /**
  * Describes all options for bundle generation a user has answered with inside the inquirer prompt