feat(window): add configurable winblend for floats

[mtraworld]

Summary by CodeRabbit

• New Features
  • Introduced a new optional configuration setting to control the transparency of floating windows via the winblend option.
• Documentation
  • Updated documentation to describe the new winblend transparency setting and its usage in configuration examples and type definitions.

[coderabbitai]

Walkthrough

A new optional configuration field, winblend, has been introduced to the time-machine.nvim plugin. This field allows users to control the transparency of floating windows through the configuration. The change updates the documentation, type definitions, default configuration, and the floating window creation logic to support and document the new winblend option. No other functional or structural changes were made.

Changes

File(s)	Change Summary
README.md, doc/time-machine.nvim.txt	Updated documentation and type definitions to include the new optional winblend field.
lua/time-machine/config.lua	Added winblend = 0 to the default float_opts configuration.
lua/time-machine/types.lua	Extended TimeMachine.Config.FloatOpts type with optional winblend integer field.
lua/time-machine/window.lua	Set the floating window's winblend option based on the configuration or default to 0.

Poem

A window floats, now clear or dim,
With winblend set by whim.
The docs and types all know its name,
Transparency now joins the game.
Hop, hop, the code is neat—
A see-through feature, quite a treat!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

190-190: Enhance winblend type annotation.

The new ---@field winblend? integer The winblend of the window entry aligns the docs with the implementation. Consider expanding the description to specify the valid range (e.g., 0–100) or reference Neovim’s doc on winblend for clarity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 23d5bfb and d8cffdc.

📒 Files selected for processing (5)

• README.md (2 hunks)
• doc/time-machine.nvim.txt (2 hunks)
• lua/time-machine/config.lua (1 hunks)
• lua/time-machine/types.lua (1 hunks)
• lua/time-machine/window.lua (1 hunks)

🔇 Additional comments (6)

lua/time-machine/types.lua (1)

36-36: Well-defined type addition for window transparency.

The new optional winblend field is properly typed as an integer with a clear description, maintaining consistency with other field definitions in this type.

lua/time-machine/config.lua (1)

18-18: Good default value choice for winblend.

Setting the default value to 0 (completely opaque) is appropriate as it maintains backward compatibility with existing behavior while allowing users to opt into transparency if desired.

lua/time-machine/window.lua (1)

48-52: Implementation correctly applies the winblend configuration.

The code properly sets the window-local winblend option using the configured value or falls back to 0 if not specified. The placement after window creation is appropriate.

doc/time-machine.nvim.txt (2)

116-116: Documentation updated with the new winblend option.

The default options section correctly shows the new winblend configuration with its default value of 0.

---

195-195: Type definition documentation is consistent.

The type definition documentation properly includes the winblend field with matching type and description as in the code.

README.md (1)

112-112: Confirm default winblend value in float_opts.

The default config snippet correctly adds winblend = 0 under float_opts, matching the code changes. Please verify that a default of 0 is intended (fully opaque) and that users know how to adjust this for transparency.