* Added type declaration for .eslintrc.mjs.

* Isolated logging code into LogFactory.mts. * Moved build scripts to "build" directory. * Fixed unit-tests.
cowwoc · Dec 5, 2023 · 49fb5f9 · 49fb5f9
1 parent 25e96d6
commit 49fb5f9
Show file tree

Hide file tree

Showing 12 changed files with 256 additions and 260 deletions.
diff --git a/.eslintrc.d.mts b/.eslintrc.d.mts
@@ -0,0 +1,4 @@
+import {Linter} from "eslint";
+
+declare const config: Linter.Config;
+export default config;
diff --git a/build/LogFactory.mts b/build/LogFactory.mts
@@ -0,0 +1,49 @@
+import {
+	createLogger,
+	format,
+	Logger,
+	transports
+} from "winston";
+
+// https://stackoverflow.com/a/63486530/14731
+const Reset = "\x1b[0m";
+const FgWhite = "\x1b[37m";
+const BgRed = "\x1b[41m";
+
+class LogFactory
+{
+	/**
+	 * @param name the name of the logger
+	 */
+	public static getLogger(name: string): Logger
+	{
+		return createLogger({
+			transports: [new transports.Console()],
+			format: format.combine(
+				format(info =>
+				{
+					// https://github.com/winstonjs/winston/issues/1345#issuecomment-393853665
+					info.level = info.level.toUpperCase();
+					return info;
+				})(),
+				format.errors({stack: true}),
+				format.prettyPrint(),
+				format.colorize(),
+				format.timestamp({format: "YYYY-MM-DD HH:mm:ss.SSS"}),
+				format.printf(({
+					               timestamp,
+					               level,
+					               message,
+					               stack
+				               }) =>
+				{
+					if (stack)
+						return `${timestamp} ${level} ${FgWhite + BgRed + name + Reset} - ${message}\n${stack}`;
+					return `${timestamp} ${level} ${FgWhite + BgRed + name + Reset} - ${message}`;
+				})
+			)
+		});
+	}
+}
+
+export {LogFactory};
diff --git a/scripts/build.mts → build/Project.mts b/scripts/build.mts → build/Project.mts
@@ -1,10 +1,8 @@
-import * as url from "url";
+import url from "url";
 import path from "path";
 import {ESLint} from "eslint";
-// @ts-ignore
-import eslintConfig from "../.eslintrc.mjs";
 import TypeDoc from "typedoc";
-import fs from "fs";
+import fs from "node:fs";
 import rollupCommonjs from "@rollup/plugin-commonjs";
 import {nodeResolve as rollupNodeResolve} from "@rollup/plugin-node-resolve";
 import rollupTypescript from "@rollup/plugin-typescript";
@@ -17,15 +15,11 @@ import ts from "typescript";
 import {glob} from "glob";
 import {minify} from "terser";
 import {spawn} from "child_process";
-import {
-	createLogger,
-	format,
-	Logger,
-	transports
-} from "winston";
 import {mode} from "./mode.mjs";
+import {LogFactory} from "./LogFactory.mjs";
+import eslintConfig from "../.eslintrc.mjs";
 
-class Build
+class Project
 {
 	private readonly mode: string;
 
@@ -86,7 +80,7 @@ class Build
 		// them.
 		config.include = config.include.filter((element: string) =>
 		{
-			return element !== "build.mts" && !element.startsWith("test/");
+			return element !== "build/Project.mts" && !element.startsWith("test/");
 		});
 		config.compilerOptions.outDir = "target/publish/node/";
 		config.compilerOptions.declaration = true;
@@ -283,62 +277,13 @@ class Build
 	}
 }
 
-// https://stackoverflow.com/a/63486530/14731
-const Reset = "\x1b[0m";
-const FgWhite = "\x1b[37m";
-const BgRed = "\x1b[41m";
-
-class LogFactory
-{
-	/**
-	 * @param name the name of the logger
-	 * @param mode the operational mode ("DEBUG" or "RELEASE")
-	 */
-	public static getLogger(name: string, mode: string): Logger
-	{
-		let messageFormat;
-		if (mode === "DEBUG")
-			messageFormat = format.prettyPrint();
-		else
-			messageFormat = format.simple();
-		return createLogger({
-			transports: [new transports.Console()],
-			format: format.combine(
-				format(info =>
-				{
-					// https://github.com/winstonjs/winston/issues/1345#issuecomment-393853665
-					info.level = info.level.toUpperCase();
-					return info;
-				})(),
-				format.errors({stack: true}),
-				messageFormat,
-				format.colorize(),
-				format.timestamp({format: "YYYY-MM-DD HH:mm:ss.SSS"}),
-				format.printf(({
-					timestamp,
-					level,
-					message,
-					stack
-				}) =>
-				{
-					if (stack)
-					{
-						return `${timestamp} ${level} ${FgWhite + BgRed + name + Reset} - ${message}\n${stack}`;
-					}
-					return `${timestamp} ${level} ${FgWhite + BgRed + name + Reset} - ${message}`;
-				})
-			)
-		});
-	}
-}
-
 console.time("Time elapsed");
 
 const __filename = path.basename(url.fileURLToPath(import.meta.url));
-const log = LogFactory.getLogger(__filename, mode);
+const log = LogFactory.getLogger(__filename);
 log.info(mode + " mode detected");
 
-const build = new Build(mode);
+const build = new Project(mode);
 await Promise.all([build.lint(), build.compileForNode(), build.compileForBrowser(),
 	build.generateDocumentation(), build.copyResources()]);
 await build.test();

diff --git a/scripts/TestCompiler.mts → build/TestCompiler.mts b/scripts/TestCompiler.mts → build/TestCompiler.mts
@@ -10,7 +10,7 @@ class TestCompiler
 	private static readonly rootDir: string = path.resolve(".");
 	// We have to include at least one existing file to avoid CompilerHost complaining that it couldn't find any
 	// input files
-	private static readonly existingFileToSuppressError = "scripts/build.mts";
+	private static readonly existingFileToSuppressError = "build/Project.mts";
 	private static readonly snippetFilename = "test.mts";
 	private static readonly config = TestCompiler.createParsedCommandLine();
 	private static readonly defaultCompilerHost = ts.createCompilerHost(TestCompiler.config.options);

diff --git a/scripts/mode.mts → build/mode.mts b/scripts/mode.mts → build/mode.mts
diff --git a/package.json b/package.json
@@ -18,8 +18,8 @@
 		"url": "https://github.com/cowwoc/requirements.js/"
 	},
 	"scripts": {
-		"build.debug": "node node_modules/tsx/dist/cli.mjs scripts/build.mts --mode=DEBUG",
-		"build.release": "node node_modules/tsx/dist/cli.mjs scripts/build.mts --mode=RELEASE"
+		"build.debug": "node node_modules/tsx/dist/cli.mjs build/Project.mts --mode=DEBUG",
+		"build.release": "node node_modules/tsx/dist/cli.mjs build/Project.mts --mode=RELEASE"
 	},
 	"browser": "browser/index.js",
 	"module": "node/index.mjs",
@@ -33,25 +33,25 @@
 	"license": "Apache-2.0",
 	"packageManager": "[email protected]",
 	"devDependencies": {
-		"@eslint/js": "^8.54.0",
+		"@eslint/js": "^8.55.0",
 		"@rollup/plugin-commonjs": "^25.0.7",
 		"@rollup/plugin-node-resolve": "^15.2.3",
 		"@rollup/plugin-typescript": "^11.1.5",
 		"@types/chai": "^4.3.11",
 		"@types/diff": "^5.0.8",
-		"@types/eslint": "^8.44.7",
+		"@types/eslint": "^8.44.8",
 		"@types/lodash": "^4.14.202",
 		"@types/minimist": "^1.2.5",
 		"@types/mocha": "^10.0.6",
-		"@types/node": "^20.9.4",
+		"@types/node": "^20.10.3",
 		"@types/rollup-plugin-node-globals": "^1.4.4",
 		"@types/tmp": "^0.2.6",
-		"@typescript-eslint/eslint-plugin": "^6.12.0",
-		"@typescript-eslint/parser": "^6.12.0",
+		"@typescript-eslint/eslint-plugin": "^6.13.2",
+		"@typescript-eslint/parser": "^6.13.2",
 		"browser-sync": "^2.29.3",
 		"c8": "^8.0.1",
 		"chai": "^4.3.10",
-		"eslint": "^8.54.0",
+		"eslint": "^8.55.0",
 		"eslint-import-resolver-typescript": "^3.6.1",
 		"eslint-plugin-import": "^2.29.0",
 		"eslint-plugin-tsdoc": "^0.2.17",
@@ -60,19 +60,19 @@
 		"install": "^0.13.0",
 		"minimist": "^1.2.8",
 		"mocha": "^10.2.0",
-		"pnpm": "^8.10.5",
+		"pnpm": "^8.11.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
-		"rollup": "^4.5.1",
+		"rollup": "^4.6.1",
 		"rollup-plugin-node-globals": "^1.4.0",
 		"source-map-support": "^0.5.21",
 		"strip-ansi": "^7.1.0",
 		"taffydb": "^2.7.3",
-		"terser": "^5.24.0",
+		"terser": "^5.25.0",
 		"tmp": "^0.2.1",
 		"ts-node": "^10.9.1",
 		"tslib": "^2.6.2",
-		"tsx": "^4.4.0",
+		"tsx": "^4.6.2",
 		"typedoc": "^0.25.4",
 		"typedoc-plugin-missing-exports": "^2.1.0",
 		"typescript": "^5.3.2",