Skip to content

feat(keybind-cheatsheet): update to v0.2.2 data service architecture and bug fixes - #369

Closed
cheerfulScumbag wants to merge 1 commit into
noctalia-dev:mainfrom
cheerfulScumbag:update-keybind-cheatsheet-0.2.2
Closed

feat(keybind-cheatsheet): update to v0.2.2 data service architecture and bug fixes#369
cheerfulScumbag wants to merge 1 commit into
noctalia-dev:mainfrom
cheerfulScumbag:update-keybind-cheatsheet-0.2.2

Conversation

@cheerfulScumbag

@cheerfulScumbag cheerfulScumbag commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Plugin

  • Id: kenn/keybind-cheatsheet
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

This update introduces a major architectural refactor to resolve host CPU callback timeouts and fixes reported community issues:

  1. Data Service Architecture (service.luau):

    • Offloads configuration parsing and cache ownership to a background service ([[service]] id = "data").
    • Panel opening (panel.luau) is now instant (0ms) and renders pre-parsed snapshots from memory without performing synchronous file I/O.
    • Eliminates polling timers, watchers, and panel-tick schedulers.
  2. Bug Fixes:

  3. Metadata & API:

    • Updated plugin_api = 9 for Noctalia v5 compatibility.

Note for @rylos: Once this v0.2.2 release is merged, PR #333 can rebase on top of this clean baseline to add your Niri 3x parsing speedup and 15s refresh timeout recovery!

External dependencies

  • hyprctl (used only for Hyprland Lua live bind queries)

Testing

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

Screenshots / Videos

No visual changes to the UI surface. Rendered keybinding layout remains identical to v0.2.1.

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

  • 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.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request was automatically closed because its description no longer contains
every part of the pull request template
that this repository requires.

Missing:

  • the template marker line <!-- noctalia-pr-template:v1 -->
  • the ## What it does heading
  • the ## External dependencies heading
  • the ## Testing heading
  • the ## Screenshots / Videos heading
  • the ## Checklist heading
  • the ## Code review attestation heading
  • the - **Id:** field
  • the - **Noctalia version tested against:** field
  • the - **Plugin API level:** field
  • the checklist entry: New plugin
  • the checklist entry: Update to an existing plugin (version bumped in plugin.toml)
  • the checklist entry: Tested on Niri
  • the checklist entry: Tested on Hyprland
  • the checklist entry: Tested on Sway
  • the checklist entry: Tested on another compositor:
  • the checklist entry: The directory name matches the part of id after the / in plugin.toml exactly.
  • the checklist entry: It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • the checklist entry: README.md follows the README template, documents every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • the checklist entry: I created thumbnail.webp with the thumbnail generator.
  • the checklist entry: version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • the checklist entry: 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).
  • the checklist entry: I did not edit catalog.toml; CI generates it.
  • the checklist entry: This PR touches exactly one plugin directory.
  • the checklist entry: The code is readable and not obfuscated, minified, or generated.
  • the checklist entry: It does not download and execute remote code.
  • the checklist entry: Every network call, filesystem write, and spawned process is something the description above accounts for.
  • the checklist entry: I have the right to publish this code under the license declared in plugin.toml.

Please add the items listed above back to the description, keeping their exact wording, then
reopen the pull request. Reopening re-runs this check. Only the marker line, the ## headings,
the - **Field:** lines, and the - [ ] checklist entries are required; the guidance comments
in the template are yours to delete, and checklist boxes may stay unchecked while the pull
request is a draft.

@github-actions github-actions Bot closed this Aug 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This pull request was automatically closed because its description no longer contains
every part of the pull request template
that this repository requires.

Missing:

  • the checklist entry: The directory name matches the part of id after the / in plugin.toml exactly.
  • the checklist entry: It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • the checklist entry: README.md follows the README template, documents every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • the checklist entry: I created thumbnail.webp with the thumbnail generator.
  • the checklist entry: version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • the checklist entry: I did not edit catalog.toml; CI generates it.
  • the checklist entry: I have the right to publish this code under the license declared in plugin.toml.

Please add the items listed above back to the description, keeping their exact wording, then
reopen the pull request. Reopening re-runs this check. Only the marker line, the ## headings,
the - **Field:** lines, and the - [ ] checklist entries are required; the guidance comments
in the template are yours to delete, and checklist boxes may stay unchecked while the pull
request is a draft.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request was automatically closed because its description no longer contains
every part of the pull request template
that this repository requires.

Missing:

  • the checklist entry: I have the right to publish this code under the license declared in plugin.toml.

Please add the items listed above back to the description, keeping their exact wording, then
reopen the pull request. Reopening re-runs this check. Only the marker line, the ## headings,
the - **Field:** lines, and the - [ ] checklist entries are required; the guidance comments
in the template are yours to delete, and checklist boxes may stay unchecked while the pull
request is a draft.

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.

[keybind-cheatsheet][BUG] Panel blank on Niri [keybind-cheatsheet][BUG] Keybinding category is ignored for binds with a multiline description

1 participant