eslint: enforce class member accessibility (#1258)

oliverschwendener · Nov 25, 2024 · aa6cff1 · aa6cff1
1 parent d005d11
commit aa6cff1
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 17 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -19,6 +19,11 @@ export default [
              */
             "no-useless-constructor": "off",
             "@typescript-eslint/no-useless-constructor": "error",
+
+            /**
+             * Enforces explicit class-member accessibility.
+             */
+            "@typescript-eslint/explicit-member-accessibility": ["error", { accessibility: "explicit" }],
         },
         languageOptions: {
             globals: {

diff --git a/src/main/Core/BrowserWindow/BrowserWindowCreator/BrowserWindowCreator.test.ts b/src/main/Core/BrowserWindow/BrowserWindowCreator/BrowserWindowCreator.test.ts
@@ -8,7 +8,7 @@ const constructorMock = vi.fn().mockReturnValue(browserWindowMock);
 vi.mock("electron", () => {
     return {
         BrowserWindow: class {
-            constructor(options: BrowserWindowConstructorOptions) {
+            public constructor(options: BrowserWindowConstructorOptions) {
                 constructorMock(options);
                 return browserWindowMock;
             }

diff --git a/src/main/Core/PowershellUtility/PowershellUtility.ts b/src/main/Core/PowershellUtility/PowershellUtility.ts
@@ -5,7 +5,7 @@ import { join } from "path";
 import type { PowershellUtility as PowershellUtilityInterface } from "./Contract";
 
 export class PowershellUtility implements PowershellUtilityInterface {
-    static PowershellPath = `C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe`;
+    public static PowershellPath = `C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe`;
 
     private readonly byteOrderMark: string = "\ufeff";
 

diff --git a/src/main/Core/TrayIcon/TrayCreator.test.ts b/src/main/Core/TrayIcon/TrayCreator.test.ts
@@ -8,7 +8,7 @@ const dummyTrayConstructor = vi.fn().mockReturnValue(dummyTray);
 vi.mock("electron", () => {
     return {
         Tray: class {
-            constructor(iconFilePath: string) {
+            public constructor(iconFilePath: string) {
                 return dummyTrayConstructor(iconFilePath);
             }
         },

diff --git a/src/main/Extensions/ColorConverter/ColorConverterExtension.ts b/src/main/Extensions/ColorConverter/ColorConverterExtension.ts
@@ -34,7 +34,7 @@ export class ColorConverterExtension implements Extension {
         private readonly colorConverter: ColorConverter,
     ) {}
 
-    async getSearchResultItems(): Promise<SearchResultItem[]> {
+    public async getSearchResultItems(): Promise<SearchResultItem[]> {
         return [];
     }
 

diff --git a/src/main/Extensions/CustomWebSearch/CustomWebSearchExtension.ts b/src/main/Extensions/CustomWebSearch/CustomWebSearchExtension.ts
@@ -27,7 +27,7 @@ export class CustomWebSearchExtension implements Extension {
         private readonly urlImageGenerator: UrlImageGenerator,
     ) {}
 
-    async getSearchResultItems(): Promise<SearchResultItem[]> {
+    public async getSearchResultItems(): Promise<SearchResultItem[]> {
         // Custom search engines do not have static search results
         return [];
     }

diff --git a/src/main/Extensions/JetBrainsToolbox/JetBrainsToolboxExtension.ts b/src/main/Extensions/JetBrainsToolbox/JetBrainsToolboxExtension.ts
@@ -51,19 +51,19 @@ export class JetBrainsToolboxExtension implements Extension {
         githubUserName: "scomans",
     };
 
-    readonly toolboxPaths = {
+    private readonly toolboxPaths = {
         Windows: process.env.LOCALAPPDATA + "/JetBrains/Toolbox/",
         macOS: process.env.HOME + "/Library/Application Support/JetBrains/Toolbox/",
         Linux: process.env.HOME + "/.local/share/JetBrains/Toolbox/",
     };
 
-    readonly configPaths = {
+    private readonly configPaths = {
         Windows: process.env.APPDATA + "/JetBrains/",
         macOS: process.env.HOME + "/Library/Application Support/JetBrains/",
         Linux: process.env.HOME + "/.config/JetBrains/",
     };
 
-    recents: SearchResultItem[] = [];
+    private recents: SearchResultItem[] = [];
 
     public constructor(
         private readonly operatingSystem: OperatingSystem,
@@ -74,7 +74,7 @@ export class JetBrainsToolboxExtension implements Extension {
         private readonly translator: Translator,
     ) {}
 
-    async getSearchResultItems(): Promise<SearchResultItem[]> {
+    public async getSearchResultItems(): Promise<SearchResultItem[]> {
         const recentPaths = await this.getRecents();
 
         this.recents = await Promise.all(
@@ -177,7 +177,7 @@ export class JetBrainsToolboxExtension implements Extension {
         return recents;
     }
 
-    async getSearchItem(recent: JetBrainsToolboxRecent): Promise<SearchResultItem> {
+    private async getSearchItem(recent: JetBrainsToolboxRecent): Promise<SearchResultItem> {
         const { t } = this.translator.createT(this.getI18nResources());
         const img = await this.getProjectImage(recent);
         const path = recent.path;

diff --git a/src/main/Extensions/TerminalLauncher/TerminalLauncherExtension.ts b/src/main/Extensions/TerminalLauncher/TerminalLauncherExtension.ts
@@ -31,7 +31,7 @@ export class TerminalLauncherExtension implements Extension {
         private readonly terminalRegistry: TerminalRegistry,
     ) {}
 
-    async getSearchResultItems(): Promise<SearchResultItem[]> {
+    public async getSearchResultItems(): Promise<SearchResultItem[]> {
         return [];
     }
 

diff --git a/src/main/Extensions/VSCode/VSCodeExtension.ts b/src/main/Extensions/VSCode/VSCodeExtension.ts
@@ -36,13 +36,13 @@ export class VSCodeExtension implements Extension {
         githubUserName: "IrishBruse",
     };
 
-    readonly stateDatabasePaths = {
+    private readonly stateDatabasePaths = {
         Windows: process.env.APPDATA + "/Code/User/globalStorage/state.vscdb",
         macOS: process.env.HOME + "/Library/Application Support/Code/User/globalStorage/state.vscdb",
         Linux: process.env.HOME + "/.config/Code/User/globalStorage/state.vscdb",
     };
 
-    recents: SearchResultItem[] = [];
+    private recents: SearchResultItem[] = [];
 
     public constructor(
         private readonly operatingSystem: OperatingSystem,
@@ -52,7 +52,7 @@ export class VSCodeExtension implements Extension {
         private readonly fileImageGenerator: FileImageGenerator,
     ) {}
 
-    async getSearchResultItems(): Promise<SearchResultItem[]> {
+    public async getSearchResultItems(): Promise<SearchResultItem[]> {
         const searchResults: SearchResultItem[] = [];
 
         for (const recent of this.getRecents()) {
@@ -82,7 +82,7 @@ export class VSCodeExtension implements Extension {
         );
     }
 
-    getUri = (recent: VscodeRecent) => {
+    private getUri = (recent: VscodeRecent) => {
         if (recent.fileUri) {
             return recent.fileUri;
         }
@@ -97,7 +97,8 @@ export class VSCodeExtension implements Extension {
 
         throw new Error("Unknown file type");
     };
-    getPath = (uri: string) => {
+
+    private getPath = (uri: string) => {
         const decodedUri = decodeURIComponent(uri);
         if (uri.startsWith("file://")) {
             const url = new URL(decodedUri);
@@ -146,7 +147,7 @@ export class VSCodeExtension implements Extension {
         return this.getImage();
     }
 
-    async getSearchItem(recent: VscodeRecent): Promise<SearchResultItem> {
+    private async getSearchItem(recent: VscodeRecent): Promise<SearchResultItem> {
         const uri = this.getUri(recent);
         const fileType = this.getFileType(recent, uri);
         const commandArg = this.getCommandArg(recent);