fix: resolve TypeScript type errors (#1151)

Robot-Inventor · web-flow · commit 79b6af43d17b · 2024-11-18T00:09:41.000+09:00
diff --git a/rspack.config.ts b/rspack.config.ts
@@ -137,7 +137,7 @@ class RunCommandsPlugin {
 
             isFirstRun = false;
 
-            if (this.env.updateUserScripts) {
+            if (this.env["updateUserScripts"]) {
                 exec("npx tsx ./script/addUserScriptsComment.ts", (err, stdout) => {
                     if (err) {
                         // eslint-disable-next-line no-console
@@ -224,7 +224,7 @@ const unacceptableLicenseTest = (licenseIdentifier: string): boolean => {
     return !acceptableLicenses.includes(licenseIdentifier);
 };
 
-const isProduction = process.env.NODE_ENV === "production";
+const isProduction = process.env["NODE_ENV"] === "production";
 /* eslint-disable sort-keys */
 // eslint-disable-next-line max-lines-per-function
 const config = defineConfig((env) => ({
@@ -233,7 +233,7 @@ const config = defineConfig((env) => ({
     entry: {
         ...chromeScripts,
         ...firefoxScripts,
-        ...(env.updateUserScripts ? userScriptEntries : {})
+        ...(env["updateUserScripts"] ? userScriptEntries : {})
     },
     output: {
         filename: "[name]",
diff --git a/script/addUserScriptsComment.ts b/script/addUserScriptsComment.ts
@@ -22,8 +22,8 @@ for (const userScript of userScriptFiles) {
     );
     if (
         !isPlainObject(localizedMessages) ||
-        !isPlainObject(localizedMessages.manifest_description) ||
-        typeof localizedMessages.manifest_description.message !== "string"
+        !isPlainObject(localizedMessages["manifest_description"]) ||
+        typeof localizedMessages["manifest_description"]["message"] !== "string"
     ) {
         throw new Error(`Invalid localized messages for ${languageCode}`);
     }
@@ -33,7 +33,7 @@ for (const userScript of userScriptFiles) {
 // @name         Shadowban Scanner (${languageName})
 // @namespace    https://github.com/Robot-Inventor/shadowban-scanner/
 // @version      ${packagejson.version}
-// @description  ${localizedMessages.manifest_description.message}
+// @description  ${localizedMessages["manifest_description"]["message"]}
 // @author       Robot-Inventor (ろぼいん / @keita_roboin)
 // @match        https://*.twitter.com/*
 // @match        https://*.x.com/*
diff --git a/script/addonsLinter.ts b/script/addonsLinter.ts
@@ -10,7 +10,7 @@ const main = async (): Promise<void> => {
         config: {
             // eslint-disable-next-line id-length
             _: ["./dist/firefox/"],
-            logLevel: process.env.VERBOSE ? "debug" : "fatal",
+            logLevel: process.env["VERBOSE"] ? "debug" : "fatal",
             shouldScanFile: () => true
         }
     };
diff --git a/script/updatePrivacyPolicy.ts b/script/updatePrivacyPolicy.ts
@@ -18,12 +18,12 @@ for (const file of files) {
     const parsedMessages: unknown = JSON.parse(fs.readFileSync(messagePath, "utf8"));
     if (
         !isPlainObject(parsedMessages) ||
-        !isPlainObject(parsedMessages.privacyPolicyText) ||
-        typeof parsedMessages.privacyPolicyText.message !== "string"
+        !isPlainObject(parsedMessages["privacyPolicyText"]) ||
+        typeof parsedMessages["privacyPolicyText"]["message"] !== "string"
     ) {
         throw new Error(`Privacy policy text not found in ${messagePath}`);
     }
-    const privacyPolicyText = parsedMessages.privacyPolicyText.message;
+    const privacyPolicyText = parsedMessages["privacyPolicyText"]["message"];
 
     const newPrivacyPolicySection = `
 ${START_MARKER}
diff --git a/src/ts/components/sbsMessage.ts b/src/ts/components/sbsMessage.ts
@@ -40,12 +40,12 @@ class SbsMessage extends LitElement {
     public isNoteShown = false;
 
     @property({ attribute: false, reflect: true })
-    public onRenderedCallback?: () => void;
+    public onRenderedCallback?: undefined | (() => void);
 
     @property({ reflect: true, type: String })
     public textColor = "white";
 
-    public static styles = css`
+    public static override styles = css`
         * {
             font-family: sans-serif;
         }
@@ -224,7 +224,7 @@ class SbsMessage extends LitElement {
         event.stopPropagation();
     }
 
-    protected render(): ReturnType<typeof html> {
+    protected override render(): ReturnType<typeof html> {
         const outerClasses = classMap({
             "focal-mode": this.isFocalMode,
             "shadowban-scanner-message": true,
diff --git a/src/ts/components/settingsDescription.ts b/src/ts/components/settingsDescription.ts
@@ -3,7 +3,7 @@ import { customElement } from "lit/decorators.js";
 
 @customElement("settings-description")
 class SettingsDescription extends LitElement {
-    public static styles = css`
+    public static override styles = css`
         :host {
             display: block;
         }
@@ -21,7 +21,7 @@ class SettingsDescription extends LitElement {
     `;
 
     // eslint-disable-next-line class-methods-use-this
-    protected render(): ReturnType<typeof html> {
+    protected override render(): ReturnType<typeof html> {
         return html`
             <div class="container">
                 <div class="settings-description">
diff --git a/src/ts/components/settingsItem.ts b/src/ts/components/settingsItem.ts
@@ -9,7 +9,7 @@ class SettingsItem extends LitElement {
     @query("md-checkbox")
     private checkbox!: MdCheckbox;
 
-    public static styles = css`
+    public static override styles = css`
         .settings-item {
             display: flex;
             flex-direction: row;
@@ -40,7 +40,7 @@ class SettingsItem extends LitElement {
     @property({ attribute: true, reflect: true, type: Boolean })
     public checked = false;
 
-    protected render(): ReturnType<typeof html> {
+    protected override render(): ReturnType<typeof html> {
         return html`
             <div class="settings-item">
                 <label for="${this.settingsName}">
diff --git a/src/ts/components/settingsSeparator.ts b/src/ts/components/settingsSeparator.ts
@@ -3,7 +3,7 @@ import { customElement } from "lit/decorators.js";
 
 @customElement("settings-separator")
 class SettingsSeparator extends LitElement {
-    public static styles = css`
+    public static override styles = css`
         .settings-separator {
             --left-line-width: 0.75rem;
 
@@ -35,7 +35,7 @@ class SettingsSeparator extends LitElement {
     `;
 
     // eslint-disable-next-line class-methods-use-this
-    protected render(): ReturnType<typeof html> {
+    protected override render(): ReturnType<typeof html> {
         return html`
             <div class="settings-separator">
                 <hr />
diff --git a/src/ts/contentScript.ts b/src/ts/contentScript.ts
@@ -2,12 +2,19 @@ import { EVENT_GENERATOR_ID, EVENT_GENERATOR_SETTINGS_ATTRIBUTE } from "./common
 import { i18n, runtime, storage } from "webextension-polyfill";
 import { DEFAULT_SETTINGS } from "./common/settings";
 import { Translator } from "./common/translator";
+import { isSettings } from "../types/common/settings.guard";
 
 // eslint-disable-next-line max-statements
 const main = async (): Promise<void> => {
     const settings = await storage.local.get(DEFAULT_SETTINGS);
 
-    if (["pro.twitter.com", "pro.x.com"].includes(location.hostname) && !settings.enableOnXPro) return;
+    if (
+        ["pro.twitter.com", "pro.x.com"].includes(location.hostname) &&
+        isSettings(settings) &&
+        !settings.enableOnXPro
+    ) {
+        return;
+    }
 
     const translator = new Translator(
         (key, substitutions) => i18n.getMessage(key, substitutions),
diff --git a/src/ts/core/core.ts b/src/ts/core/core.ts
@@ -62,7 +62,7 @@ class Core {
         if (!(analyzer.tweet.hasAnyProblem || this.settings.showMessagesInUnproblematicTweets)) return;
 
         if (!tweet.metadata.isFocalMode && this.settings.enableCompactMode) {
-            tweet.element.dataset.sbCompactMode = analyzer.tweet.hasAnyProblem ? "red" : "green";
+            tweet.element.dataset["sbCompactMode"] = analyzer.tweet.hasAnyProblem ? "red" : "green";
             return;
         }
 
diff --git a/src/ts/initialSetup.ts b/src/ts/initialSetup.ts
@@ -1,4 +1,5 @@
 import { INSTRUCTION_URL, TRANSLATION_ATTRIBUTE } from "./common/constants";
+import { type NonEmptyArray, isNonEmptyArray } from "@robot-inventor/ts-utils";
 import { i18n, runtime, tabs } from "webextension-polyfill";
 import type { Settings } from "../types/common/settings";
 import { Translator } from "./common/translator";
@@ -49,7 +50,7 @@ const INITIAL_SETUP_ITEMS = [
         ],
         settingsKey: "enableForOtherUsersTweets"
     }
-] satisfies InitialSetupItem[];
+] satisfies NonEmptyArray<InitialSetupItem>;
 
 const removeButtons = (buttonsOuter: Element): void => {
     while (buttonsOuter.firstChild) {
@@ -81,8 +82,8 @@ const insertButtons = (buttonsOuter: Element, translator: Translator, setupItem:
             button.classList.add("selected");
         }
 
-        button.dataset.settingsKey = setupItem.settingsKey;
-        button.dataset.settingsValue = option.value.toString();
+        button.dataset["settingsKey"] = setupItem.settingsKey;
+        button.dataset["settingsValue"] = option.value.toString();
 
         button.addEventListener("click", () => {
             document.querySelectorAll(".settings-button-item").forEach((element) => {
@@ -127,8 +128,11 @@ const updateInstructionToCompletionMessage = (translator: Translator): void => {
 
 const closeCurrentTab = async (): Promise<void> => {
     const activeTabs = await tabs.query({ active: true, currentWindow: true });
+    if (!isNonEmptyArray(activeTabs)) return;
+
     const [currentTab] = activeTabs;
     if (!currentTab.id) throw new Error("no current tab");
+
     void tabs.remove(currentTab.id);
 };
 
@@ -155,7 +159,7 @@ const showCompletionMessage = (buttonsOuter: Element, translator: Translator): v
     translator.translateElements();
 };
 
-// eslint-disable-next-line max-statements
+// eslint-disable-next-line max-statements, max-lines-per-function
 const main = (): void => {
     const buttonsOuter = document.querySelector("#settings-buttons");
     if (!buttonsOuter) throw new Error("no #settings-buttons");
@@ -185,7 +189,9 @@ const main = (): void => {
         // eslint-disable-next-line no-magic-numbers
         if (setupItemIndex < INITIAL_SETUP_ITEMS.length - 1) {
             setupItemIndex++;
-            insertButtons(buttonsOuter, translator, INITIAL_SETUP_ITEMS[setupItemIndex]);
+            const setupItem = INITIAL_SETUP_ITEMS[setupItemIndex];
+            if (!setupItem) throw new Error("no setupItem");
+            insertButtons(buttonsOuter, translator, setupItem);
         } else {
             setupItemIndex++;
             showCompletionMessage(buttonsOuter, translator);
@@ -196,7 +202,9 @@ const main = (): void => {
         // eslint-disable-next-line no-magic-numbers
         if (setupItemIndex > 0) {
             setupItemIndex--;
-            insertButtons(buttonsOuter, translator, INITIAL_SETUP_ITEMS[setupItemIndex]);
+            const setupItem = INITIAL_SETUP_ITEMS[setupItemIndex];
+            if (!setupItem) throw new Error("no setupItem");
+            insertButtons(buttonsOuter, translator, setupItem);
             updateNavigationButtonsStatus(backButton, nextButton, setupItemIndex, INITIAL_SETUP_ITEMS.length);
         }
 
diff --git a/src/ts/userScript/userScriptBase.ts b/src/ts/userScript/userScriptBase.ts
@@ -10,10 +10,9 @@ const createUserScript = (translationData: TranslationData): void => {
         if (substitutions) {
             const substitutionsArray = typeof substitutions === "string" ? [substitutions] : substitutions;
             let result = translationData[key].message;
-            // eslint-disable-next-line id-length
-            for (let i = 0; i < substitutionsArray.length; i++) {
+            for (const [index, value] of substitutionsArray.entries()) {
                 // eslint-disable-next-line no-magic-numbers
-                result = result.replace(`$${String(i + 1)}`, substitutionsArray[i]);
+                result = result.replace(`$${String(index + 1)}`, value);
             }
             return result;
         }
diff --git a/src/types/core/reactProps/reactProps.guard.ts b/src/types/core/reactProps/reactProps.guard.ts
@@ -13,11 +13,10 @@ export function isCellInnerDivProps(obj: unknown): obj is CellInnerDivProps {
         (typedObj["children"] !== null &&
             typeof typedObj["children"] === "object" ||
             typeof typedObj["children"] === "function") &&
-        (typeof typedObj["children"]["_owner"] === "undefined" ||
-            (typedObj["children"]["_owner"] !== null &&
-                typeof typedObj["children"]["_owner"] === "object" ||
-                typeof typedObj["children"]["_owner"] === "function") &&
-            typeof typedObj["children"]["_owner"]["key"] === "string")
+        (typedObj["children"]["_owner"] !== null &&
+            typeof typedObj["children"]["_owner"] === "object" ||
+            typeof typedObj["children"]["_owner"] === "function") &&
+        typeof typedObj["children"]["_owner"]["key"] === "string"
     )
 }
 
diff --git a/src/types/ossLicenses.guard.ts b/src/types/ossLicenses.guard.ts
@@ -13,11 +13,9 @@ export function isOSSLicenses(obj: unknown): obj is OSSLicenses {
                 typeof e === "object" ||
                 typeof e === "function") &&
             typeof e["name"] === "string" &&
-            (typeof e["version"] === "undefined" ||
-                typeof e["version"] === "string") &&
+            typeof e["version"] === "string" &&
             typeof e["repository"] === "string" &&
-            (typeof e["source"] === "undefined" ||
-                typeof e["source"] === "string") &&
+            typeof e["source"] === "string" &&
             typeof e["license"] === "string" &&
             typeof e["licenseText"] === "string"
         )

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ const main = async (): Promise<void> => {`
`10`	`10`	`config: {`
`11`	`11`	`// eslint-disable-next-line id-length`
`12`	`12`	`_: ["./dist/firefox/"],`
`13`		`- logLevel: process.env.VERBOSE ? "debug" : "fatal",`
	`13`	`+ logLevel: process.env["VERBOSE"] ? "debug" : "fatal",`
`14`	`14`	`shouldScanFile: () => true`
`15`	`15`	`}`
`16`	`16`	`};`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ class Core {`
`62`	`62`	`if (!(analyzer.tweet.hasAnyProblem \|\| this.settings.showMessagesInUnproblematicTweets)) return;`
`63`	`63`
`64`	`64`	`if (!tweet.metadata.isFocalMode && this.settings.enableCompactMode) {`
`65`		`- tweet.element.dataset.sbCompactMode = analyzer.tweet.hasAnyProblem ? "red" : "green";`
	`65`	`+ tweet.element.dataset["sbCompactMode"] = analyzer.tweet.hasAnyProblem ? "red" : "green";`
`66`	`66`	`return;`
`67`	`67`	`}`
`68`	`68`