Modernize (#12)

Author: ibc

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig is awesome: https://editorconfig.org
+
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{ts,mts,mjs,cjs,js}]
+indent_style = tab
+
+[*.json]
+indent_style = tab
+
+[*.md]
+indent_style = tab

.github/workflows/awaitqueue.yaml

@@ -23,13 +23,13 @@ jobs:
             node: 20
           - os: ubuntu-24.04
             node: 22
-          - os: macos-13
-            node: 18
           - os: macos-14
             node: 20
           - os: macos-15
             node: 22
           - os: windows-2022
+            node: 20
+          - os: windows-2025
             node: 22
 
     runs-on: ${{ matrix.ci.os }}

README.md

@@ -14,9 +14,9 @@ npm install awaitqueue
 
 ## Usage
 
-In ES6:
+In ESM:
 
-```js
+```ts
 import {
 	AwaitQueue,
 	AwaitQueueTask,
@@ -26,9 +26,9 @@ import {
 } from 'awaitqueue';
 ```
 
-In CommonJS:
+Using CommonJS:
 
-```js
+```ts
 const {
 	AwaitQueue,
 	AwaitQueueTask,

eslint.config.mjs

@@ -8,7 +8,7 @@ const config = tsEslint.config(
 	{
 		languageOptions: {
 			sourceType: 'module',
-			globals: { ...globals.browser },
+			globals: { ...globals.node },
 		},
 		linterOptions: {
 			noInlineConfig: false,
@@ -107,18 +107,20 @@ const config = tsEslint.config(
 			yoda: 2,
 		},
 	},
-	// NOTE: We need to apply this only to .ts files (and not to .mjs files).
+	// NOTE: We need to apply this only to .ts source files (and not to .mjs
+	// files).
 	...tsEslint.configs.recommendedTypeChecked.map(item => ({
 		...item,
 		files: ['src/**/*.ts'],
 	})),
-	// NOTE: We need to apply this only to .ts files (and not to .mjs files).
+	// NOTE: We need to apply this only to .ts source files (and not to .mjs
+	// files).
 	...tsEslint.configs.stylisticTypeChecked.map(item => ({
 		...item,
 		files: ['src/**/*.ts'],
 	})),
 	{
-		name: 'mediasoup-client .ts files',
+		name: '.ts source files',
 		files: ['src/**/*.ts'],
 		languageOptions: {
 			parserOptions: {
@@ -143,27 +145,17 @@ const config = tsEslint.config(
 			],
 			// We want to use `type` instead of `interface`.
 			'@typescript-eslint/consistent-type-definitions': 0,
+			'@typescript-eslint/explicit-function-return-type': [
+				2,
+				{ allowExpressions: true },
+			],
 			// Sorry, we need many `any` usage.
 			'@typescript-eslint/no-explicit-any': 0,
-			'@typescript-eslint/no-unsafe-member-access': 0,
-			'@typescript-eslint/no-unsafe-assignment': 0,
-			'@typescript-eslint/no-unsafe-call': 0,
-			'@typescript-eslint/no-unsafe-return': 0,
-			'@typescript-eslint/no-unsafe-argument': 0,
-			'@typescript-eslint/consistent-indexed-object-style': 0,
 			'@typescript-eslint/no-empty-function': 0,
-			'@typescript-eslint/require-await': 0,
-			'@typescript-eslint/restrict-template-expressions': 0,
-			'@typescript-eslint/no-duplicate-type-constituents': [
-				2,
-				{ ignoreUnions: true },
-			],
-			'@typescript-eslint/unbound-method': 0,
-			'@typescript-eslint/prefer-string-starts-ends-with': 0,
 		},
 	},
 	{
-		name: 'mediasoup-client .ts test files',
+		name: '.ts test files',
 		...jestEslint.configs['flat/recommended'],
 		files: ['src/test/**/*.ts'],
 		rules: {

jest.config.mjs

@@ -0,0 +1,12 @@
+const config = {
+	verbose: true,
+	testEnvironment: 'node',
+	testRegex: 'src/tests/test.ts',
+	transform: {
+		'^.+\\.ts?$': ['ts-jest'],
+	},
+	coveragePathIgnorePatterns: ['src/Logger.ts', 'src/tests'],
+	cacheDirectory: '.cache/jest',
+};
+
+export default config;

npm-scripts.mjs

@@ -4,28 +4,37 @@ import { execSync } from 'node:child_process';
 
 const PKG = JSON.parse(fs.readFileSync('./package.json').toString());
 const RELEASE_BRANCH = 'master';
+
 // Paths for ESLint to check. Converted to string for convenience.
-const ESLINT_PATHS = ['eslint.config.mjs', 'src', 'npm-scripts.mjs'].join(' ');
+const ESLINT_PATHS = [
+	'eslint.config.mjs',
+	'jest.config.mjs',
+	'npm-scripts.mjs',
+	'src',
+].join(' ');
 // Paths for ESLint to ignore. Converted to string argument for convenience.
+
 const ESLINT_IGNORE_PATTERN_ARGS = []
 	.map(entry => `--ignore-pattern ${entry}`)
 	.join(' ');
+
 // Paths for Prettier to check/write. Converted to string for convenience.
 // NOTE: Prettier ignores paths in .gitignore so we don't need to care about
 // node/src/fbs.
 const PRETTIER_PATHS = [
 	'README.md',
 	'eslint.config.mjs',
-	'src',
+	'jest.config.mjs',
 	'npm-scripts.mjs',
 	'package.json',
 	'tsconfig.json',
+	'src',
 ].join(' ');
 
 const task = process.argv[2];
 const args = process.argv.slice(3).join(' ');
 
-run();
+void run();
 
 async function run() {
 	logInfo(args ? `[args:"${args}"]` : '');
@@ -34,11 +43,13 @@ async function run() {
 		// As per NPM documentation (https://docs.npmjs.com/cli/v9/using-npm/scripts)
 		// `prepare` script:
 		//
-		// - Runs BEFORE the package is packed, i.e. during `npm publish` and `npm pack`.
+		// - Runs BEFORE the package is packed, i.e. during `npm publish` and
+		//   `npm pack`.
 		// - Runs on local `npm install` without any arguments.
-		// - NOTE: If a package being installed through git contains a `prepare` script,
-		//   its dependencies and devDependencies will be installed, and the `prepare`
-		//   script will be run, before the package is packaged and installed.
+		// - NOTE: If a package being installed through git contains a `prepare`
+		//   script, its dependencies and devDependencies will be installed, and
+		//   the `prepare` script will be run, before the package is packaged and
+		//   installed.
 		//
 		// So here we compile TypeScript to JavaScript.
 		case 'prepare': {
@@ -48,15 +59,13 @@ async function run() {
 		}
 
 		case 'typescript:build': {
-			installDeps();
 			buildTypescript({ force: true });
 
 			break;
 		}
 
 		case 'typescript:watch': {
-			deleteLib();
-			executeCmd(`tsc --watch ${args}`);
+			watchTypescript();
 
 			break;
 		}
@@ -74,14 +83,12 @@ async function run() {
 		}
 
 		case 'test': {
-			buildTypescript({ force: false });
 			test();
 
 			break;
 		}
 
 		case 'coverage': {
-			buildTypescript({ force: false });
 			executeCmd(`jest --coverage ${args}`);
 			executeCmd('open-cli coverage/lcov-report/index.html');
 
@@ -123,15 +130,25 @@ function deleteLib() {
 	fs.rmSync('lib', { recursive: true, force: true });
 }
 
-function buildTypescript({ force = false } = { force: false }) {
+function buildTypescript({ force }) {
 	if (!force && fs.existsSync('lib')) {
 		return;
 	}
 
 	logInfo('buildTypescript()');
 
 	deleteLib();
-	executeCmd('tsc');
+
+	// Generate .js CommonJS code and .d.ts TypeScript declaration files in lib/.
+	executeCmd(`tsc ${args}`);
+}
+
+function watchTypescript() {
+	logInfo('watchTypescript()');
+
+	deleteLib();
+
+	executeCmd(`tsc --watch ${args}`);
 }
 
 function lint() {
@@ -165,6 +182,7 @@ function installDeps() {
 
 	// Install/update deps.
 	executeCmd('npm ci --ignore-scripts');
+
 	// Update package-lock.json.
 	executeCmd('npm install --package-lock-only --ignore-scripts');
 }
@@ -178,19 +196,15 @@ function checkRelease() {
 	test();
 }
 
-function executeCmd(command, exitOnError = true) {
+function executeCmd(command) {
 	logInfo(`executeCmd(): ${command}`);
 
 	try {
 		execSync(command, { stdio: ['ignore', process.stdout, process.stderr] });
 	} catch (error) {
-		if (exitOnError) {
-			logError(`executeCmd() failed, exiting: ${error}`);
+		logError(`executeCmd() failed, exiting: ${error}`);
 
-			exitWithError();
-		} else {
-			logInfo(`executeCmd() failed, ignoring: ${error}`);
-		}
+		exitWithError();
 	}
 }