platformio / platformio/platformio-docs
vim: Maybe suggest using compile_commands.json instead of platformio init?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 285
- Forks
- 357
- PR merge metrics
- No merged PRs in 30d
Description
The vim documentation
https://github.com/platformio/platformio-docs/blob/develop/integration/ide/vim.rst
suggests generating a .ccls file via pio init. For me, this wasn't working, as I was getting "declaration not found" (using e.g. :LspPeekDeclaration) only. What did help for me was running pio run -t compiledb.
I'm not sure why, running ccls --index=. with the pio-ide-vim approach suggests only my own files are indexed, not the library ones.
With the compiledb approach (and deleting .ccls), libraries are indexed as well.
Should the documentation be updated?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with integration/ide/vim.rst and compare its pio init/.ccls instructions with the reported pio run -t compiledb workflow. Check whether the documentation should describe compile_commands.json for library indexing, then verify the revised guidance with the cited ccls and Vim LSP commands.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vim
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100