Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Freed-Wu/code-stats.nvim
Code::Stats plugin for Neovim
https://github.com/Freed-Wu/code-stats.nvim
code-stats lua neovim vim
Last synced: 29 days ago
JSON representation
Code::Stats plugin for Neovim
- Host: GitHub
- URL: https://github.com/Freed-Wu/code-stats.nvim
- Owner: Freed-Wu
- License: gpl-3.0
- Created: 2024-07-30T08:30:05.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T20:15:04.000Z (about 1 month ago)
- Last Synced: 2024-11-18T21:26:34.892Z (about 1 month ago)
- Topics: code-stats, lua, neovim, vim
- Language: Lua
- Homepage: https://luarocks.org/modules/Freed-Wu/code-stats.nvim
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-neovim-pluginlist - Freed-Wu/code-stats.nvim - Wu/code-stats.nvim)   (New features / RSS)
README
# code-stats.nvim
[](https://results.pre-commit.ci/latest/github/Freed-Wu/code-stats.nvim/main)
[](https://github.com/Freed-Wu/code-stats.nvim/actions)
[](https://github.com/Freed-Wu/code-stats.nvim/releases)
[](https://github.com/Freed-Wu/code-stats.nvim/releases/latest)
[](https://github.com/Freed-Wu/code-stats.nvim/issues)
[](https://github.com/Freed-Wu/code-stats.nvim/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/Freed-Wu/code-stats.nvim/pulls)
[](https://github.com/Freed-Wu/code-stats.nvim/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/Freed-Wu/code-stats.nvim/discussions)
[](https://github.com/Freed-Wu/code-stats.nvim/milestones)
[](https://github.com/Freed-Wu/code-stats.nvim/network/members)
[](https://github.com/Freed-Wu/code-stats.nvim/stargazers)
[](https://github.com/Freed-Wu/code-stats.nvim/watchers)
[](https://github.com/Freed-Wu/code-stats.nvim/graphs/contributors)
[](https://github.com/Freed-Wu/code-stats.nvim/graphs/commit-activity)
[](https://github.com/Freed-Wu/code-stats.nvim/commits)
[](https://github.com/Freed-Wu/code-stats.nvim/releases/latest)
[](https://github.com/Freed-Wu/code-stats.nvim/blob/main/LICENSE)
[](https://github.com/Freed-Wu/code-stats.nvim)
[](https://github.com/Freed-Wu/code-stats.nvim)
[](https://github.com/Freed-Wu/code-stats.nvim)
[](https://github.com/Freed-Wu/code-stats.nvim)
[](https://github.com/Freed-Wu/code-stats.nvim)
[](https://github.com/Freed-Wu/code-stats.nvim)
[](https://luarocks.org/modules/Freed-Wu/code-stats.nvim)
[Code::Stats](https://codestats.net) plugin for Neovim.
## Install
**NOTE**: upstream xml has been [broken](https://github.com/lubyk/xml/pull/20).
use the [fork](assets/rockspecs/xml-1.1.3-1.rockspec) before installing.
### rocks.nvim
#### Command style
```vim
:Rocks install code-stats.nvim
```
#### Declare style
`~/.config/nvim/rocks.toml`:
```toml
[plugins]
"code-stats.nvim" = "scm"
```
Then
```vim
:Rocks sync
```
or:
```sh
$ luarocks --lua-version 5.1 --local --tree ~/.local/share/nvim/rocks install code-stats.nvim
# ~/.local/share/nvim/rocks is the default rocks tree path
# you can change it according to your vim.g.rocks_nvim.rocks_path
```
## Configure
```lua
require"code-stats".setup({
args = {
headers = {
['X-API-Token'] = "XXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
}
})
```
For compatibility of
[code-stats-zsh](https://gitlab.com/code-stats/code-stats-zsh) and
[code-stats-bash](https://github.com/Freed-Wu/code-stats-bash), the following is
also OK:
```lua
require"code-stats".setup({
dotenv = "/the/path/of/codestats.sh"
})
```
`/the/path/of/codestats.sh`:
```sh
CODESTATS_API_KEY=XXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
## Tips
For Nix user, run
`/the/path/of/luarocks/rocks-5.1/code-stats.nvim/VERSION/scripts/update.sh` when
dynamic link libraries are broken after `nix-collect-garbage -d`.
## Related Projects
- [code-stats-vim](https://gitlab.com/code-stats/code-stats-vim)