Skip to content

0.1.0

Choose a tag to compare

View all tags
@William9923 William9923 released this 19 Jun 08:16
0.1.0
3a0d1de

Added

  • Folder lock/unlock UI — lock or unlock the current folder via KOReader's main menu, with password confirmation before setting a new lock
  • Password prompt on navigation — a patch on FileChooser.changeToPath intercepts folder entries and shows a password dialog when the target folder (or any ancestor) is locked
  • Ancestor cascade — locking a parent folder automatically protects all subfolders; child folders are not individually locked but inherit protection
  • djb2 password hashing — passwords are stored as djb2 hashes in an on-device registry file (folderlock_registry.lua); plaintext passwords are never persisted
  • Fail-safe design — no file encryption or modification; removing the plugin or deleting the registry restores full access with zero risk of data loss

Documentation

  • Project overview, philosophy and scope, installation guide, usage walkthrough with screenshots
  • Upcoming features documented: automatic updater, file-based lock, cover cache isolation

CI & Testing

  • Unit tests — Lua unit tests for core logic (hashing, path normalization, ancestor traversal, registry operations)
  • End-to-end tests — KOReader simulator-based tests that exercise the full plugin lifecycle: loading, menu interaction, folder locking/unlocking, and password verification
  • GitHub Actions workflows — test workflow (unit + e2e) on push/PR, and a release workflow that runs tests, packages the plugin, and publishes a GitHub Release on version tags
  • Test runner scripts — run_unit.sh and run_e2e.sh for local development

Build & Packaging

  • make package-release VERSION=... produces a compressed .zip archive (dist/folderlock.koplugin-<version>.zip) using 9x compression
  • make run-koreader symlinks the plugin into a local koreader checkout for rapid iteration

Infrastructure

  • Continuous integration against KOReader v2026.03 via git submodule
  • Dependencies installed for SDL3-based simulator builds (libdbus, libdecor, libibus, Wayland, X11, etc.)

Fixed

  • Use absolute path for LD_LIBRARY_PATH in CI for try_run reliability
  • Revert submodule pointer back to official koreader repo
  • Remove stray comments in docs

Full Changelog: https://github.com/William9923/folderlock.koplugin/commits/0.1.0

Assets 3
Loading