New patching system

.editorconfig

@@ -6,7 +6,11 @@ root = true
 [*]
 indent_style = space
 indent_size = 4
-end_of_line = crlf
+end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = false
-insert_final_newline = false
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space
+indent_size = 2

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    name: Build extension
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+      - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6
+
+      - name: Install dependencies
+        run: |
+          bun install
+          bunx wxt prepare
+
+      - name: Build Chrome ZIP
+        run: bun run zip
+
+      - name: Build Firefox ZIP
+        run: bun run zip:firefox
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f
+        with:
+          path: .output/*.zip
+          include-hidden-files: true
+          if-no-files-found: error
+          compression-level: 9

.github/workflows/check.yml

@@ -15,7 +15,9 @@ jobs:
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6
 
       - name: Install dependencies
-        run: bun install
+        run: |
+          bun install
+          bunx wxt prepare
 
       - name: Add TypeScript annotations matcher
         run: |

.github/workflows/format.yml

@@ -15,7 +15,9 @@ jobs:
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6
 
       - name: Install dependencies
-        run: bun install
+        run: |
+          bun install
+          bunx wxt prepare
 
       - name: Run Prettier
         run: bunx prettier --check .

.github/workflows/lint.yml

@@ -18,7 +18,9 @@ jobs:
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6
 
       - name: Install dependencies
-        run: bun install
+        run: |
+          bun install
+          bunx wxt prepare
 
       - name: Run ESLint
         env:

.github/workflows/test.yml

@@ -15,7 +15,9 @@ jobs:
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6
 
       - name: Install dependencies
-        run: bun install
+        run: |
+          bun install
+          bunx wxt prepare
 
       - name: Run Vitest
         run: bun run vitest run --reporter=github-actions

.gitignore

@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.output
+stats.html
+stats-*.json
+.wxt
+
+# Editor directories and files
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

.prettierrc

@@ -0,0 +1,7 @@
+{
+    "objectWrap": "collapse",
+    "experimentalTernaries": true,
+    "experimentalOperatorPosition": "start",
+    "plugins": ["prettier-plugin-svelte", "prettier-plugin-jsdoc"],
+    "tsdoc": true
+}

.vscode/definePatch.code-snippets

@@ -0,0 +1,74 @@
+{
+    "definePatch": {
+        "scope": "typescript",
+        "prefix": "definePatch",
+        "body": [
+            "import { definePatch } from \"@/utils/definePatch\";",
+            "import { route } from \"@/utils/route\";",
+            "",
+            "export default definePatch({",
+            "    meta: {",
+            "        id: \"$1\",",
+            "        name: \"$2\",",
+            "        description: \"$3\",",
+            "        matches: [route(\"*\")],",
+            "    },",
+            "    init() {",
+            "        $0",
+            "    },",
+            "    cleanup() {}",
+            "});",
+        ],
+    },
+    "definePatch with settings": {
+        "scope": "typescript",
+        "prefix": "definePatchSettings",
+        "body": [
+            "import { definePatch } from \"@/utils/definePatch\";",
+            "import { route } from \"@/utils/route\";",
+            "",
+            "export default definePatch({",
+            "    meta: {",
+            "        id: \"$1\",",
+            "        name: \"$2\",",
+            "        description: \"$3\",",
+            "        matches: [route(\"*\")],",
+            "        settings: [{",
+            "            id: \"$5\",",
+            "            name: \"$6\",",
+            "            description: \"$7\",",
+            "            type: \"$8\",",
+            "            defaultValue: $9,",
+            "        }],",
+            "    },",
+            "    init(settings) {",
+            "        $0",
+            "    },",
+            "    cleanup() {}",
+            "});",
+        ],
+    },
+    "definePatch with CSS": {
+        "scope": "typescript",
+        "prefix": "definePatchCSS",
+        "body": [
+            "import { definePatch } from \"@/utils/definePatch\";",
+            "import { route } from \"@/utils/route\";",
+            "import css from \"./style.css?inline\"",
+            "",
+            "export default definePatch({",
+            "    meta: {",
+            "        id: \"$1\",",
+            "        name: \"$2\",",
+            "        description: \"$3\",",
+            "        matches: [route(\"*\")],",
+            "    },",
+            "    css,",
+            "    init() {",
+            "        $0",
+            "    },",
+            "    cleanup() {}",
+            "});",
+        ],
+    },
+}

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    "recommendations": [
+        "oven.bun-vscode",
+        "vitest.explorer",
+        "editorconfig.editorconfig",
+        "dbaeumer.vscode-eslint",
+        "svelte.svelte-vscode",
+        "esbenp.prettier-vscode"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "bun.test.enable": false,
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "eslint.codeActionsOnSave.mode": "all",
+    "explorer.fileNesting.enabled": true,
+    "explorer.fileNesting.patterns": {
+        "package.json": "bun.lock, tsconfig.json, eslint.config.js, .prettierrc, vitest.config.ts, wxt.config.ts, web-ext.config.ts"
+    },
+    "files.exclude": { "**/.wxt": true, "**/node_modules": true }
+}

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2024 BanOcean
+Copyright (c) 2024-2025 BanOcean
+Copyright (c) 2024-2026 IFV & Hephaestus Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,91 +1,107 @@
-# Improvements for VULCAN
+# Hephaestus
 
-Browser extension with improvements for eduVULCAN and Dziennik VULCAN.
+Browser extension with improvements for █████████ and ████████ ██████.
 
 ## Installation
-<a href="https://ifv.banocean.com/downloads/firefox"><img src="./assets/add to firefox.svg"></a><img width=10px><a href="https://ifv.banocean.com/downloads/chrome"><img src="./assets/add to chrome.svg"></a>
+
+<a href="https://ifv.banocean.com/downloads/firefox"><img src="./docs/add to firefox.svg"></a><img width=10px><a href="https://ifv.banocean.com/downloads/chrome"><img src="./docs/add to chrome.svg"></a>
 
 [Installation guide [PL]](https://ifv.banocean.com)<br>
-[Adding extension to browsers for development](#development-workflow)
+[Adding the extension to browsers for development](#development-workflow)
 
 ## Features
 
 <details>
     <summary>Mobile navigation</summary>
 
-| Before:                                                         | After:                                                         |
-| --------------------------------------------------------------- | -------------------------------------------------------------- |
-| <img src="./screenshots/mobileNavBefore.png" width="300px" /> | <img src="./screenshots/mobileNavAfter.png" width="300px" /> |
+| Before:                                                            | After:                                                            |
+| ------------------------------------------------------------------ | ----------------------------------------------------------------- |
+| <img src="./docs/screenshots/mobileNavBefore.png" width="300px" /> | <img src="./docs/screenshots/mobileNavAfter.png" width="300px" /> |
 
 </details>
 <details>
     <summary>PWA support</summary>
-    <img src="./screenshots/pwa.png" width="300px" />
+    <img src="./docs/screenshots/pwa.png" width="300px" />
 </details>
 
 <details>
-    <summary>Attendance statistics in separate tab</summary>
+    <summary>Attendance statistics in a separate tab</summary>
+
+| Before:                                                             | After:                                                             |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| <img src="./docs/screenshots/attendanceBefore.png" width="300px" /> | <img src="./docs/screenshots/attendanceAfter.png" width="300px" /> |
 
-| Before:                                                      | After:                                                      |
-| ------------------------------------------------------------ | ----------------------------------------------------------- |
-| <img src="./screenshots/attendanceBefore.png" width="300px" /> | <img src="./screenshots/attendanceAfter.png" width="300px" /> |
 </details>
 <details>
-    <summary>Hiding weekends in monthy calendars</summary>
-
-| Before:                                                      | After:                                                      |
-| ------------------------------------------------------------ | ----------------------------------------------------------- |
-| <img src="./screenshots/hideWeekendsBefore.png" width="300px" /> | <img src="./screenshots/hideWeekendsAfter.png" width="300px" /> |
+    <summary>Hide weekends in monthly calendars</summary>
+
+| Before:                                                               | After:                                                               |
+| --------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| <img src="./docs/screenshots/hideWeekendsBefore.png" width="300px" /> | <img src="./docs/screenshots/hideWeekendsAfter.png" width="300px" /> |
+
 </details>
 <details>
-    <summary>Displaying full name</summary>
+    <summary>Display full name</summary>
+
+| Before:                                                        | After:                                                        |
+| -------------------------------------------------------------- | ------------------------------------------------------------- |
+| <img src="./docs/screenshots/fnameBefore.png" width="300px" /> | <img src="./docs/screenshots/fnameAfter.png" width="300px" /> |
 
-| Before:                                                         | After:                                                         |
-| --------------------------------------------------------------- | -------------------------------------------------------------- |
-| <img src="./screenshots/fnameBefore.png" width="300px" /> | <img src="./screenshots/fnameAfter.png" width="300px" /> |
 </details>
 <details>
-    <summary>Clean student dashboard</summary>
+    <summary>A cleaner student dashboard</summary>
 
 Before:
 
-<img src="./screenshots/whiteboardBefore.png" width="800px" />
+<img src="./docs/screenshots/whiteboardBefore.png" width="800px" />
 
 After:
 
-<img src="./screenshots/whiteboardAfter.png" width="800px" />
+<img src="./docs/screenshots/whiteboardAfter.png" width="800px" />
 </details>
 
 <details>
-    <summary>Clean eduVULCAN home</summary>
+    <summary>A cleaner █████████ home</summary>
 
-| Before:                                                      | After:                                                      |
-| ------------------------------------------------------------ | ----------------------------------------------------------- |
-| <img src="./screenshots/evHomeBefore.png" width="300px" /> | <img src="./screenshots/evHomeAfter.png" width="300px" /> |
+| Before:                                                         | After:                                                         |
+| --------------------------------------------------------------- | -------------------------------------------------------------- |
+| <img src="./docs/screenshots/evHomeBefore.png" width="300px" /> | <img src="./docs/screenshots/evHomeAfter.png" width="300px" /> |
 
 </details>
 
 <details>
-    <summary>Other minor improvements</summary>
-    
+    <summary>Other minor enhancements</summary>
+
 - Hiding WCAG controls
 - Aligning detailed grades button
 - Redirecting to board
-- Auto redirecting to eduVULCAN login page
+- Auto-redirecting to █████████ login page
+
 </details>
 
 ## Development Workflow
+
+### Build the extension
+
+1. Make sure you have [Bun](https://bun.sh/) installed.
+2. Install required dependencies and setup project using `bun install`.
+3. Execute `bunx wxt prepare` to prepare types for futher development.
+4. Use `bun dev`/`bun dev:firefox` to start development server or `bun build`/`bun build:firefox` to build a package.
+
 ### Firefox
-To load addon from files in Firefox, you need to go to `about:debugging#/runtime/this-firefox` and click `Load Temporary Add-on...`. After that you need to select manifest.json file in file picker.<br>
-<img src="./screenshots/firefoxDebug.png">
+
+To load add-on from files in Firefox, you need to go to `about:debugging#/runtime/this-firefox` and click `Load Temporary Add-on...`. After that you need to select the `manifest.json` file from `.output/` folder in the file picker.<br>
+<img src="./docs/screenshots/firefoxDebug.png">
+
 ### Chrome
-To load extension from files in Chrome, you need to go to `chrome://extensions/` and click `Load unpacked` (with developer mode enabled)<br>
-<img src="./screenshots/chromeDebug.png">
+
+To load extension from files in Chrome, you need to go to `chrome://extensions/` and click `Load unpacked` (with Developer mode enabled)<br>
+<img src="./docs/screenshots/chromeDebug.png">
 
 ## License
 
 This project is licensed under the [MIT License](./LICENSE).
 
 ## Contributions
 
-Contributions to this project are welcome. Feel free to [open issues](https://github.com/banocean/ifv/issues) and [submit pull requests](https://github.com/banocean/ifv/pulls).
+Contributions to this project are welcome. Feel free to [open issues](https://github.com/yoper12/ifv/issues) and [submit pull requests](https://github.com/yoper12/ifv/pulls).