Turn on @typescript-eslint/no-unsafe-argument (#728)

toasted-nutbread · web-flow · commit 73169f06dff7 · 2024-02-25T04:47:57.000Z
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -397,7 +397,7 @@
                 "@typescript-eslint/no-floating-promises": ["error", {"ignoreIIFE": true}],
                 "@typescript-eslint/no-misused-promises": "off",
                 "@typescript-eslint/no-redundant-type-constituents": "error",
-                "@typescript-eslint/no-unsafe-argument": "off",
+                "@typescript-eslint/no-unsafe-argument": "error",
                 "@typescript-eslint/no-unsafe-assignment": "off",
                 "@typescript-eslint/no-unsafe-call": "off",
                 "@typescript-eslint/no-unsafe-enum-comparison": "off",
diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
@@ -349,12 +349,18 @@ export class Backend {
     _onWebExtensionEventWrapper(handler) {
         return /** @type {T} */ ((...args) => {
             if (this._isPrepared) {
+                // This is using SafeAny to just forward the parameters
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 handler(...args);
                 return;
             }
 
             this._prepareCompletePromise.then(
-                () => { handler(...args); },
+                () => {
+                    // This is using SafeAny to just forward the parameters
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    handler(...args);
+                },
                 () => {} // NOP
             );
         });
diff --git a/ext/js/data/database.js b/ext/js/data/database.js
@@ -194,7 +194,8 @@ export class Database {
         request.onsuccess = (e) => {
             const cursor = /** @type {IDBRequest<?IDBCursorWithValue>} */ (e.target).result;
             if (cursor) {
-                const {value} = cursor;
+                /** @type {TResult} */
+                const value = cursor.value;
                 if (noPredicate || predicate(value, predicateArg)) {
                     resolve(value, data);
                 } else {
@@ -353,7 +354,9 @@ export class Database {
         for (const {version, stores} of upgrades) {
             if (oldVersion >= version) { continue; }
 
-            for (const [objectStoreName, {primaryKey, indices}] of Object.entries(stores)) {
+            /** @type {[objectStoreName: string, value: import('database').StoreDefinition][]} */
+            const entries = Object.entries(stores);
+            for (const [objectStoreName, {primaryKey, indices}] of entries) {
                 const existingObjectStoreNames = transaction.objectStoreNames || db.objectStoreNames;
                 const objectStore = (
                     this._listContains(existingObjectStoreNames, objectStoreName) ?
@@ -394,8 +397,14 @@ export class Database {
      */
     _getAllFast(objectStoreOrIndex, query, onSuccess, onReject, data) {
         const request = objectStoreOrIndex.getAll(query);
-        request.onerror = (e) => onReject(/** @type {IDBRequest<import('core').SafeAny[]>} */ (e.target).error, data);
-        request.onsuccess = (e) => onSuccess(/** @type {IDBRequest<import('core').SafeAny[]>} */ (e.target).result, data);
+        request.onerror = (e) => {
+            const target = /** @type {IDBRequest<TResult[]>} */ (e.target);
+            onReject(target.error, data);
+        };
+        request.onsuccess = (e) => {
+            const target = /** @type {IDBRequest<TResult[]>} */ (e.target);
+            onSuccess(target.result, data);
+        };
     }
 
     /**
@@ -415,7 +424,9 @@ export class Database {
         request.onsuccess = (e) => {
             const cursor = /** @type {IDBRequest<?IDBCursorWithValue>} */ (e.target).result;
             if (cursor) {
-                results.push(cursor.value);
+                /** @type {TResult} */
+                const value = cursor.value;
+                results.push(value);
                 cursor.continue();
             } else {
                 onSuccess(results, data);
diff --git a/ext/js/data/options-util.js b/ext/js/data/options-util.js
@@ -22,6 +22,11 @@ import {escapeRegExp, isObject} from '../core/utilities.js';
 import {TemplatePatcher} from '../templates/template-patcher.js';
 import {JsonSchema} from './json-schema.js';
 
+// Some type safety rules are disabled for this file since it deals with upgrading an older format
+// of the options object to a newer format. SafeAny is used for much of this, since every single
+// legacy format does not contain type definitions.
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+
 export class OptionsUtil {
     constructor() {
         /** @type {?TemplatePatcher} */
@@ -119,6 +124,9 @@ export class OptionsUtil {
                     }
                 });
             });
+            if (typeof optionsStr !== 'string') {
+                throw new Error('Invalid value for options');
+            }
             options = parseJson(optionsStr);
         } catch (e) {
             // NOP
@@ -1197,3 +1205,5 @@ export class OptionsUtil {
         });
     }
 }
+
+/* eslint-enable @typescript-eslint/no-unsafe-argument */
diff --git a/ext/js/dictionary/dictionary-importer.js b/ext/js/dictionary/dictionary-importer.js
@@ -734,7 +734,8 @@ export class DictionaryImporter {
         const results = [];
         for (const file of files) {
             const content = await this._getData(file, new TextWriter());
-            const entries = /** @type {unknown} */ (parseJson(content));
+            /** @type {unknown} */
+            const entries = parseJson(content);
 
             startIndex = progressData.index;
             this._progress();
@@ -748,8 +749,8 @@ export class DictionaryImporter {
             this._progress();
 
             if (Array.isArray(entries)) {
-                for (const entry of entries) {
-                    results.push(convertEntry(/** @type {TEntry} */ (entry), dictionaryTitle));
+                for (const entry of /** @type {TEntry[]} */ (entries)) {
+                    results.push(convertEntry(entry, dictionaryTitle));
                 }
             }
         }
diff --git a/ext/js/display/display-anki.js b/ext/js/display/display-anki.js
@@ -376,6 +376,7 @@ export class DisplayAnki {
     _updateAdderButtons(dictionaryEntryDetails) {
         const displayTags = this._displayTags;
         for (let i = 0, ii = dictionaryEntryDetails.length; i < ii; ++i) {
+            /** @type {?Set<number>} */
             let allNoteIds = null;
             for (const {mode, canAdd, noteIds, noteInfos, ankiError} of dictionaryEntryDetails[i].modeMap.values()) {
                 const button = this._adderButtonFind(i, mode);
diff --git a/ext/js/display/display-history.js b/ext/js/display/display-history.js
@@ -37,9 +37,15 @@ export class DisplayHistory extends EventDispatcher {
         this._historyMap = new Map();
 
         const historyState = history.state;
-        const {id, state} = isObject(historyState) ? historyState : {id: null, state: null};
+        const {id, state} = (
+            typeof historyState === 'object' && historyState !== null ?
+            historyState :
+            {id: null, state: null}
+        );
+        /** @type {?import('display-history').EntryState} */
+        const stateObject = typeof state === 'object' || state === null ? state : null;
         /** @type {import('display-history').Entry} */
-        this._current = this._createHistoryEntry(id, location.href, state, null, null);
+        this._current = this._createHistoryEntry(id, location.href, stateObject, null, null);
     }
 
     /** @type {?import('display-history').EntryState} */
diff --git a/ext/js/display/display.js b/ext/js/display/display.js
@@ -1934,20 +1934,28 @@ export class Display extends EventDispatcher {
         this._hotkeyHandler.setHotkeys(this._pageType, options.inputs.hotkeys);
     }
 
-    /** */
-    async _closeTab() {
-        const tab = await new Promise((resolve, reject) => {
+    /**
+     * @returns {Promise<?chrome.tabs.Tab>}
+     */
+    _getCurrentTab() {
+        return new Promise((resolve, reject) => {
             chrome.tabs.getCurrent((result) => {
                 const e = chrome.runtime.lastError;
                 if (e) {
                     reject(new Error(e.message));
                 } else {
-                    resolve(result);
+                    resolve(typeof result !== 'undefined' ? result : null);
                 }
             });
         });
-        const tabId = tab.id;
-        await /** @type {Promise<void>} */ (new Promise((resolve, reject) => {
+    }
+
+    /**
+     * @param {number} tabId
+     * @returns {Promise<void>}
+     */
+    _removeTab(tabId) {
+        return new Promise((resolve, reject) => {
             chrome.tabs.remove(tabId, () => {
                 const e = chrome.runtime.lastError;
                 if (e) {
@@ -1956,7 +1964,16 @@ export class Display extends EventDispatcher {
                     resolve();
                 }
             });
-        }));
+        });
+    }
+
+    /** */
+    async _closeTab() {
+        const tab = await this._getCurrentTab();
+        if (tab === null) { return; }
+        const tabId = tab.id;
+        if (typeof tabId === 'undefined') { return; }
+        await this._removeTab(tabId);
     }
 
     /** */
diff --git a/ext/js/dom/text-source-generator.js b/ext/js/dom/text-source-generator.js
@@ -462,6 +462,7 @@ export class TextSourceGenerator {
      * @returns {?Range}
      */
     _caretPositionFromPointNormalizeStyles(x, y, nextElement) {
+        /** @type {Map<Element, ?string>} */
         const previousStyles = new Map();
         try {
             while (true) {
@@ -490,7 +491,7 @@ export class TextSourceGenerator {
                         // Elements with user-select: all will return the element
                         // instead of a text point inside the element.
                         if (this._isElementUserSelectAll(/** @type {Element} */ (node))) {
-                            if (previousStyles.has(node)) {
+                            if (previousStyles.has(/** @type {Element} */ (node))) {
                                 // Recursive
                                 return null;
                             }
@@ -524,6 +525,7 @@ export class TextSourceGenerator {
      * @returns {?Range}
      */
     _caretRangeFromPointExt(x, y, elements, normalizeCssZoom) {
+        /** @type {?Map<Element, ?string>} */
         let previousStyles = null;
         try {
             let i = 0;
diff --git a/ext/js/general/regex-util.js b/ext/js/general/regex-util.js
@@ -46,7 +46,9 @@ export function applyTextReplacement(text, sourceMap, pattern, replacement) {
         pattern.lastIndex += delta;
 
         if (actualReplacementLength > 0) {
-            sourceMap.insert(index, ...(new Array(actualReplacementLength).fill(0)));
+            /** @type {number[]} */
+            const zeroes = new Array(actualReplacementLength).fill(0);
+            sourceMap.insert(index, ...zeroes);
             sourceMap.combine(index - 1 + actualReplacementLength, matchText.length);
         } else {
             sourceMap.combine(index, matchText.length);
@@ -65,7 +67,13 @@ export function applyTextReplacement(text, sourceMap, pattern, replacement) {
 export function applyMatchReplacement(replacement, match) {
     const pattern = matchReplacementPattern;
     pattern.lastIndex = 0;
-    return replacement.replace(pattern, (g0, g1, g2) => {
+    /**
+     * @param {string} g0
+     * @param {string} g1
+     * @param {string} g2
+     * @returns {string}
+     */
+    const replacer = (g0, g1, g2) => {
         if (typeof g1 !== 'undefined') {
             const matchIndex = Number.parseInt(g1, 10);
             if (matchIndex >= 1 && matchIndex <= match.length) {
@@ -87,5 +95,6 @@ export function applyMatchReplacement(replacement, match) {
             }
         }
         return g0;
-    });
+    };
+    return replacement.replace(pattern, replacer);
 }
diff --git a/ext/js/input/hotkey-help-controller.js b/ext/js/input/hotkey-help-controller.js
@@ -89,10 +89,10 @@ export class HotkeyHelpController {
     // Private
 
     /**
-     * @param {Map<string, string>} commandMap
+     * @returns {Promise<chrome.commands.Command[]>}
      */
-    async _setupGlobalCommands(commandMap) {
-        const commands = await new Promise((resolve, reject) => {
+    _getAllCommands() {
+        return new Promise((resolve, reject) => {
             if (!(isObject(chrome.commands) && typeof chrome.commands.getAll === 'function')) {
                 resolve([]);
                 return;
@@ -107,10 +107,17 @@ export class HotkeyHelpController {
                 }
             });
         });
+    }
+
+    /**
+     * @param {Map<string, string>} commandMap
+     */
+    async _setupGlobalCommands(commandMap) {
+        const commands = await this._getAllCommands();
 
         commandMap.clear();
         for (const {name, shortcut} of commands) {
-            if (shortcut.length === 0) { continue; }
+            if (typeof name !== 'string' || typeof shortcut !== 'string' || shortcut.length === 0) { continue; }
             const {key, modifiers} = this._hotkeyUtil.convertCommandToInput(shortcut);
             commandMap.set(name, this._hotkeyUtil.getInputDisplayValue(key, modifiers));
         }
diff --git a/ext/js/language/translator.js b/ext/js/language/translator.js
@@ -137,6 +137,7 @@ export class Translator {
             text = this._getJapaneseOnlyText(text);
         }
         const {enabledDictionaryMap} = options;
+        /** @type {Set<string>} */
         const kanjiUnique = new Set();
         for (const c of text) {
             kanjiUnique.add(c);
@@ -702,6 +703,7 @@ export class Translator {
      * @returns {import('dictionary').TermDictionaryEntry[]}
      */
     _groupDictionaryEntriesByHeadword(dictionaryEntries, tagAggregator) {
+        /** @type {Map<string, import('dictionary').TermDictionaryEntry[]>} */
         const groups = new Map();
         for (const dictionaryEntry of dictionaryEntries) {
             const {inflectionRuleChainCandidates, headwords: [{term, reading}]} = dictionaryEntry;
@@ -1039,8 +1041,11 @@ export class Translator {
      * @param {TranslatorTagAggregator} tagAggregator
      */
     async _addTermMeta(dictionaryEntries, enabledDictionaryMap, tagAggregator) {
+        /** @type {Map<string, Map<string, {headwordIndex: number, pronunciations: import('dictionary').TermPronunciation[], frequencies: import('dictionary').TermFrequency[]}[]>>} */
         const headwordMap = new Map();
+        /** @type {string[]} */
         const headwordMapKeys = [];
+        /** @type {Map<string, {headwordIndex: number, pronunciations: import('dictionary').TermPronunciation[], frequencies: import('dictionary').TermFrequency[]}[]>[]} */
         const headwordReadingMaps = [];
 
         for (const {headwords, pronunciations, frequencies} of dictionaryEntries) {
diff --git a/ext/js/media/audio-downloader.js b/ext/js/media/audio-downloader.js
@@ -304,7 +304,17 @@ export class AudioDownloader {
             throw new Error('No custom URL defined');
         }
         const data = {term, reading};
-        return url.replace(/\{([^}]*)\}/g, (m0, m1) => (Object.prototype.hasOwnProperty.call(data, m1) ? `${data[/** @type {'term'|'reading'} */ (m1)]}` : m0));
+        /**
+         * @param {string} m0
+         * @param {string} m1
+         * @returns {string}
+         */
+        const replacer = (m0, m1) => (
+            Object.prototype.hasOwnProperty.call(data, m1) ?
+            `${data[/** @type {'term'|'reading'} */ (m1)]}` :
+            m0
+        );
+        return url.replace(/\{([^}]*)\}/g, replacer);
     }
 
     /**
diff --git a/ext/js/pages/settings/dictionary-controller.js b/ext/js/pages/settings/dictionary-controller.js
@@ -548,6 +548,7 @@ export class DictionaryController {
             optionsFull = await settingsController.getOptionsFull();
         }
 
+        /** @type {Set<string>} */
         const installedDictionaries = new Set();
         for (const {title} of dictionaries) {
             installedDictionaries.add(title);
diff --git a/ext/js/templates/sandbox/anki-template-renderer.js b/ext/js/templates/sandbox/anki-template-renderer.js
diff --git a/test/document-util.test.js b/test/document-util.test.js
diff --git a/test/dom-text-scanner.test.js b/test/dom-text-scanner.test.js
diff --git a/test/eslint-config.test.js b/test/eslint-config.test.js
diff --git a/types/ext/template-renderer.d.ts b/types/ext/template-renderer.d.ts
diff --git a/types/test/eslint-config.d.ts b/types/test/eslint-config.d.ts

Original file line number	Diff line number	Diff line change
`@@ -734,7 +734,8 @@ export class DictionaryImporter {`
`734`	`734`	`const results = [];`
`735`	`735`	`for (const file of files) {`
`736`	`736`	`const content = await this._getData(file, new TextWriter());`
`737`		`- const entries = /** @type {unknown} */ (parseJson(content));`
	`737`	`+ /** @type {unknown} */`
	`738`	`+ const entries = parseJson(content);`
`738`	`739`
`739`	`740`	`startIndex = progressData.index;`
`740`	`741`	`this._progress();`
`@@ -748,8 +749,8 @@ export class DictionaryImporter {`
`748`	`749`	`this._progress();`
`749`	`750`
`750`	`751`	`if (Array.isArray(entries)) {`
`751`		`- for (const entry of entries) {`
`752`		`- results.push(convertEntry(/** @type {TEntry} */ (entry), dictionaryTitle));`
	`752`	`+ for (const entry of /** @type {TEntry[]} */ (entries)) {`
	`753`	`+ results.push(convertEntry(entry, dictionaryTitle));`
`753`	`754`	`}`
`754`	`755`	`}`
`755`	`756`	`}`