feat(dev): Add oxlint to the project

* Add oxlint for linting and type checking
* Update prettier config to be aware of tailwind CSS
* Add a CI workflow to run both on all PRs
* Run both tools and accept all edits to get a good baseline

Author: a5ehren

.github/workflows/format-lint.yml

@@ -0,0 +1,37 @@
+name: Format & Lint
+
+on:
+    pull_request:
+        types:
+            - opened
+            - synchronize
+            - reopened
+            - ready_for_review
+
+permissions:
+    contents: read
+
+concurrency:
+    group: format-lint-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    format-and-lint:
+        name: fmt & lint
+        runs-on: ubuntu-22.04
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v6
+
+            - name: Set up Bun
+              uses: oven-sh/setup-bun@v2
+
+            - name: Install dependencies
+              run: bun ci
+
+            - name: Check formatting
+              run: bun run fmt:check
+
+            - name: Run lint (CI format)
+              run: bun run lint:ci

.gitignore

@@ -10,8 +10,13 @@ result
 package-lock.json
 # src/renderer/public/*
 
+AGENTS.md
+CLAUDE.md
+.codex
+.claude
+
 # Custom
 # *.exe
 temp
 guest_server/winboat_guest_server.exe
-guest_server/winboat_guest_server.zip
+guest_server/winboat_guest_server.zip

.oxlintrc.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "plugins": ["typescript", "unicorn", "oxc", "vue"],
+    "categories": {
+        "correctness": "error"
+    },
+    "rules": {},
+    "env": {
+        "builtin": true
+    },
+    "ignorePatterns": ["/src/renderer/public/xel"],
+    "options": {
+        "typeAware": true,
+        "typeCheck": true
+    }
+}

.prettierignore

@@ -1,3 +1,3 @@
-
 # Ignore xel's files
 /src/renderer/public/xel
+

.prettierrc

@@ -1,5 +1,7 @@
 {
     "tabWidth": 4,
     "printWidth": 120,
-    "arrowParens": "avoid"
+    "arrowParens": "avoid",
+    "plugins": ["prettier-plugin-tailwindcss"],
+    "tailwindConfig": "./tailwind.config.ts"
 }

README.md

@@ -48,18 +48,18 @@ Before running WinBoat, ensure your system meets the following requirements:
 - **Virtualization**: KVM enabled in BIOS/UEFI
     - [How to enable virtualization](https://duckduckgo.com/?t=h_&q=how+to+enable+virtualization+in+%3Cmotherboard+brand%3E+bios&ia=web)
 - **In case of Docker:**
-  - **Docker**: Required for containerization
-      - [Installation Guide](https://docs.docker.com/engine/install/)
-      - **⚠️ NOTE:** Docker Desktop is **not** supported, you will run into issues if you use it
-  - **Docker Compose v2**: Required for compatibility with docker-compose.yml files
-      - [Installation Guide](https://docs.docker.com/compose/install/#plugin-linux-only)
-  - **Docker User Group**: Add your user to the `docker` group
-      - [Setup Instructions](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
+    - **Docker**: Required for containerization
+        - [Installation Guide](https://docs.docker.com/engine/install/)
+        - **⚠️ NOTE:** Docker Desktop is **not** supported, you will run into issues if you use it
+    - **Docker Compose v2**: Required for compatibility with docker-compose.yml files
+        - [Installation Guide](https://docs.docker.com/compose/install/#plugin-linux-only)
+    - **Docker User Group**: Add your user to the `docker` group
+        - [Setup Instructions](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
 - **In case of Podman:**
-  - **Podman**: Required for containerization
-      - [Installation Guide](https://podman.io/docs/installation#installing-on-linux)
-  - **Podman Compose**: Required for compatibility with podman-compose.yml files
-      - [Installation Guide](https://github.com/containers/podman-compose?tab=readme-ov-file#installation)
+    - **Podman**: Required for containerization
+        - [Installation Guide](https://podman.io/docs/installation#installing-on-linux)
+    - **Podman Compose**: Required for compatibility with podman-compose.yml files
+        - [Installation Guide](https://github.com/containers/podman-compose?tab=readme-ov-file#installation)
 - **FreeRDP**: Required for remote desktop connection (Please make sure you have **Version 3.x.x** with sound support included)
     - [Installation Guide](https://github.com/FreeRDP/FreeRDP/wiki/PreBuilds)
 - [OPTIONAL] **Kernel Modules**: The `iptables` / `nftables` and `iptable_nat` kernel modules can be loaded for network autodiscovery and better shared filesystem performance, but this is not obligatory in newer versions of WinBoat
@@ -75,12 +75,13 @@ You can download the latest Linux builds under the [Releases](https://github.com
 - **.rpm:** The intended format for Fedora based distributions
 - **Nix (Nixpkgs)**
     1. Add the winboat package to your config (ensure using nixpkgs-unstable)
-    using `environment.systemPackages = [pkgs.winboat];` or `home.packages = [pkgs.winboat];` if using home manager.
+       using `environment.systemPackages = [pkgs.winboat];` or `home.packages = [pkgs.winboat];` if using home manager.
     2. Add the following lines to your nix configuration
     ```nix
     virtualisation.docker.enable = true;
     users.users.{yourUser}.extraGroups = ["docker"];
     ```
+
 ## Known Issues About Container Runtimes
 
 - Docker Desktop is **unsupported** for now

bun.lock

@@ -5,13 +5,18 @@
     "type": "module",
     "main": "main/main.js",
     "engines": {
-        "node": ">=23.6.0",
+        "node": ">=24.11.0",
         "bun": ">=1.3.0"
     },
     "scripts": {
         "dev": "bun scripts/dev-server.ts",
         "build:gs": "bash build-guest-server.sh",
-        "build:linux-gs": "bash build-guest-server.sh && bun scripts/build.ts && electron-builder --linux"
+        "build:linux-gs": "bash build-guest-server.sh && bun scripts/build.ts && electron-builder --linux",
+        "lint": "oxlint",
+        "lint:fix": "oxlint --fix",
+        "lint:ci": "oxlint --format=github",
+        "fmt": "prettier . --write",
+        "fmt:check": "prettier . --check"
     },
     "repository": "https://github.com/TibixDev/winboat",
     "author": {
@@ -21,15 +26,19 @@
     },
     "devDependencies": {
         "@types/node-fetch": "^2.6.13",
+        "@types/pngjs": "^6.0.5",
         "@types/turndown": "^5.0.6",
         "@vitejs/plugin-vue": "^6.0.4",
         "autoprefixer": "^10.4.24",
         "chalk": "^5.6.2",
         "chokidar": "^5.0.0",
         "electron": "^40.2.1",
         "electron-builder": "^26.7.0",
+        "oxlint": "^1.64.0",
+        "oxlint-tsgolint": "^0.22.1",
         "postcss": "^8.5.6",
-        "prettier": "3.8.1",
+        "prettier": "^3.8.3",
+        "prettier-plugin-tailwindcss": "^0.8.0",
         "tailwindcss": "^3.4.17",
         "typescript": "~5.9.3",
         "vite": "^7.3.1",

package.json

@@ -22,15 +22,21 @@ function buildMain() {
     return compileTs(mainPath);
 }
 
-FileSystem.rmSync(Path.join(__dirname, "..", "build"), {
-    recursive: true,
-    force: true,
-});
+async function build() {
+    FileSystem.rmSync(Path.join(__dirname, "..", "build"), {
+        recursive: true,
+        force: true,
+    });
 
-console.log(Chalk.blueBright("Transpiling renderer & main..."));
+    console.log(Chalk.blueBright("Transpiling renderer & main..."));
 
-Promise.allSettled([buildRenderer(), buildMain()]).then(() => {
+    await Promise.all([buildRenderer(), buildMain()]);
     console.log(
         Chalk.greenBright("Renderer & main successfully transpiled! (ready to be built with electron-builder)"),
     );
+}
+
+void build().catch(error => {
+    console.error(error);
+    process.exitCode = 1;
 });