feat!: merge extensions branch to the nightly

.github/workflows/build.yml

@@ -11,13 +11,14 @@ on:
       - beta
       - rc
       - release
+      - extensions
     tags:
       - "*"
   workflow_dispatch:
 
 env:
-  # default value, will be overwritten later if tag exists
-  APP_VERSION: "0.1.0"
+  # A default value, will be overwritten later if tag exists
+  APP_VERSION: "0.0.1"
 
 jobs:
   tauri:
@@ -27,18 +28,46 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - name: "macOS-ARM"
-            platform: "macos-latest" # for Arm based macs (M1 and above).
+          - name: "macOS ARM"
+            identifier: "macos-arm"
+            platform: "macos-latest" # For Arm based macs (M1 and above).
             args: "--target aarch64-apple-darwin"
-          - name: "macOS-x86_64"
-            platform: "macos-latest" # for Intel based macs.
+            type: "non-portable"
+          - name: "macOS x86_64"
+            identifier: "macos-x86"
+            platform: "macos-latest" # For Intel based macs.
             args: "--target x86_64-apple-darwin"
+            type: "non-portable"
           - name: "Linux"
+            identifier: "linux"
             platform: "ubuntu-22.04"
             args: ""
+            type: "non-portable"
           - name: "Windows"
+            identifier: "windows"
             platform: "windows-latest"
             args: ""
+            type: "non-portable"
+          - name: "macOS ARM (Portable)"
+            identifier: "macos-arm"
+            platform: "macos-latest" # For Arm based macs (M1 and above).
+            args: "--target aarch64-apple-darwin"
+            type: "portable"
+          - name: "macOS x86_64 (Portable)"
+            identifier: "macos-x86"
+            platform: "macos-latest" # For Intel based macs.
+            args: "--target x86_64-apple-darwin"
+            type: "portable"
+          - name: "Linux (Portable)"
+            identifier: "linux"
+            platform: "ubuntu-22.04"
+            args: ""
+            type: "portable"
+          - name: "Windows (Portable)"
+            identifier: "windows"
+            platform: "windows-latest"
+            args: ""
+            type: "portable"
 
     runs-on: ${{ matrix.platform }}
     steps:
@@ -67,22 +96,38 @@ jobs:
           sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
 
       - name: Use version from Github Tag (Non-Windows)
-        if: startsWith(github.ref, 'refs/tags/') && matrix.name != 'Windows'
+        if: startsWith(github.ref, 'refs/tags/') && matrix.identifier != 'windows'
         run: |
           TAG_NAME="${GITHUB_REF#refs/tags/}"
           echo "APP_VERSION=${TAG_NAME}" >> $GITHUB_ENV
 
       - name: Use version from Github Tag (Windows)
-        if: startsWith(github.ref, 'refs/tags/') && matrix.name == 'Windows'
+        if: startsWith(github.ref, 'refs/tags/') && matrix.identifier == 'windows'
         run: |
           $TAG_NAME = $env:GITHUB_REF -replace 'refs/tags/', ''
           echo "APP_VERSION=$TAG_NAME" >> $env:GITHUB_ENV
 
+      - name: Remove File System restrictions (Portable-only)
+        if: matrix.type == 'portable'
+        uses: restackio/update-json-file-action@6f50afee9a03a456a30cd574123db793319f7544
+        with:
+          file: "./src-tauri/capabilities/plugin-fs.json"
+          fields: "{
+            \"permissions[0].allow\": [{\"path\":\"**/*\"}]
+          }"
+
+      - name: Mark window title as Portable (Portable-only)
+        if: matrix.type == 'portable'
+        uses: restackio/update-json-file-action@6f50afee9a03a456a30cd574123db793319f7544
+        with:
+          file: "./src-tauri/tauri.conf.json"
+          fields: "{\"app.windows[0].title\": \"Kaede Portable\"}"
+
       - name: Bump tauri.conf.json version
         uses: restackio/update-json-file-action@6f50afee9a03a456a30cd574123db793319f7544
         with:
           file: "./src-tauri/tauri.conf.json"
-          fields: '{"version": "${{ env.APP_VERSION }}"}'
+          fields: "{\"version\": \"${{ env.APP_VERSION }}\"}"
 
       - name: Bump Cargo.toml version
         uses: colt-1/toml-editor@da6b46ee7779ed730d2160393ed95fb20e82696d
@@ -100,6 +145,15 @@ jobs:
       - name: Install frontend dependencies
         run: bun install
 
+      - name: Run TypeScript checks
+        run: bun run typecheck
+
+      - name: Run ESLint
+        run: bun run lint
+
+      - name: Run Vitest
+        run: bun run test
+
       - name: Build a Tauri app (Non-Release)
         if: (startsWith(github.ref, 'refs/tags/')) != true
         uses: tauri-apps/tauri-action@564aea5a8075c7a54c167bb0cf5b3255314a7f9d
@@ -121,81 +175,81 @@ jobs:
           args: ${{ matrix.args }}
 
       - name: Upload binary (Windows, NSIS)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'Windows'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'windows' && matrix.type != 'portable'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-windows-nsis-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-windows-nsis-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/release/bundle/nsis/${{ steps.json_properties.outputs.productName }}_${{steps.json_properties.outputs.version}}_x64-setup.exe"
 
       - name: Upload binary (Windows, MSI)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'Windows'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'windows' && matrix.type != 'portable'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-windows-msi-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-windows-msi-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/release/bundle/msi/${{ steps.json_properties.outputs.productName }}_${{steps.json_properties.outputs.version}}_x64_en-US.msi"
 
-      - name: Upload binary (Windows, portable)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'Windows'
+      - name: Upload binary (Windows, non-setup)
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'windows'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-windows-portable-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-windows-non-setup-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/release/${{ steps.json_properties.outputs.productName }}.exe"
 
       - name: Upload binary (Linux, DEB)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'Linux'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'linux'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-linux-deb-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-linux-deb-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/release/bundle/deb/${{ steps.json_properties.outputs.productName }}_${{steps.json_properties.outputs.version}}_amd64.deb"
 
       - name: Upload binary (Linux, RPM)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'Linux'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'linux'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-linux-rpm-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-linux-rpm-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/release/bundle/rpm/${{ steps.json_properties.outputs.productName }}-${{steps.json_properties.outputs.version}}-1.x86_64.rpm"
 
       - name: Upload binary (Linux, AppImage)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'Linux'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'linux'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-linux-app-image-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-linux-app-image-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/release/bundle/appimage/${{ steps.json_properties.outputs.productName }}_${{steps.json_properties.outputs.version}}_amd64.AppImage"
 
       - name: Upload binary (macOS, x86_64, DMG)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'macOS-x86_64'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'macos-x86'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-macos-x86_64-dmg-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-macos-x86_64-dmg-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/x86_64-apple-darwin/release/bundle/dmg/${{ steps.json_properties.outputs.productName }}_${{steps.json_properties.outputs.version}}_x64.dmg"
 
       - name: Upload binary (macOS, x86_64, tarball)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'macOS-x86_64'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'macos-x86'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-macos-x86_64-tarball-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-macos-x86_64-tarball-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/x86_64-apple-darwin/release/bundle/macos/${{ steps.json_properties.outputs.productName }}.app.tar.gz"
 
       - name: Upload binary (macOS, ARM, DMG)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'macOS-ARM'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'macos-arm'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-macos-arm-dmg-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-macos-arm-dmg-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/aarch64-apple-darwin/release/bundle/dmg/${{ steps.json_properties.outputs.productName }}_${{steps.json_properties.outputs.version}}_aarch64.dmg"
 
       - name: Upload binary (macOS, ARM, tarball)
-        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.name == 'macOS-ARM'
+        if: (startsWith(github.ref, 'refs/tags/') != true) && matrix.identifier == 'macos-arm'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
         with:
           if-no-files-found: "warn"
-          name: "${{ steps.json_properties.outputs.productName }}-nightly-macos-arm-tarball-${{steps.json_properties.outputs.version}}-${{ github.ref_name }}"
+          name: "${{ steps.json_properties.outputs.productName }}-dev-macos-arm-tarball-${{steps.json_properties.outputs.version}}-${{ matrix.type }}-${{ github.ref_name }}"
           path: "./src-tauri/target/aarch64-apple-darwin/release/bundle/macos/${{ steps.json_properties.outputs.productName }}.app.tar.gz"

.gitignore

@@ -1,3 +1,6 @@
+# Development
+public/
+
 # Logs
 logs
 *.log

docs/CONTRIBUTING.md

@@ -1,3 +1,5 @@
+[README for JavaScript-related code](../src/README.md) | [README for Rust-related code](../src-tauri/README.md) | Contributing Guidelines
+
 # Contributions Guidelines
 
 ## Note
@@ -10,19 +12,39 @@ Translations are done externally via a [Kaede Translations repository](https://g
 
 ## Extensions
 
-tbd
+You need this section only if you want to develop an extension.
+
+### Repositories
+
+Kaede has two built-in plugin repositories.
+
+The first one is a [Kaede Add-ons User Repository (KAUR)](https://github.com/kaede-basement/kaur), similar to [AUR](https://aur.archlinux.org/) and [nixpkgs](https://github.com/NixOS/nixpkgs). This repository contains user published extensions.
+
+The second one is a [trusted-extensions repository](https://github.com/kaede-basement/trusted-extensions). I publish my extensions there. Others may publish there too, but only by contacting me. A plugin publisher must provide me the plugin source code and build manuals. I will manually review the provided code and provide the feedback if something is not good. The reviewing procedure will happen each time a plugin publisher wants to update their extension in the repository.
+
+### Safety
+
+Extensions can be loaded in two environments.
+
+The first one is a restricted environment (sandbox) that uses a permission-based system. When enabling the plugin for the first time, users are prompted with the permissions window. That window has permission toggles that the plugin requested. KAUR extensions are executed in this environment.
+
+Restricted environment is achieved by using a [Secure ECMAScript](https://github.com/endojs/endo) framework. Each permission has its own list of globals that are passed to the plugin. Unfortunately, almost every DOM operation is prohibited since it leads to the sandbox escape.
+
+The second one is an unrestricted environment that allows plugins to do everything that the Kaede can do itself. Trusted extensions are executed in this environment. Settings also have an option to enable the execution of KAUR extensions that require an unrestricted environment.
 
 ## Code Formatting
 
 All files are formatted with [ESLint](https://eslint.org/) using the configuration in `eslint.config.js`. Ensure it is run on changed files before committing!
 
 Please also follow the project's conventions for frontend:
 
+- No AI slops in the launcher code (plugins don't count).
 - TypeScript is highly recommended.
 - `.vue` file names should be formatted as `PascalCase`. All other files should use `kebab-case`.
 - Exported constants should be formatted as `PascalCase`.
 - Functions, variables, non-exported constants should be formatted as `camelCase`.
-- Elements styling is preferred by using `Tailwind v3` classes. If there is no utility class for some case, make your own, or use CSS/JS.
+- Element styling is preferred by using `Tailwind v3` classes. If there is no utility class for some cases, then make your own with CSS.
+- [BEM](https://en.bem.info/methodology/) methodology is the preferred way to name element IDs and classes to simplify styling by extensions. All elements should have unique IDs.
 
 ## Commit Messages
 
@@ -33,24 +55,24 @@ Please also follow the project's conventions for frontend:
 ### Elements
 
 - **Type**: Choose from the following list. If none of the types match, use `chore`.
-  - `feat`: A new feature
-  - `fix`: A bug fix
-  - `docs`: Documentation only changes
-  - `style`: Changes that do not affect the meaning of the code
-  - `refactor`: Improving code structure
-  - `perf`: A code change that improves performance
-  - `test`: Adding missing tests or correcting existing tests
-  - `build`: Changes that affect the build system or external dependencies
-  - `chore`: Other changes that don't modify src or test files
-  - `revert`: Reverts a previous commit
-  - `release`: Releasing a new version
-  - `ci`: Changes to our CI configuration
+  - `feat`: A new feature.
+  - `fix`: A bug fix.
+  - `docs`: Documentation only changes.
+  - `style`: Changes that do not affect the meaning of the code.
+  - `refactor`: Improving code structure.
+  - `perf`: A code change that improves performance.
+  - `test`: Adding missing tests or correcting existing tests.
+  - `build`: Changes that affect the build system or external dependencies.
+  - `chore`: Other changes that don't modify src or test files.
+  - `revert`: Reverts a previous commit.
+  - `release`: Releasing a new version.
+  - `ci`: Changes to our CI configuration.
 - **Scope**: As described in Conventional Commits.
 - **Breaking Change**: If you're introducing a breaking change, append `!` to the type or scope, e.g., `feat(ui)!: Breaking change`.
 
 - **Subject**: Brief description of the change.
 
 ### Guidelines
 
-- Use imperative mood, e.g., "add feature" instead of "adding feature" or "added feature".
+- Use imperative mood, e.g. "add feature" instead of "adding feature" or "added feature".
 - Avoid ending with a period.