refactor: more TypeScript migration

build/plugin-logger.ts

@@ -0,0 +1,75 @@
+import type { FilterPattern } from '@rollup/pluginutils';
+import type { Plugin } from 'rollup';
+import { createFilter } from '@rollup/pluginutils';
+
+interface PluginOptions {
+    include?: FilterPattern;
+    exclude?: FilterPattern;
+}
+
+const LOGGER_CODE = `
+import { ConsoleSink } from '@lib/logging/consoleSink';
+import { LogLevel } from '@lib/logging/levels';
+import { LOGGER } from '@lib/logging/logger';
+
+import DEBUG_MODE from 'consts:debug-mode';
+import USERSCRIPT_ID from 'consts:userscript-id';
+
+LOGGER.configure({
+    logLevel: DEBUG_MODE ? LogLevel.DEBUG : LogLevel.INFO,
+});
+LOGGER.addSink(new ConsoleSink(USERSCRIPT_ID));
+`;
+
+export const LOGGER_SOURCE_ID = '_LOGGER_virtualSource_';
+
+/**
+ * Transformer plugin to automatically inject the logger boilerplate setup.
+ *
+ * @param      {Readonly<PluginOptions>}  options  The options
+ * @return     {Plugin}  The plugin.
+ */
+export function logger(options?: Readonly<PluginOptions>): Plugin {
+    // Another option would've been to put the boilerplate configuration into
+    // `@lib/util/logger.ts`, so the logger gets its default configuration when
+    // it's imported anywhere. However, this will also enable the logger and its
+    // console sink in the tests, which would lead to noisy test output.
+    const { include, exclude } = options ?? {};
+    const filter = createFilter(include, exclude);
+
+    return {
+        name: 'LoggerPlugin',
+
+        resolveId(id): { id: string; moduleSideEffects: boolean } | null {
+            if (id === LOGGER_SOURCE_ID) {
+                return {
+                    id: LOGGER_SOURCE_ID,
+                    moduleSideEffects: true,
+                };
+            }
+            return null;
+        },
+
+        load(id): string | undefined {
+            if (id === LOGGER_SOURCE_ID) return LOGGER_CODE;
+            return undefined;
+        },
+
+        /**
+         * Transform hook for the plugin.
+         *
+         * Injects the logger boilerplate setup.
+         *
+         * @param      {string}                       code    The code
+         * @param      {string}                       id      The identifier
+         * @return     {Promise<undefined | string>}  The transformed result.
+         */
+        async transform(code: string, id: string): Promise<undefined | string> {
+            if (!filter(id)) return;
+
+            // Insert logger code first, so it gets configured before anything
+            // else runs.
+            return [`import "${LOGGER_SOURCE_ID}";`, code].join('\n\n');
+        },
+    };
+}

build/plugin-userscript.ts

@@ -30,7 +30,7 @@ const DEFAULT_OPTIONS = {
     metadataOrder: [
         'name', 'description', 'version', 'author', 'license', 'namespace',
         'homepageURL', 'supportURL', 'downloadURL', 'updateURL',
-        'match', 'exclude', 'require', 'resource', 'run-at', 'grant', 'connect',
+        'include', 'exclude', 'require', 'resource', 'run-at', 'grant', 'connect',
     ],
 };
 

build/rollup.ts

@@ -17,8 +17,9 @@ import progress from 'rollup-plugin-progress';
 import { minify } from 'terser';
 
 import { parseChangelogEntries } from './changelog';
+import { logger } from './plugin-logger';
 import { nativejsx } from './plugin-nativejsx';
-import { UPDATE_NOTIFICATIONS_SOURCE_ID, updateNotifications } from './plugin-update-notifications';
+import { updateNotifications } from './plugin-update-notifications';
 import { MetadataGenerator, userscript } from './plugin-userscript';
 
 const OUTPUT_DIR = 'dist';
@@ -112,6 +113,9 @@ async function buildUserscriptPassOne(userscriptDir: string, userscriptMetaGener
             updateNotifications({
                 include: inputPath,
             }),
+            logger({
+                include: inputPath,
+            }),
             // To resolve some aliases, like @lib
             alias({
                 entries: {
@@ -216,8 +220,9 @@ function isExternalLibrary(modulePath: string): boolean {
     const relPath = path.relative('.', modulePath);
     // Don't mark `consts:...` modules are external libraries. They're fake
     // modules whose default exports get replaced by constants by the `consts`
-    // plugin.
-    return !(relPath.startsWith('src') || relPath.startsWith('consts:') || modulePath === UPDATE_NOTIFICATIONS_SOURCE_ID);
+    // plugin. Also don't consider any first party code we inject as 3rd party
+    // (marked with the _virtualSource_ suffix).
+    return !(relPath.startsWith('src') || relPath.startsWith('consts:') || modulePath.endsWith('_virtualSource_'));
 }
 
 function isBuiltinLib(modulePath: string): boolean {

package.json

@@ -46,7 +46,10 @@
     "@types/greasemonkey": "4.0.3",
     "@types/jest": "28.1.2",
     "@types/jest-when": "3.5.1",
+    "@types/jquery": "^3.5.14",
+    "@types/jqueryui": "^1.12.16",
     "@types/postcss-preset-env": "6.7.3",
+    "@types/resemblejs": "^4.1.0",
     "@types/rollup__plugin-virtual": "2.0.1",
     "@types/rollup-plugin-progress": "1.1.1",
     "@types/setup-polly-jest": "0.5.1",
@@ -88,6 +91,7 @@
     "jest-html-reporters": "3.0.9",
     "jest-when": "3.5.1",
     "license-checker": "25.0.1",
+    "moment": "^2.29.3",
     "nativejsx": "github:ROpdebee/nativejsx",
     "node-fetch": "3.2.6",
     "postcss": "8.4.14",

src/lib/MB/URLs.ts

@@ -1,4 +1,4 @@
-import type { ReleaseAdvRel, URLAdvRel } from './advanced-relationships';
+import type { ReleaseAdvRel, URLAdvRel } from './types-api';
 
 interface ReleaseMetadataWithARs {
     relations?: Array<URLAdvRel & ReleaseAdvRel>;