Configuring Code Reviews

IMPORTANT

Code reviews are still in beta. As such, the workflow below is subject to change.

Find out how code reviews work in the usage guide.

Disabling

To disable code reviews, set enabled to false:

require("codecompanion").setup({
  interactions = {
    code_review = {
      enabled = false,
    },
  },
})

Comment Styling

Pending comments are shown as virtual text above the line they were left on:

require("codecompanion").setup({
  interactions = {
    code_review = {
      display = {
        comments = {
          enabled = true, -- Show pending comments as virtual text in the buffer
          icon = "💬 ", -- The icon to use for a comment
          overflow = "trunc", -- See `:h nvim_buf_set_extmark` for `virt_lines_overflow`
        },
      },
    },
  },
})

Editor Context

The code_review editor context is replaced with a short phrase before your message is sent. For example:

Can you action #{code_review}

Is replaced with:

Can you action my comments from the code review, which I've attached

This can be changed with:

require("codecompanion").setup({
  interactions = {
    shared = {
      editor_context = {
        code_review = {
          opts = {
            replacement = "my comments from the code review, which I've attached",
          },
        },
      },
    },
  },
})

Keymaps

Keymaps are bound solely to the review window's two panels. The default keymaps are:

require("codecompanion").setup({
  interactions = {
    code_review = {
      keymaps = {
        accept = {
          modes = { n = "ga" },
          callback = "accept",
          description = "Accept the hunk, or whole file, under the cursor",
        },
        revert = {
          modes = { n = "gr" },
          callback = "revert",
          description = "Revert the hunk under the cursor",
        },
        comment = {
          modes = { n = "gc" },
          callback = "comment",
          description = "Comment on the line under the cursor",
        },
        comments = {
          modes = { n = "gC" },
          callback = "comments",
          description = "Edit the pending comments by hand",
        },
        share = {
          modes = { n = "gs" },
          callback = "share",
          description = "Share comments for an agent outside of CodeCompanion",
        },
        undo = {
          modes = { n = "u" },
          callback = "undo",
          description = "Undo the last accept or revert",
        },
        edit = {
          modes = { n = { "i", "I" } },
          callback = "edit",
          description = "Edit the line in the file itself",
        },
        keymaps = {
          modes = { n = "?" },
          callback = "keymaps",
          description = "Show these keymaps",
          visible = false,
        },
        next_hunk = {
          modes = { n = "]h" },
          callback = "next_hunk",
          description = "Move to the next row",
        },
        previous_hunk = {
          modes = { n = "[h" },
          callback = "previous_hunk",
          description = "Move to the previous row",
        },
      },
    },
  },
})

Pressing ? in either panel lists the keymaps. Set visible = false to keep one out of that list.

To disable a keymap:

require("codecompanion").setup({
  interactions = {
    code_review = {
      keymaps = {
        -- Disable the share keymap
        share = false,
      },
    },
  },
})

Auto-Accepting Files

Lockfiles, generated code and compiled docs rarely need reading. Files matching these globs are left out of the review window, as if you had accepted them:

require("codecompanion").setup({
  interactions = {
    code_review = {
      opts = {
        auto_accept = { "**/*.lock", "**/package-lock.json", "doc/**/*.txt" },
      },
    },
  },
})

Paths are relative to the repository root. Globs follow :h vim.glob, so * stays within one directory and **/ matches any depth.

Storage Location

To change where reviews are stored:

require("codecompanion").setup({
  interactions = {
    code_review = {
      opts = {
        storage_dir = vim.fs.joinpath(vim.fn.stdpath("data"), "codecompanion", "code_review"),
      },
    },
  },
})