mirror of
https://github.com/feschber/lan-mouse.git
synced 2026-03-29 08:00:55 +03:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
59383bb9c0 | ||
|
|
be452bc59e | ||
|
|
68c2efc3ec | ||
|
|
b0e580627a | ||
|
|
aa0f96c8dc | ||
|
|
d87a8cd60f |
@@ -1,24 +0,0 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
charset = utf-8
|
||||
|
||||
[*.rs]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
max_line_length = 100
|
||||
|
||||
[*.{yml,yaml}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[*.toml]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.nix]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
@@ -1,34 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Ensure we're at the repo root
|
||||
cd "$(git rev-parse --show-toplevel)" || exit 1
|
||||
|
||||
echo "Running cargo fmt (auto-format)..."
|
||||
# Run formatter to apply fixes but do not stage them. If formatting changed,
|
||||
# fail the commit so the user can review and stage the changes manually.
|
||||
cargo fmt --all
|
||||
if ! git diff --quiet --exit-code; then
|
||||
echo "" >&2
|
||||
echo "ERROR: cargo fmt modified files. Review changes, stage them, and commit again." >&2
|
||||
git --no-pager diff --name-only
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Running cargo clippy..."
|
||||
# Matches CI: deny warnings to keep code health strict
|
||||
if ! cargo clippy --workspace --all-targets --all-features -- -D warnings; then
|
||||
echo "" >&2
|
||||
echo "ERROR: clippy found warnings/errors. Fix them before committing." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Running cargo test..."
|
||||
if ! cargo test --workspace --all-features; then
|
||||
echo "" >&2
|
||||
echo "ERROR: Some tests failed. Fix tests before committing." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "All pre-commit checks passed."
|
||||
exit 0
|
||||
6
.github/workflows/cachix.yml
vendored
6
.github/workflows/cachix.yml
vendored
@@ -7,10 +7,6 @@ on:
|
||||
branches: ["main"]
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
nix:
|
||||
strategy:
|
||||
@@ -23,7 +19,7 @@ jobs:
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
|
||||
@@ -1,17 +1,10 @@
|
||||
name: "Release"
|
||||
run-name: "Release - ${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || github.event.inputs.name || github.ref_name }}"
|
||||
name: "pre-release"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
tags:
|
||||
- v**
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
name:
|
||||
description: 'Development release name'
|
||||
required: false
|
||||
default: ''
|
||||
|
||||
|
||||
|
||||
env:
|
||||
CARGO_TERM_COLOR: always
|
||||
@@ -20,40 +13,19 @@ jobs:
|
||||
linux-release-build:
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- name: install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install libx11-dev libxtst-dev
|
||||
sudo apt-get install libadwaita-1-dev libgtk-4-dev
|
||||
- name: Release Build
|
||||
run: |
|
||||
cargo build --release
|
||||
cp target/release/lan-mouse lan-mouse-linux-x86_64
|
||||
run: cargo build --release
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-linux-x86_64
|
||||
path: lan-mouse-linux-x86_64
|
||||
|
||||
linux-arm64-release-build:
|
||||
runs-on: ubuntu-22.04-arm
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- name: install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install libx11-dev libxtst-dev
|
||||
sudo apt-get install libadwaita-1-dev libgtk-4-dev
|
||||
- name: Release Build
|
||||
run: |
|
||||
cargo build --release
|
||||
cp target/release/lan-mouse lan-mouse-linux-arm64
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v6
|
||||
with:
|
||||
name: lan-mouse-linux-arm64
|
||||
path: lan-mouse-linux-arm64
|
||||
name: lan-mouse-linux
|
||||
path: target/release/lan-mouse
|
||||
|
||||
windows-release-build:
|
||||
runs-on: windows-latest
|
||||
@@ -92,7 +64,7 @@ jobs:
|
||||
gvsbuild build --msys-dir=C:\msys64 gtk4 libadwaita librsvg
|
||||
Move-Item "C:\Program Files\Git\usr\notbin" "C:\Program Files\Git\usr\bin"
|
||||
Move-Item "C:\Program Files\Git\notbin" "C:\Program Files\Git\bin"
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- name: Release Build
|
||||
run: cargo build --release
|
||||
- name: Create Archive
|
||||
@@ -100,17 +72,17 @@ jobs:
|
||||
mkdir "lan-mouse-windows"
|
||||
Get-Childitem -Path "C:\\gtk-build\\gtk\\x64\\release\\bin\\*.dll" -File -Recurse | Copy-Item -Destination "lan-mouse-windows"
|
||||
Copy-Item -Path "target\release\lan-mouse.exe" -Destination "lan-mouse-windows"
|
||||
Compress-Archive -Path "lan-mouse-windows\*" -DestinationPath lan-mouse-windows-x86_64.zip
|
||||
Compress-Archive -Path "lan-mouse-windows\*" -DestinationPath lan-mouse-windows.zip
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-windows-x86_64
|
||||
path: lan-mouse-windows-x86_64.zip
|
||||
name: lan-mouse-windows
|
||||
path: lan-mouse-windows.zip
|
||||
|
||||
macos-release-build:
|
||||
runs-on: macos-15-intel
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- name: install dependencies
|
||||
run: |
|
||||
brew install --cask inkscape
|
||||
@@ -132,15 +104,15 @@ jobs:
|
||||
cd target/release/bundle/osx
|
||||
zip -r "lan-mouse-macos-intel.zip" "Lan Mouse.app"
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-macos-intel
|
||||
path: target/release/bundle/osx/lan-mouse-macos-intel.zip
|
||||
|
||||
macos-arm64-release-build:
|
||||
runs-on: macos-15
|
||||
macos-aarch64-release-build:
|
||||
runs-on: macos-14
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- name: install dependencies
|
||||
run: |
|
||||
brew install --cask inkscape
|
||||
@@ -148,7 +120,7 @@ jobs:
|
||||
- name: Release Build
|
||||
run: |
|
||||
cargo build --release
|
||||
cp target/release/lan-mouse lan-mouse-macos-arm64
|
||||
cp target/release/lan-mouse lan-mouse-macos-aarch64
|
||||
- name: Make icns
|
||||
run: scripts/makeicns.sh
|
||||
- name: Install cargo bundle
|
||||
@@ -160,45 +132,29 @@ jobs:
|
||||
- name: Zip bundle
|
||||
run: |
|
||||
cd target/release/bundle/osx
|
||||
zip -r "lan-mouse-macos-arm64.zip" "Lan Mouse.app"
|
||||
zip -r "lan-mouse-macos-aarch64.zip" "Lan Mouse.app"
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-macos-arm64
|
||||
path: target/release/bundle/osx/lan-mouse-macos-arm64.zip
|
||||
name: lan-mouse-macos-aarch64
|
||||
path: target/release/bundle/osx/lan-mouse-macos-aarch64.zip
|
||||
|
||||
release:
|
||||
name: "Release"
|
||||
needs: [windows-release-build, linux-release-build, linux-arm64-release-build, macos-release-build, macos-arm64-release-build]
|
||||
pre-release:
|
||||
name: "Pre Release"
|
||||
needs: [windows-release-build, linux-release-build, macos-release-build, macos-aarch64-release-build]
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- name: Download build artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
- name: Create Pre-Release
|
||||
if: ${{ !startsWith(github.ref, 'refs/tags/') }}
|
||||
uses: softprops/action-gh-release@v2
|
||||
- name: Create Release
|
||||
uses: "marvinpinto/action-automatic-releases@latest"
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
tag_name: ${{ github.event.inputs.name || github.ref_name }}
|
||||
name: ${{ github.event.inputs.name || github.ref_name }}
|
||||
repo_token: "${{ secrets.GITHUB_TOKEN }}"
|
||||
automatic_release_tag: "latest"
|
||||
prerelease: true
|
||||
generate_release_notes: true
|
||||
title: "Development Build"
|
||||
files: |
|
||||
lan-mouse-linux-x86_64/lan-mouse-linux-x86_64
|
||||
lan-mouse-linux-arm64/lan-mouse-linux-arm64
|
||||
lan-mouse-linux/lan-mouse
|
||||
lan-mouse-macos-intel/lan-mouse-macos-intel.zip
|
||||
lan-mouse-macos-arm64/lan-mouse-macos-arm64.zip
|
||||
lan-mouse-windows-x86_64/lan-mouse-windows-x86_64.zip
|
||||
- name: Create Tagged Release
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
name: ${{ github.ref_name }}
|
||||
generate_release_notes: true
|
||||
files: |
|
||||
lan-mouse-linux-x86_64/lan-mouse-linux-x86_64
|
||||
lan-mouse-linux-arm64/lan-mouse-linux-arm64
|
||||
lan-mouse-macos-intel/lan-mouse-macos-intel.zip
|
||||
lan-mouse-macos-arm64/lan-mouse-macos-arm64.zip
|
||||
lan-mouse-windows-x86_64/lan-mouse-windows-x86_64.zip
|
||||
lan-mouse-macos-aarch64/lan-mouse-macos-aarch64.zip
|
||||
lan-mouse-windows/lan-mouse-windows.zip
|
||||
8
.github/workflows/rust.yml
vendored
8
.github/workflows/rust.yml
vendored
@@ -9,16 +9,12 @@ on:
|
||||
env:
|
||||
CARGO_TERM_COLOR: always
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
fmt:
|
||||
name: Formatting
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- name: cargo fmt
|
||||
run: cargo fmt --check
|
||||
|
||||
@@ -39,7 +35,7 @@ jobs:
|
||||
- clippy
|
||||
- test
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
- name: Install Linux deps
|
||||
if: runner.os == 'Linux'
|
||||
|
||||
154
.github/workflows/tagged-release.yml
vendored
Normal file
154
.github/workflows/tagged-release.yml
vendored
Normal file
@@ -0,0 +1,154 @@
|
||||
name: "Tagged Release"
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- v**
|
||||
|
||||
jobs:
|
||||
linux-release-build:
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install libx11-dev libxtst-dev
|
||||
sudo apt-get install libadwaita-1-dev libgtk-4-dev
|
||||
- name: Release Build
|
||||
run: cargo build --release
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-linux
|
||||
path: target/release/lan-mouse
|
||||
|
||||
windows-release-build:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.11'
|
||||
# needed for cache restore
|
||||
- name: create gtk dir
|
||||
run: mkdir C:\gtk-build\gtk\x64\release
|
||||
- uses: actions/cache@v3
|
||||
id: cache
|
||||
with:
|
||||
path: c:/gtk-build/gtk/x64/release/**
|
||||
key: gtk-windows-build
|
||||
restore-keys: gtk-windows-build
|
||||
- name: Update path
|
||||
run: |
|
||||
echo "PKG_CONFIG=C:\gtk-build\gtk\x64\release\bin\pkgconf.exe" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
||||
echo "C:\pkg-config-lite-0.28-1\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
|
||||
echo "C:\gtk-build\gtk\x64\release\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
|
||||
echo $env:GITHUB_PATH
|
||||
echo $env:PATH
|
||||
- name: Install dependencies
|
||||
if: steps.cache.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
# choco install msys2
|
||||
# choco install visualstudio2022-workload-vctools
|
||||
# choco install pkgconfiglite
|
||||
py -m venv .venv
|
||||
.venv\Scripts\activate.ps1
|
||||
py -m pip install gvsbuild
|
||||
# see https://github.com/wingtk/gvsbuild/pull/1004
|
||||
Move-Item "C:\Program Files\Git\usr\bin" "C:\Program Files\Git\usr\notbin"
|
||||
Move-Item "C:\Program Files\Git\bin" "C:\Program Files\Git\notbin"
|
||||
gvsbuild build --msys-dir=C:\msys64 gtk4 libadwaita librsvg
|
||||
Move-Item "C:\Program Files\Git\usr\notbin" "C:\Program Files\Git\usr\bin"
|
||||
Move-Item "C:\Program Files\Git\notbin" "C:\Program Files\Git\bin"
|
||||
- uses: actions/checkout@v4
|
||||
- name: Release Build
|
||||
run: cargo build --release
|
||||
- name: Create Archive
|
||||
run: |
|
||||
mkdir "lan-mouse-windows"
|
||||
Get-Childitem -Path "C:\\gtk-build\\gtk\\x64\\release\\bin\\*.dll" -File -Recurse | Copy-Item -Destination "lan-mouse-windows"
|
||||
Copy-Item -Path "target\release\lan-mouse.exe" -Destination "lan-mouse-windows"
|
||||
Compress-Archive -Path "lan-mouse-windows\*" -DestinationPath lan-mouse-windows.zip
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-windows
|
||||
path: lan-mouse-windows.zip
|
||||
|
||||
macos-release-build:
|
||||
runs-on: macos-15-intel
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: install dependencies
|
||||
run: |
|
||||
brew install --cask inkscape
|
||||
brew install gtk4 libadwaita imagemagick librsvg
|
||||
- name: Release Build
|
||||
run: |
|
||||
cargo build --release
|
||||
cp target/release/lan-mouse lan-mouse-macos-intel
|
||||
- name: Make icns
|
||||
run: scripts/makeicns.sh
|
||||
- name: Install cargo bundle
|
||||
run: cargo install cargo-bundle
|
||||
- name: Bundle
|
||||
run: |
|
||||
cargo bundle --release
|
||||
scripts/copy-macos-dylib.sh "target/release/bundle/osx/Lan Mouse.app/Contents/MacOS/lan-mouse"
|
||||
- name: Zip bundle
|
||||
run: |
|
||||
cd target/release/bundle/osx
|
||||
zip -r "lan-mouse-macos-intel.zip" "Lan Mouse.app"
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-macos-intel.zip
|
||||
path: target/release/bundle/osx/lan-mouse-macos-intel.zip
|
||||
|
||||
macos-aarch64-release-build:
|
||||
runs-on: macos-14
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: install dependencies
|
||||
run: |
|
||||
brew install --cask inkscape
|
||||
brew install gtk4 libadwaita imagemagick librsvg
|
||||
- name: Release Build
|
||||
run: |
|
||||
cargo build --release
|
||||
cp target/release/lan-mouse lan-mouse-macos-aarch64
|
||||
- name: Make icns
|
||||
run: scripts/makeicns.sh
|
||||
- name: Install cargo bundle
|
||||
run: cargo install cargo-bundle
|
||||
- name: Bundle
|
||||
run: |
|
||||
cargo bundle --release
|
||||
scripts/copy-macos-dylib.sh "target/release/bundle/osx/Lan Mouse.app/Contents/MacOS/lan-mouse"
|
||||
- name: Zip bundle
|
||||
run: |
|
||||
cd target/release/bundle/osx
|
||||
zip -r "lan-mouse-macos-aarch64.zip" "Lan Mouse.app"
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: lan-mouse-macos-aarch64.zip
|
||||
path: target/release/bundle/osx/lan-mouse-macos-aarch64.zip
|
||||
|
||||
tagged-release:
|
||||
name: "Tagged Release"
|
||||
needs: [windows-release-build, linux-release-build, macos-release-build, macos-aarch64-release-build]
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- name: Download build artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
- name: Create Release
|
||||
uses: "marvinpinto/action-automatic-releases@latest"
|
||||
with:
|
||||
repo_token: "${{ secrets.GITHUB_TOKEN }}"
|
||||
prerelease: false
|
||||
files: |
|
||||
lan-mouse-linux/lan-mouse
|
||||
lan-mouse-macos-intel/lan-mouse-macos-intel.zip
|
||||
lan-mouse-macos-aarch64/lan-mouse-macos-aarch64.zip
|
||||
lan-mouse-windows/lan-mouse-windows.zip
|
||||
65
AGENTS.md
65
AGENTS.md
@@ -1,65 +0,0 @@
|
||||
# Lan Mouse Agent Instructions
|
||||
|
||||
## Overview
|
||||
|
||||
Lan Mouse is an open-source Software KVM sharing mouse/keyboard input across local networks. The Rust workspace combines a GTK frontend, CLI/daemon mode, and multi-OS capture/emulation backends for Linux, Windows, and macOS.
|
||||
|
||||
## Core principles
|
||||
|
||||
- **Scope discipline.** Only implement what was requested; describe follow-up work instead of absorbing it.
|
||||
- **Clarify OS behavior.** Ask when requirements touch OS-specific capture/emulation (they differ significantly).
|
||||
- **Docs stay current.** Update [README.md](README.md) or [DOC.md](DOC.md) when touching public APIs or platform support.
|
||||
- **Rust idioms.** Use `Result`/`Option`, `thiserror` for errors, descriptive logs, and concise comments for non-obvious invariants.
|
||||
|
||||
## Terminology
|
||||
|
||||
- **Client:** A remote machine that can receive or send input events. Each client is either _active_ (receiving events) or _inactive_ (can send events back). This mutual exclusion prevents feedback loops.
|
||||
- **Backend:** OS-specific implementation for capture or emulation (e.g., libei, layer-shell, wlroots, X11, Windows, macOS).
|
||||
- **Handle:** A per-client identifier used to route events and track state (pressed keys, position).
|
||||
|
||||
## Architecture
|
||||
|
||||
**Pipeline:** `input-capture` → `lan-mouse-ipc` → `input-emulation`
|
||||
|
||||
- **input-capture:** Reads OS events into a `Stream<CaptureEvent>`. Backends tried in priority order (libei → layer-shell → X11 → fallback). Tracks `pressed_keys` to avoid stuck modifiers. `position_map` queues events when multiple clients share a screen edge.
|
||||
- **input-emulation:** Replays events via the `Emulation` trait (`consume`, `create`, `destroy`, `terminate`). Maintains `pressed_keys` and releases them on disconnect.
|
||||
- **lan-mouse-ipc / lan-mouse-proto:** Protocol glue and serialization. Events are UDP; connection requests are TCP on the same port. Version bumps required when serialization changes.
|
||||
- **input-event:** Shared scancode enums and abstract event types—extend here, don't duplicate translations.
|
||||
|
||||
## Feature & cfg discipline
|
||||
|
||||
- Feature flags live in root `Cargo.toml`. Gate OS-specific modules with tight cfgs (e.g., `cfg(all(unix, feature = "layer_shell", not(target_os = "macos")))`).
|
||||
- Prefer module-level gating over per-function cfgs to avoid empty stubs.
|
||||
- New backends: add feature in `Cargo.toml`, create gated module, log backend selection.
|
||||
|
||||
## Async patterns
|
||||
|
||||
- Tokio runtime with `futures` streams and `async_trait`. Model new flows as streams or async methods.
|
||||
- Avoid blocking; use `spawn_blocking` if needed. Prefer existing single-threaded stream handling.
|
||||
- `InputCapture` implements `Stream` and manually pumps backends—don't short-circuit this logic.
|
||||
|
||||
## Commands
|
||||
|
||||
```sh
|
||||
cargo build --workspace # full build
|
||||
cargo build -p <crate> # single crate
|
||||
cargo test --workspace # all tests
|
||||
cargo fmt && cargo clippy --workspace --all-targets --all-features # lint
|
||||
RUST_LOG=lan_mouse=debug cargo run # debug logging
|
||||
```
|
||||
|
||||
Run from repo root—no `cd` in scripts.
|
||||
|
||||
## Testing
|
||||
|
||||
- Unit tests for utilities; integration tests for protocol behavior.
|
||||
- OS-specific backends: test via GTK/CLI on target OS or document manual verification.
|
||||
- Dummy backend exercises pipeline without real dependencies.
|
||||
- Verify `terminate()` releases keys on unexpected disconnect.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Clarify ambiguous requirements, especially OS-specific behavior.
|
||||
2. Implement minimal change; flag follow-up work.
|
||||
3. Add proportional tests; run `cargo test` on affected crates.
|
||||
4. Run `cargo fmt` and `cargo clippy --workspace --all-targets --all-features`.
|
||||
28
README.md
28
README.md
@@ -1,9 +1,4 @@
|
||||
# Lan Mouse
|
||||
|
||||
[](https://github.com/feschber/lan-mouse/actions/workflows/rust.yml) [](https://github.com/feschber/lan-mouse/actions/workflows/cachix.yml) [](https://github.com/feschber/lan-mouse/actions/workflows/release.yml)
|
||||
|
||||
[](https://crates.io/crates/lan-mouse) [](https://github.com/feschber/lan-mouse/blob/main/Cargo.toml)
|
||||
|
||||
Lan Mouse is a *cross-platform* mouse and keyboard sharing software similar to universal-control on Apple devices.
|
||||
It allows for using multiple PCs via a single set of mouse and keyboard.
|
||||
This is also known as a Software KVM switch.
|
||||
@@ -182,27 +177,8 @@ For a detailed list of available features, checkout the [Cargo.toml](./Cargo.tom
|
||||
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
### Git pre-commit hook
|
||||
|
||||
This repository includes a local git hooks directory `.githooks/` with a `pre-commit` script that enforces formatting, lints, and tests before allowing a commit. It is optional to enable it, but it will prevent you from committing code with failing unit tests or that needs clippy/fmt fixes. To enable the hook locally:
|
||||
|
||||
1. Make the hook executable:
|
||||
|
||||
```sh
|
||||
chmod +x .githooks/pre-commit
|
||||
```
|
||||
|
||||
2. Point git to the hooks directory (one-time per clone):
|
||||
|
||||
```sh
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
The `pre-commit` script runs `cargo fmt --all` (and fails if files were modified), `cargo clippy --workspace --all-targets --all-features -- -D warnings`, and `cargo test --workspace --all-features`.
|
||||
|
||||
### Dependencies & Compiling from Source
|
||||
## Installing Dependencies for Development / Compiling from Source
|
||||
<details>
|
||||
<summary>MacOS</summary>
|
||||
|
||||
@@ -475,4 +451,4 @@ The following sections detail the emulation and capture backends provided by lan
|
||||
- `libei`: This backend uses [libei](https://gitlab.freedesktop.org/libinput/libei) and is supported by GNOME >= 45 or KDE Plasma >= 6.1.
|
||||
- `windows`: Backend for input capture on Windows.
|
||||
- `macos`: Backend for input capture on MacOS.
|
||||
- `x11`: TODO (not yet supported)
|
||||
- `x11`: TODO (not yet supported)
|
||||
|
||||
Reference in New Issue
Block a user