Skip to content

docs: document missing config options and fix manager_path bug#343

Open
staging-devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1775167924-doc-missing-config-options
Open

docs: document missing config options and fix manager_path bug#343
staging-devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1775167924-doc-missing-config-options

Conversation

@staging-devin-ai-integration
Copy link
Copy Markdown

Summary

Two changes:

  1. README: Added documentation for 7 config options defined in lua/codeium/config.lua that were missing from the README: manager_path, language_server_download_url, quiet, enable_local_search, enable_index_service, search_max_workspace_file_count, and file_watch_max_dir_count.

  2. Bug fix (lua/codeium/api.lua): config.manager_pathconfig.options.manager_path. The old code accessed a non-existent field on the config module, so user-provided manager_path was silently ignored and the server always used a temp directory.

Review & Testing Checklist for Human

  • Verify the manager_path bug fix doesn't break existing behavior: Before this fix, manager_path always resolved to nil (temp dir fallback). After this fix, if a user had manager_path set in their config, it would actually be used. Confirm no downstream code assumes the manager dir is always a temp directory.
  • Spot-check documentation accuracy: Verify that the defaults and descriptions for the 7 newly documented options match lua/codeium/config.lua defaults and the consuming code in api.lua / update.lua.
  • Manual test: Set manager_path to a custom directory in your Neovim config, restart, and confirm the language server uses that directory instead of a temp one.

Notes

  • All previously documented options were verified as consumed in the codebase — no stale docs.
  • No lint tooling or test suite exists in this repo, so validation is manual only.

Link to Devin session: https://localhost:3000/sessions/7c4051b3ecdf4ac3a8b3516012aae980
Requested by: @IdoPesok

Add documentation for the following config options that were missing from
the README:
- quiet: suppress completion error notifications
- enable_local_search: enable local search in language server
- enable_index_service: enable index service for workspace search
- search_max_workspace_file_count: max files for search indexing
- file_watch_max_dir_count: max directories for file watching
- manager_path: custom language server manager directory
- language_server_download_url: base URL for LS binary download

Fix bug in api.lua where config.manager_path was used instead of
config.options.manager_path, causing user-provided manager_path to be
silently ignored.

Co-Authored-By: Staging-Devin AI <166158716+staging-devin-ai-integration[bot]@users.noreply.github.com>
@staging-devin-ai-integration
Copy link
Copy Markdown
Author

Original prompt from Ido

Recent commits added several new options to lua/codeium/config.lua: quiet (suppress completion errors), enable_cmp_source, and the full virtual_text subtable with keys like enabled, filetypes, manual, idle_delay, key_bindings, etc. Cross-check each of these options against the README.md to confirm every option is documented with its type, default, and purpose — add any that are missing, and verify each option is actually read and respected in the consuming code.

@staging-devin-ai-integration
Copy link
Copy Markdown
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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.

1 participant