Skip to content

Add nilsonlinux/rss-notifier plugin v1.0.0 - #137

Draft
nilsonlinux wants to merge 12 commits into
noctalia-dev:mainfrom
nilsonlinux:main
Draft

Add nilsonlinux/rss-notifier plugin v1.0.0#137
nilsonlinux wants to merge 12 commits into
noctalia-dev:mainfrom
nilsonlinux:main

Conversation

@nilsonlinux

Copy link
Copy Markdown

Plugin

  • Id: nilsonlinux/rss-notifier
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

RSS/Atom Notifier monitors RSS/Atom feeds in the background and notifies the user when new items are published.

Features:

  • Widget on the bar showing unread count badge
  • Panel with a scrollable list of feed items
  • Native Noctalia notifications for new items
  • Configurable refresh interval (1-1440 minutes)
  • Customizable notification limit per cycle

External dependencies

None - The plugin is fully self-contained. It uses only Noctalia V5 native APIs for HTTP requests, XML/RSS parsing, system notifications, and state persistence.

Testing

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor:
  • Noctalia version tested against: v5.0.0
  • Plugin API level: 14

Test scenarios:

  1. Added multiple feed URLs (BBC, TechCrunch, personal blogs)
  2. Tested refresh intervals: 1, 5, 15, 30, 60 minutes
  3. Validated RSS 2.0 and Atom feed parsing
  4. Confirmed no duplicate notifications for already read items
  5. Widget badge updates correctly on new items
  6. Panel opens/closes with click and ESC key
  7. Settings: add/remove URLs, toggle notifications, adjust limits

Screenshots / Videos

Widget with badge:
Widget screenshot

Replace placeholder links with actual screenshots

Checklist

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the
    README template, documents
    every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • I created thumbnail.webp with the thumbnail generator.
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and
    understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

Plugins run as trusted, unsandboxed Luau in the user's session. Confirm:

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

Updated README to reflect plugin name and improved clarity.
Removed placeholder text and installation instructions from README.
Expanded README to include plugin details, usage instructions, and settings configuration.
Atualiza o README.md com informações em português sobre o plugin RSS/Atom Notifier, incluindo uso, configurações e notas sobre o funcionamento.
Removed 'rss' tag from the plugin configuration.
Updated the README to reflect changes in the plugin description, installation instructions, usage details, settings, and dependencies.
Updated README.md to include detailed plugin features, settings, and usage instructions.
@ItsLemmy

Copy link
Copy Markdown
Contributor
  1. blocking - rss-notifier/plugin.toml:10

The manifest declares no external dependencies, but rss-notifier/panel.luau:13 invokes xdg-open through noctalia.runAsync. The PR description also claims the plugin is self-contained. On systems without xdg-open, opening feed items fails.

Declare xdg-open in dependencies and document it under README requirements.

  1. blocking - rss-notifier/README.md:41

The settings table documents feeds, refresh_interval, notify_new_items, and max_items_per_feed. None are manifest setting keys. The actual keys are feed_urls, refresh_minutes, notify_new, and max_notifications_per_cycle at rss-notifier/plugin.toml:12-43. The README also names the plugin "RSS Utils" while the manifest and thumbnail use "RSS/Atom Notifier".

Update the README to use the exact manifest name, setting keys, defaults, and behavior.

  1. blocking - rss-notifier/translations/pt.json:2

The filename uses pt, while Noctalia's supported Portuguese locale code is pt-BR. Its dotted object keys also violate the repository's translation segment convention, unlike the nested structure in rss-notifier/translations/en.json:2.

Rename the locale to pt-BR.json and represent the translation keys as nested objects.

@ItsLemmy
ItsLemmy marked this pull request as draft July 29, 2026 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants