Compare commits

..
16 Commits
Author SHA1 Message Date
GitHub Actions c1c27d6cc0 chore: bump version to 4.11.193 [skip ci] 2026-10-31 16:50:16 +00:00
GitHub Actions 634f8ed2f8 Bump cinny: Page the open issue list so dedupe sees every check issue.
Build / increment-version (push) Successful in 5s
Build / build-android (push) Successful in 2m37s
2026-10-31 16:40:52 +00:00
GitHub Actions 8a08073b96 chore: bump version to 4.11.192 [skip ci] 2026-10-31 16:33:22 +00:00
GitHub Actions 602a99efaf Bump cinny: Port the ESLint config to flat format and file check findings as Gitea issues.
Build / increment-version (push) Successful in 4s
Build / build-android (push) Successful in 2m57s
2026-10-31 16:25:42 +00:00
GitHub Actions e00a5da74b chore: bump version to 4.11.191 [skip ci] 2026-10-31 15:03:56 +00:00
GitHub Actions 3af27ddaf2 Bump cinny: Add a developer tools view for public profile fields.
Build / increment-version (push) Successful in 5s
Build / build-android (push) Successful in 2m58s
2026-10-31 15:03:48 +00:00
GitHub Actions 000d6158ae chore: bump version to 4.11.190 [skip ci] 2026-10-31 12:55:45 +00:00
GitHub Actions bb1586001a Bump cinny: Revert reporting the activity bar against the message in the viewport.
Build / increment-version (push) Successful in 4s
Build / build-android (push) Successful in 5m20s
2026-10-31 12:55:38 +00:00
GitHub Actions 56463d5147 chore: bump version to 4.11.189 [skip ci] 2026-10-15 12:13:19 +00:00
GitHub Actions 1ebaa165bd Bump cinny: Fetch the TikTok oEmbed through the main process in Electron and drop the thumbnail crossOrigin.
Build / increment-version (push) Successful in 5s
Build / build-android (push) Successful in 2m33s
2026-10-15 12:13:11 +00:00
GitHub Actions 55899d9cab chore: bump version to 4.11.188 [skip ci] 2026-10-13 09:11:50 +00:00
litruv 0d2e6c73a7 docs: add plugin development instructions (AGENTS.md)
Build / increment-version (push) Successful in 5s
Build / build-android (push) Successful in 2m30s
2026-10-13 20:11:43 +11:00
GitHub Actions 3067b88ecc chore: bump version to 4.11.187 [skip ci] 2026-10-13 08:44:39 +00:00
GitHub Actions c6e9c82ae5 Bump cinny: Remove the Paarrot delivery receipt.
Build / increment-version (push) Successful in 4s
Build / build-android (push) Successful in 2m29s
2026-10-13 08:44:33 +00:00
GitHub Actions 3787b55ca5 chore: bump version to 4.11.186 [skip ci] 2026-10-13 05:54:05 +00:00
litruv 1f16f5dd44 fix: provide ctx.lucide to plugins; resolve submodule gitdir in apply-overlay
Build / increment-version (push) Successful in 4s
Build / build-android (push) Successful in 2m29s
2026-10-13 16:53:56 +11:00
5 changed files with 54 additions and 3 deletions
+48
View File
@@ -0,0 +1,48 @@
# Plugin development instructions
Instructions for opencode agents working on the Paarrot plugin system in this repo.
## Architecture
- Plugin host: `overlay/src/app/utils/pluginHost.ts`. Electron uses `window.electron.plugins`, Android uses the Capacitor `PluginStorage` plugin, web returns null.
- Native Android host: `android/app/src/main/java/com/paarrot/app/PluginStoragePlugin.kt` (download zip, unzip with zip-slip guard, list, uninstall, readPluginCode). Registered in `MainActivity.java`.
- Loader: `cinny/src/app/features/settings/plugins/PluginLoader.tsx`, mounted in `ClientRoot.tsx`. It evaluates `index.js` with `new Function` for CommonJS and falls back to a data-URL import for ESM.
- Registry and marketplace: `PluginAPI.ts` persists both to `localStorage`. Enabled state survives restarts. Plugins load at app start, so enabling a plugin requires an app restart.
## Plugin context contract
- `createPluginContext` from `@paarrot/plugin-manager` provides: `commands`, `messages`, `ui`, `settings`, `themes`, `events`, `timers`, `log`, `warn`, `error`.
- `PluginLoader` adds compat fields on top: `matrixClient`, `matrix`, `React`, `lucide`. Plugins destructure these directly (for example `const { Link } = ctx.lucide`), so a missing field throws at `onLoad` and the plugin never runs. Keep the compat fields in sync between `cinny` and `overlay`. A missing `lucide` caused silent plugin failure on mobile, fixed in commit `1f16f5d`.
## UI locations
- Valid `UILocation` values: `room-header`, `message-actions`, `user-menu`, `room-menu`, `composer-actions`, `channel-list`, `direct-messages`, `home-section`, `search-notification-section`, `text-composer-toolbar`, `sidebar-actions`.
- Button slots render at all screen sizes. Nav-only locations (`channel-list`, `direct-messages`, `home-section`, `sidebar-actions`) have no surface in the single-column mobile UI, so plugins that only register there are invisible on phones.
## Mobile quirks
- Capacitor injects plugins on `Capacitor.Plugins` after the bridge is ready, and `registerPlugin` is often missing on Android. The `waitForBridge` fallback pattern in `overlay/src/app/utils/backgroundSync.ts` is the reference.
- No CSP is configured in `capacitor.config.json`, so `new Function` and data-URL imports work. Adding CSP would break plugin evaluation.
- WebView console logs reach logcat under the tag `Capacitor/Console`.
## Debugging on device
- Wireless adb: `adb connect <ip>:<port>`. The `adb tcpip` port persists until reboot, then resets to 5555. Android 11+ wireless debugging randomizes the port per reboot by design. Pinning needs root (`persist.adb.tcp.port`).
- Plugin files: `adb shell run-as com.paarrot.app cat files/plugins/<id>/index.js` works on debuggable builds.
- Enabled state: localStorage lives in `app_webview/Local Storage/leveldb`. Search for `plugin-manager:installed-plugins`.
- Live eval: the WebView devtools socket is `@webview_devtools_remote_<pid>`. Forward with `adb forward tcp:9222 localsocket:webview_devtools_remote_<pid>`. The socket may refuse HTTP and WebSocket requests from non-localhost hosts.
- To trigger plugin load logs: force-stop, start, then `logcat -d | grep PluginLoader`.
- Hotpatching the installed copy with `run-as` plus an app restart tests plugin changes without reinstalling.
## Marketplace
- Directory: `Paarrot/Plugin-Directory`. Entries are static JSON files. The `version` field is a manual snapshot and is never synced from the plugin repo.
- Updates go through PRs. `validate-pr.yml` validates and auto-merges. `update-index.yml` regenerates `index.json` from committed entries only.
- A plugin repo needs `index.js` and `plugin-metadata.json`. The directory `downloadUrl` is the GitHub archive zip.
- Bump the version in both the plugin repo metadata and the directory entry when shipping changes.
## Repo conventions
- Edit `overlay/` files, not `cinny` directly. `scripts/apply-overlay.mjs` layers the overlay onto the cinny submodule before every Android build.
- `android/gradlew` is not executable. Run it as `sh gradlew`.
- Use `scripts/push.sh` for commits. It skips the cinny submodule pointer and `gradlew`.
+1 -1
Submodule cinny updated: f0495cccca...7689433376
@@ -1,5 +1,6 @@
import React, { useEffect } from 'react'; import React, { useEffect } from 'react';
import { MatrixClient } from 'matrix-js-sdk'; import { MatrixClient } from 'matrix-js-sdk';
import * as lucide from 'lucide-react';
import { Plugin, createPluginContext } from '@paarrot/plugin-manager'; import { Plugin, createPluginContext } from '@paarrot/plugin-manager';
import { pluginMarketplaceManager, pluginRegistry } from './PluginAPI'; import { pluginMarketplaceManager, pluginRegistry } from './PluginAPI';
import { sendNotification } from '../../../utils/tauri'; import { sendNotification } from '../../../utils/tauri';
@@ -80,6 +81,7 @@ export function PluginLoader({ matrixClient, children }: PluginLoaderProps) {
matrixClient.off(eventType as any, handler as any), matrixClient.off(eventType as any, handler as any),
}, },
React, React,
lucide,
}); });
console.log('[PluginLoader] compatContext.React:', !!compatContext.React); console.log('[PluginLoader] compatContext.React:', !!compatContext.React);
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "paarrot", "name": "paarrot",
"version": "4.11.185", "version": "4.11.193",
"description": "Paarrot - A Matrix client based on Cinny", "description": "Paarrot - A Matrix client based on Cinny",
"engines": { "engines": {
"node": ">=18.0.0" "node": ">=18.0.0"
+2 -1
View File
@@ -33,7 +33,8 @@ if (cinnyStatus.trim()) {
// Ensure android/ junction is excluded from the cinny git view — otherwise // Ensure android/ junction is excluded from the cinny git view — otherwise
// `git stash -u` would traverse the junction into the root android/ directory // `git stash -u` would traverse the junction into the root android/ directory
// and delete files there when the stash is created. // and delete files there when the stash is created.
const cinnyExclude = join(CINNY, '.git', 'info', 'exclude'); const gitDir = resolve(CINNY, execSync('git rev-parse --git-dir', { cwd: CINNY, encoding: 'utf8' }).trim());
const cinnyExclude = join(gitDir, 'info', 'exclude');
const excludeContent = existsSync(cinnyExclude) ? readFileSync(cinnyExclude, 'utf8') : ''; const excludeContent = existsSync(cinnyExclude) ? readFileSync(cinnyExclude, 'utf8') : '';
if (!excludeContent.includes('android/')) { if (!excludeContent.includes('android/')) {
writeFileSync(cinnyExclude, excludeContent + (excludeContent.endsWith('\n') || !excludeContent ? '' : '\n') + 'android/\n', 'utf8'); writeFileSync(cinnyExclude, excludeContent + (excludeContent.endsWith('\n') || !excludeContent ? '' : '\n') + 'android/\n', 'utf8');