fix(utils): allow optional bufnr and winid to close it

[mtraworld]

Summary by CodeRabbit

• Bug Fixes
  • Improved stability when closing buffers or windows by ensuring the operations are skipped if no target is specified, preventing potential errors.

[coderabbitai]

Walkthrough

The changes update the parameter annotations for the close_buf and close_win functions in the Lua utility module, marking their arguments as optional rather than required. The internal logic of these functions is also modified to check for the presence of the arguments before performing further validation, ensuring that operations are not attempted on nil values and preventing possible runtime errors.

Changes

File(s)	Change Summary
lua/time-machine/utils.lua	Updated parameter annotations for close_buf and close_win to make arguments optional; added guard clauses to check for argument presence before proceeding with buffer or window operations.

Poem

A tweak for buffers, a wink for wins,
Optional now, where strictness thins.
No more errors when nil comes to play,
Guard clauses hop in and save the day.
With Lua’s logic freshly spun,
Our code hops safer—job well done! 🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bfe61c7 and ba0d6a2.

📒 Files selected for processing (1)

• lua/time-machine/utils.lua (1 hunks)

🔇 Additional comments (4)

lua/time-machine/utils.lua (4)

118-118: Annotation change looks good.

Marking bufnr as optional with the ? symbol properly documents the new behavior of the function, which now accepts nil values.

---

121-121: Good defensive programming.

Adding the bufnr existence check before validating the buffer prevents potential errors when nil is passed. This change implements the "optional bufnr" feature correctly.

---

127-127: Annotation change looks good.

Marking win as optional with the ? symbol properly documents the new behavior of the function, which now accepts nil values.

---

130-130: Good defensive programming.

Adding the win existence check before validating the window prevents potential errors when nil is passed. This change implements the "optional winid" feature correctly.

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