feat(eslint): add rules

chore: format

Signed-off-by: kash / Hytus <[email protected]>

.eslintrc

@@ -11,7 +11,7 @@
   "plugins": ["import", "unused-imports"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "project": "./tsconfig.json"
+    "project": "./tsconfig.eslint.json"
   },
   "rules": {
     "@typescript-eslint/explicit-module-boundary-types": "off",
@@ -44,7 +44,14 @@
     "@typescript-eslint/no-redundant-type-constituents": "off",
     // for eslint-plugin-unused-imports
     "@typescript-eslint/no-unused-vars": "off",
-    "unused-imports/no-unused-imports": "error"
-  },
-  "ignorePatterns": ["webpack.*", "forge.config.ts"]
+    "unused-imports/no-unused-imports": "error",
+    // import rules
+    "import/order": [
+      "error",
+      {
+        "newlines-between": "always",
+        "alphabetize": { "order": "asc", "caseInsensitive": true }
+      }
+    ]
+  }
 }

forge.config.ts

@@ -1,11 +1,12 @@
-import type { ForgeConfig } from '@electron-forge/shared-types'
 
-import { MakerSquirrel } from '@electron-forge/maker-squirrel'
-import { MakerZIP } from '@electron-forge/maker-zip'
-import { WebpackPlugin } from "@electron-forge/plugin-webpack"
+import { MakerSquirrel } from "@electron-forge/maker-squirrel"
+import { MakerZIP } from "@electron-forge/maker-zip"
 import { AutoUnpackNativesPlugin } from "@electron-forge/plugin-auto-unpack-natives"
-import { mainConfig } from './webpack.main.config'
-import { rendererConfig } from './webpack.renderer.config'
+import { WebpackPlugin } from "@electron-forge/plugin-webpack"
+import type { ForgeConfig } from "@electron-forge/shared-types"
+
+import { mainConfig } from "./webpack.main.config"
+import { rendererConfig } from "./webpack.renderer.config"
 
 const config: ForgeConfig = {
   packagerConfig: {
@@ -15,38 +16,42 @@ const config: ForgeConfig = {
   makers: [
     // Only Windows supported for now
     // We can add darwin/linux later for Wine/Proton users
-    new MakerSquirrel(), new MakerZIP()
+    new MakerSquirrel(),
+    new MakerZIP(),
   ],
   plugins: [
     new AutoUnpackNativesPlugin({}),
     new WebpackPlugin({
-      devContentSecurityPolicy: 'default-src \'self\' \'unsafe-inline\' data:; script-src \'self\' \'unsafe-eval\' \'unsafe-inline\' data:',
+      devContentSecurityPolicy:
+        "default-src 'self' 'unsafe-inline' data:; script-src 'self' 'unsafe-eval' 'unsafe-inline' data:",
       mainConfig: mainConfig,
       renderer: {
         config: rendererConfig,
-        entryPoints: [{
-          html: "./src/assets/index.html",
-          js: "./src/assets/index.js",
-          name: "main_window",
-          preload: {
-            js: "./src/preload.ts"
-          }
-        }]
+        entryPoints: [
+          {
+            html: "./src/assets/index.html",
+            js: "./src/assets/index.js",
+            name: "main_window",
+            preload: {
+              js: "./src/preload.ts",
+            },
+          },
+        ],
       },
-    })
+    }),
   ],
   publishers: [
     {
-      name: '@electron-forge/publisher-github',
+      name: "@electron-forge/publisher-github",
       config: {
         repository: {
-          owner: 'MoolahModding',
-          name: 'MoolahModLauncher'
+          owner: "MoolahModding",
+          name: "MoolahModLauncher",
         },
-        prerelease: true
-      }
-    }
-  ]
+        prerelease: true,
+      },
+    },
+  ],
 }
 
 export default config

package.json

@@ -8,12 +8,16 @@
     "package": "electron-forge package",
     "make": "electron-forge make",
     "publish": "electron-forge publish",
-    "lint": "run-p lint:*",
-    "lint:eslint": "eslint \"src/**/*.{js,ts,tsx}\"",
-    "lint:prettier": "prettier --check \"src/**/*.{js,ts,tsx}\"",
-    "format": "run-p format:*",
-    "format:eslint": "eslint \"src/**/*.{js,ts,tsx}\" --fix",
-    "format:prettier": "prettier --write \"src/**/*.{js,ts,tsx}\"",
+    "lint": "run-p \"lint:*\"",
+    "lint:eslint-src": "eslint \"src/**/*.{js,ts,tsx}\"",
+    "lint:eslint-config": "eslint \"./*.{js,ts}\"",
+    "lint:prettier-src": "prettier --check \"src/**/*.{js,ts,tsx}\"",
+    "lint:prettier-conifg": "prettier --check \"./*.{js,ts}\"",
+    "format": "run-p \"format:*\"",
+    "format:eslint-src": "eslint \"src/**/*.{js,ts,tsx}\" --fix",
+    "format:eslint-config": "eslint \"./*.{js,ts}\" --fix",
+    "format:prettier-src": "prettier --write \"src/**/*.{js,ts,tsx}\"",
+    "format:prettier-config": "prettier --write \"./*.{js,ts}\"",
     "typecheck": "tsc --noEmit"
   },
   "repository": {

src/config.ts

@@ -1,6 +1,7 @@
 import { existsSync, writeFileSync, readFileSync } from "node:fs"
 import path from "node:path"
 import { exit } from "node:process"
+
 import type { ConfigType } from "./types/config"
 
 type ConfigKey = keyof ConfigType
@@ -45,7 +46,10 @@ class ConfigInternal {
     if (existsSync(confPath)) {
       try {
         const configFile = readFileSync(confPath)
-        return new ConfigInternal(JSON.parse(configFile.toString()) as ConfigType, confPath) // TODO: safe parse JSON
+        return new ConfigInternal(
+          JSON.parse(configFile.toString()) as ConfigType,
+          confPath
+        ) // TODO: safe parse JSON
       } catch (err) {
         console.error(err)
         exit(1)

src/filewatcher.ts

@@ -1,7 +1,9 @@
+import type { WebContents } from "electron"
 import path from "node:path"
-import { getModsDirectory } from "./config"
+
 import chokidar from "chokidar"
-import type { WebContents } from "electron"
+
+import { getModsDirectory } from "./config"
 
 const watchPath = path.join(getModsDirectory())
 const watcher = chokidar.watch(watchPath)

src/installedlistpopulator.ts

@@ -6,6 +6,7 @@ import {
   readFileSync,
 } from "node:fs"
 import path from "node:path"
+
 import { getModsDirectory } from "./config"
 
 // TODO: refactor

src/installlocators.ts

@@ -1,7 +1,8 @@
 import fs from "node:fs"
 import path from "node:path"
-import regedit from "winreg"
+
 import drivelist from "drivelist"
+import regedit from "winreg"
 
 // TODO: refactor
 

src/main.ts

@@ -1,11 +1,11 @@
-import { exit } from "node:process"
 import { app, BrowserWindow, dialog, ipcMain, shell } from "electron"
+import { exit } from "node:process"
 
 // import filewatcher from './filewatcher'
-import { installAllPackages } from "./mod_installer"
+import { config } from "./config"
 import { resolveInstall } from "./installlocators"
+import { installAllPackages } from "./mod_installer"
 import { installShellExtension, uninstallShellExtension } from "./setup_win32"
-import { config } from "./config"
 
 // TODO: refactor
 

src/mod_installer.ts

@@ -1,11 +1,13 @@
+import { dialog, app } from "electron"
+import path from "node:path"
+
 import AdmZip from "adm-zip"
 import fs from "fs-extra"
-import path from "node:path"
-import toposort from "toposort"
 import { globSync } from "glob"
+import toposort from "toposort"
 
 import { config, getModsDirectory } from "./config"
-import { dialog, app } from "electron"
+
 
 // TODO: refactor, add types
 

src/mod_updater.ts

@@ -1,5 +1,5 @@
-import { getCurrentModVersionByMWS } from "./providers/modworkshop"
 import { getLatestModVersionByGitHub } from "./providers/githubreleases"
+import { getCurrentModVersionByMWS } from "./providers/modworkshop"
 
 // TODO: refactor
 

tsconfig.eslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "src/**/*",
+    "./*.ts",
+  ]
+}

webpack.main.config.ts

@@ -8,14 +8,14 @@ const mainConfig: Configuration = {
     rules: commonRules,
   },
   resolve: {
-    extensions: ['.js', '.ts', '.jsx', '.tsx', '.css', '.json'],
+    extensions: [".js", ".ts", ".jsx", ".tsx", ".css", ".json"],
   },
   // ! prevent `UnhandledSchemeError` ref: https://github.com/webpack/webpack/issues/13290
   externals: {
     "node:fs": {},
     "node:process": {},
-    "node:path": {}
-  }
+    "node:path": {},
+  },
 }
 
-export { mainConfig }
+export { mainConfig }

webpack.plugins.ts

@@ -2,7 +2,7 @@ import ForkTsCheckerWebpackPlugin from "fork-ts-checker-webpack-plugin"
 import type { WebpackPluginInstance } from "webpack"
 
 const commonPlugins: WebpackPluginInstance[] = [
-  new ForkTsCheckerWebpackPlugin()
+  new ForkTsCheckerWebpackPlugin(),
 ]
 
 export { commonPlugins }

webpack.renderer.config.ts

@@ -1,6 +1,7 @@
-import { Configuration } from "webpack"
-import { rendererRules } from "./webpack.rules"
+import type { Configuration } from "webpack"
+
 import { commonPlugins } from "./webpack.plugins"
+import { rendererRules } from "./webpack.rules"
 
 const rendererConfig: Configuration = {
   // XXX: should add `optimization` key for production?
@@ -10,14 +11,14 @@ const rendererConfig: Configuration = {
   },
   plugins: commonPlugins,
   resolve: {
-    extensions: ['.js', '.ts', '.jsx', '.tsx', '.css'],
+    extensions: [".js", ".ts", ".jsx", ".tsx", ".css"],
   },
   // ! prevent `UnhandledSchemeError` ref: https://github.com/webpack/webpack/issues/13290
   externals: {
     "node:fs": {},
     "node:process": {},
-    "node:path": {}
-  }
+    "node:path": {},
+  },
 }
 
-export { rendererConfig }
+export { rendererConfig }

webpack.rules.ts

@@ -5,15 +5,15 @@ type RuleOptions = Required<ModuleOptions>["rules"]
 const commonRules: RuleOptions = [
   {
     test: /native_modules[/\\].+\.node$/,
-    use: 'node-loader',
+    use: "node-loader",
   },
   {
     test: /[/\\]node_modules[/\\].+\.(m?js|node)$/,
     parser: { amd: false },
     use: {
-      loader: '@vercel/webpack-asset-relocator-loader',
+      loader: "@vercel/webpack-asset-relocator-loader",
       options: {
-        outputAssetBase: 'native_modules',
+        outputAssetBase: "native_modules",
       },
     },
   },
@@ -22,7 +22,7 @@ const commonRules: RuleOptions = [
     test: /\.tsx?$/,
     exclude: /(node_modules|\.webpack)/,
     use: {
-      loader: 'ts-loader',
+      loader: "ts-loader",
       options: {
         transpileOnly: true,
       },
@@ -34,8 +34,8 @@ const rendererAdditionalRules: RuleSetRule[] = [
   {
     // XXX: should use `MiniCssExtractPlugin.loader` in production?
     test: /\.css$/,
-    use: ['style-loader', 'css-loader'],
-  }
+    use: ["style-loader", "css-loader"],
+  },
 ]
 
 const rendererRules: RuleOptions = [...commonRules, ...rendererAdditionalRules]