augment completion

[NobbZ]

Summary by CodeRabbit

• New Features
  • Introduced new keyboard shortcuts in insert and select modes for accepting text completions. Users now have options for both default and newline-based acceptance.
  • Updated key mapping configurations to ensure a smoother editing experience with reduced conflicts.
  • Added a new function to enhance the completion acceptance process.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a new local function accept_completion in the Lua augment plugin. This function accepts an optional fallback parameter and returns a function that calls vim.fn["augment#Accept"] accordingly. Additionally, the before function in the specifications now disables tab mappings by setting vim.g.augment_disable_tab_mapping to true and assigns the event "DeferredUIEnter". Two key mappings (<C-y> and <C-cr>) are registered in insert and select modes to invoke the new function with different fallback values.

Changes

File Path	Change Summary
plugins/nobbz/lua/nobbz/augment.lua	Added new local function accept_completion with an optional fallback; updated the before hook to disable tab mappings and add the event "DeferredUIEnter"; introduced key mappings <C-y> and <C-cr> in insert and select modes invoking the new function.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant WK as Key Mapping (WK.add)
    participant AC as accept_completion()
    participant AA as augment#Accept

    U->>WK: Press <C-y> or <C-cr>
    WK->>AC: Invoke accept_completion (with optional fallback)
    AC->>AA: Call vim.fn["augment#Accept"](fallback?)
    AA-->>AC: Return result
    AC-->>WK: Complete key mapping execution

Loading

Poem

I'm a rabbit in this code-filled glen,
Hopping fast and tweaking now and then.
New functions bloom with a cheerful tone,
Key mappings guide me when I'm alone.
I dance in Lua, swift and free—oh joy, oh joy, hop with me! 🐇✨

---

📜 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 bd18b5d and 99214a8.

📒 Files selected for processing (1)

• plugins/nobbz/lua/nobbz/augment.lua (3 hunks)

🔇 Additional comments (4)

plugins/nobbz/lua/nobbz/augment.lua (4)

4-16: Well-structured function with clear documentation.

The new accept_completion function is well-designed with thorough LuaDoc comments that explain its purpose, parameters, and return value. The implementation is clean and properly handles the optional fallback parameter, returning appropriate closures based on the input.

---

27-27: Good addition to disable default tab mapping.

Setting vim.g.augment_disable_tab_mapping to true makes sense since you're implementing custom key mappings for accepting completions. This prevents potential conflicts with the default tab behavior.

---

30-30: Appropriate event choice for plugin loading.

Using the "DeferredUIEnter" event for lazy-loading is a good choice. This ensures the plugin is initialized after the UI is ready but doesn't delay startup time.

---

39-40: Well-implemented key mappings with clear descriptions.

The new key mappings for <C-y> and <C-cr> make good use of the accept_completion function. The descriptions clearly explain their purpose, and the mode specification ensures they work correctly in both insert and select modes.

✨ 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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]

Note

Generated docstrings for this pull request at #38