NORMAL ~/wkd/p/insights :set skin=modern utf-8

insights.nvim

Static analysis of the project you are in, from inside Neovim. One :Insights command over symbol indexing, multi-language import analysis, Lua code metrics, annotation comments (TODO, FIX, … listed project-wide and coloured in the buffer), file-tree utilities, and automatic checks for git conflicts, unused imports and stray dev servers.

status
beta — Beta stage — active development. This repository is past its first shape and in active use, but the surface is not frozen: breaking changes are still possible. Pin a commit or tag if you depend on it.
category
Debug & inspect
neovim
0.9+
repo
github.com/WKDSteve/insights.nvim
commits
228
help
:help insights

demo

recorded with VHS from demos/insights.tape in a clean Neovim — re-recorded weekly
what is shown when
  1. annotation comments - TODO, FIX, HACK coloured as you read
  2. :Insights fileinfo - fs.stat of the buffer in a float
  3. :Insights todos - every annotation in the tree, to the quickfix list

install

{
  "WKDSteve/insights.nvim",
  opts = {},
}

docs/

git log

  1. test symbols: scan_cwd reads a file below a folder with an umlaut
  2. perf symbols: scan the Lua files of the cwd as text instead of loading each into a buffer
  3. perf imports, symbols, metrics: list files with the lib walker instead of globpath "**"
  4. docs readme: connections to the other repos of the workshop, as a picture and a list
  5. docs readme: the icon of the plugin on top, the files in assets/icons/insights-nvim
  6. ci regenerate the workflow, the ci-verified lookup fails closed (pipefail)
  7. test sheets: the feature catalog, and the sheets name their feature
  8. chore ci: regenerate the workflow (luacheck as a checked release binary, testing.nvim d9d2d35)
  9. chore scripts: scripts/test.sh from the current template (stopping it reaches nvim, lint subcommand)
  10. fix cli: metrics leaves out @types files as the editor does; unimported finds the right line
  11. fix cli: imports --lang narrows to the language
  12. feat cli: the static analyses without the editor (scripts/insights.lua)

keys

j / k
next / previous line
gg / G
first / last line
⏎
open the line under the cursor
/
search plugins and apps (app: x or plugin: x narrows)
:
command line — Tab completes
:help x
vimdoc of a plugin (:e x = plugin page)
:ls · :apps · :play · :log · :stack
plugin list · app list · play area · activity stream · dependency graph
:log apps
the stream of one area (plugins or apps)
:colo x
colorscheme
:set skin=
modern | tui
?
this help
esc
close