https://github.com/shadowchiki/nvim-cpp-tools
Plugin for Nvim to give funcionalities witch is not included in Clangd like, Remove Unused includes, Generate a .cpp from .hpp
https://github.com/shadowchiki/nvim-cpp-tools
cpp nvim nvim-plugin
Last synced: about 2 months ago
JSON representation
Plugin for Nvim to give funcionalities witch is not included in Clangd like, Remove Unused includes, Generate a .cpp from .hpp
- Host: GitHub
- URL: https://github.com/shadowchiki/nvim-cpp-tools
- Owner: shadowchiki
- License: apache-2.0
- Created: 2025-02-16T12:45:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-06T18:32:23.000Z (3 months ago)
- Last Synced: 2026-04-06T20:25:14.912Z (3 months ago)
- Topics: cpp, nvim, nvim-plugin
- Language: Lua
- Homepage:
- Size: 75.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nvim-Cpp-Tools
Nvim-Cpp-Tools is a plugin to give more functionality than Clangd can do natively
With this Plugin you can auto generate .cpp imeplementation from a .hpp, hxx, h file
Remove unused includes.
This plugin is developed using [Treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
## Index
1. [Requirements](#requirements)
2. [Configure](#configure)
3. [Commands](#commands)
4. [Default keymaps](#default-keymaps)
5. [Examples](#examples)
6. [Known Bugs](#known-bugs)
## Requirements
These are the requirements of the functionalities that I would like the plugin to have
This is what i expect, if you have some suggestion contact me via mail.
### General Requirements
- [x] Must be able to remove unused includes.
### Auto generate implementations of header file
- [x] Must be able to allow to implement the inheritance methods that could have override the pure virtual parent methods.
- [x] Read attributes and set them to be automatically initialized in the constructor as if it had a parent.
- [ ] Template classes
- [x] Initialize the attributes of the class with the parameters of the constructor, the search must be by type, if there are several parameters of that type, make a comparison by name, if it does not contain the text, the first attribute found of the same type is put.
- [ ] Generate getters and setters
- [x] Select a method and generate it.
- [ ] Regenerate all Constructors, only the constructors
- [ ] Regenerate a single Constructor, only one constructor
- [ ] Ask you in which path you want to create the file.
- [ ] Must be able to create an implementation with any kind of extension of cpp, like .h, .hpp, .hxx. Right now just work with hpp
### Refactoring requirements
- [ ] Allows to select a method and generate a local variable or attribute from the return of the function.
- [ ] Allows to mark (v) a block of code and export it in a function intuiting what kind of return is needed.
- [ ] It must allow that if a method returns a variable, it allows to generate a variable of the return type with a default name.
- [ ] The plugin must be able to refactor a class, change any comment of the class and put the new name in all the classes that use it.
## Configure
### LazyVim
#### Default configuration
This is de default configuration, is no needed if your proyect have the .hpp and .cpp files in the same folder.
```lua
{
"shadowchiki/nvim-cpp-tools",
dependencies = {
"nvim-treesitter/nvim-treesitter",
},
config = function()
require("nvim-cpp-tools")
end,
}
```
#### Configuration with custom paths
You can configure where is generated the .cpp files. For example if your proyect is separated in the include folder that contains all .hpp and src folder that contains the .cpp files, you must set up the next configuration. Both paths are relatives from each other.
```lua
{
"shadowchiki/nvim-cpp-tools",
dependencies = {
"nvim-treesitter/nvim-treesitter",
},
config = function()
require("nvim-cpp-tools").setup({
generate_cpp_file_path = "../src",
origin_hpp_file_path = "../include",
})
end,
}
```
## Commands
| Name | Description | Command |
| ------------------------------ | ------------------------------------------------------------------------------ | ----------------------------- |
| Remove Unused Includes | Remove the unsued includes detected in a file | :RemoveUnusedIncludes |
| Generate Cpp Implementation | Creates a complete implementation of a header file to a implementation file | :GenerateCppImplementation |
| Generate Method Implementation | Creates a implementation of a method from header file to a implementation file | :GenerateMethodImplementation |
## Default keymaps
| Keymap | Command |
| ---------------- | ----------------------------- |
| <leader>co | :RemoveUnusedIncludes |
| <leader>ci | :GenerateCppImplementation |
| <leader>cI | :GenerateMethodImplementation |
## Examples
## Known bugs
- [x] When try to generate a method with override, the implementation get override mark too