Giters

aleksandersumowski / neovim-config-redux

A Fennel based configuration for Neovim (0.7.0 onward), aimed mainly at Clojure developers

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Practicalli Neovim Configuration

A Fennel configuration for Neovim 0.7.0 or greater, with a focus on Clojure REPL driven development with Conjure as well as general development workflow. A complete configuration to transform your Neovim in a simple, powerful and fun to use Clojure IDE

The key bindings (mappings) are evolving and trying to follow a Spacemacs style mnemonic approach (SPC f f to open a file browser). A which-key text menu is also provided to help discover key bindings. Using mnemonic keybinding will make Neovim more accessible to Spacemacs users (like myself) and those less familiar with the ways of interacting with a Vim editor, i.e. the : commands approach.

Practicalli Neovim book uses this configuration as it describes using Neovim, there is also (WIP) a description of this configuration in more detail.

Derived work

This project owes it existence to the contributions and guidance of rafaeldelboni and the amazing work on Aniseed and Conjure by Olical

Support has also been provided in the #vim channel of the Clojurians Slack community.

Prerequisites

How to use

Move $HOME/.config/nvim if you have an existing Neovim configuration

mv  $HOME/.config/nvim  $HOME/backup/nvim

Clone the repository to the $HOME/.config/nvim directory

git clone git@github.com:practicalli/neovim-config-redux.git $HOME/.config/nvim

Run nvim without opening any files and press RTN at the warning message.

When starting nvim for the first time, the download packer and aniseed plugins are downloaded and some errors occur as there are more packages to download using the Packer tool.

In Neovim, press : and type PackerInstall (or type Pack and press TAB to cycle through the menu of completions).

RET will run :PackerInstall, opening a new window (split) showing the progress of the install.

All the plugins declared in fnl/config/plugin.fnl should be installed

:q! to close neovim and use the nvim command open Neovim again, hopefully without errors this time.

Should errors persist, try :PackerUpdate in neovim and quit / restart.

Plugins

  • packer Plugin/package management
  • aniseed Bridges between fennel and nvim
  • conjure Interactive repl based evaluation for nvim
  • telescope Find, Filter, Preview, Pick
  • treesitter Incremental parsing system for highlighting, indentation, or folding
  • nvim-lspconfig Quickstart configurations for the Nvim LSP client
  • nvim-cmp Autocompletion plugin
  • github-nvim-theme Github theme for Neovim
  • tpope-vim-sexp-bundle sexp mappings for regular people
  • lualine neovim statusline plugin written in pure lua
  • luasnip Snippet Engine for Neovim written in Lua.
  • startup startup themes - using default dashboard
  • pwntester/octo.nvim GitHub Issues & PRs via GitHub CLI
  • nvim-comment toggle line comments with visual selection and motions (replaces tpope/commentary.vim)
  • Todo Comments Highlight and search for todo comments (TODO, NOTE, WARNING, FIX, HACK, PERF - specify in options)
  • neogit Magit clone - WIP with lots of useful features already
  • octo GitHub Issues and Pull Requests
  • orgmode excellent note taking and agenda management
  • tpope/fugitive Git command line installed, no key bindings yet (using neogit instead - although may need both)
  • gitsigns Git highlights in gutter - adding fugitive controls

Supporting plugins

Telescope extensions to try

Plugin Not used

Using Neovim

Starting Neovim

nvim runs Neovim on the command line and if no files are given as arguments then the startup dashboard is displayed, providing easy access to previously opened files and other common actions.

Neovim startup plugin with dashboard theme

Projects and files

Telescope and project plugin

TODO: configure telescope to respect the global gitignore patterns

Project key bindings - https://github.com/nvim-telescope/telescope-project.nvim#default-mappings-normal-mode

Comments

commentary.vim toggles a comment for lines, visual selections or for motions

gcc comment current line, 4gcc comment current line and next 4 lines

gc comment region or use with motion e.g. gcap comment paragraph,

gc in operator pending mode to target a comment TODO: what is operator pending mode

:7,17Commentary comment a range

:g/TODO/Commentary as part of a :global invocation

gcgc removes comments from a set of adjacent commented lines.

Version Control

Neogit provides a Magit style client.

fugitive package provides a command line experience (no keybinding)

<leader>gs opens Git Status, by running :Neogit

Other commands to map

:Neogit kind=<kind> " override kind
:Neogit cwd=<cwd> " override cwd
:Neogit commit" open commit popup

GitHub interaction

Work with GitHub issues and Pull Requests from the comfort of Neovim.

Requires the GitHub CLI for authentication to GitHub, using a developer personal access token that should be added to your GitHub account

TODO: Review Octo.nvim configuration settings

Command line form: Octo <object> <action> [arguments] - Object, Action and Arguments commands

List issues from current project (optionally add a specific repository)

:Octo issue list

Create a pull requests from current project

:Octo pr create

Add a comment to the current topic (issue/pr)

:Octo comment add

:Octo gist list

Files

init.lua

Wrapper responsible for two things:

  • Download and setup our package manager (packer.nvim) and our fennel helper/interface (aniseed)
  • Set the entrypoint for NVIM read our config files, in our case fnl/config/init.fnl.

fnl/config/init.fnl

  • Set basic global vim configurations and general keymaps.
  • Load plugin configuration namespace.

In this file among other settings I do set the leader key as space and local-leader as , for the sake of the examples of how use this configuration I will use this as basis for the commands.

fnl/config/plugin.fnl

Here we define the plugins we want packer to download and load for us, we define here a private function called use which will search in the plugin map for the keyword :mod and load the namespace defined in its value.

For example in the line we define that we need telescope we have this map:

  :nvim-telescope/telescope.nvim
  {:requires [:nvim-lua/popup.nvim
              :nvim-lua/plenary.nvim]
   :mod :telescope}

This will state to packer download nvim-telescope/telescope.nvim and all the required plugins in :requires and search for the namespace telescope in file located in the following path fnl/config/plugin/telescope, where I usually add plugin specific configuration like keymaps and settings.

fnl/config/plugin/conjure.fnl

Conjure specifics settings, I like to remap the doc work keymap to be <localleader>K instead the only K, to not conflict with the LSP docs K.

fnl/config/plugin/telescope.fnl

Settings like ignore node_modules and everything in .gitignore to be listed in the file finder. Keymaps:

  • <leader>pf open the find files
  • <leader>p/ open the fuzzy finder
  • <leader>bb open the find open buffer
  • <leader>h/ open the nvim help fuzzy finder

fnl/config/plugin/treesitter.fnl

Settings to select which treesitter's features we want enabled and which language extension we want to ensure they will be always installed.

fnl/config/plugin/lspconfig.fnl

All about nvim's lsp settings and keymaps.

LSP Configuration

  • In the first session, we define which symbols to show for lsp diagnostics.
  • Later we describe which features and server settings we want to enable/customize.
    • Handler defines features and how we want to render the server outputs.
    • Capabilities we link with our autocompletion plugin (nvim-cmp), to say to the lsp servers that we have this feature enabled.
    • On_Attach we customize our interaction with the LSP server, here we define the following keymaps:
      • gd Go to definition
      • K Show documentations
      • <leader>ld Function declarations
      • <leader>lt Type Definitions
      • <leader>lh Signature Help
      • <leader>ln Rename
      • <leader>le Show line diagnostics
      • <leader>lq Show all diagnostics information
      • <leader>lf Auto format
      • <leader>lj Go to next diagnostic
      • <leader>lk Go to previous diagnostic
      • <leader>la Open code actions menu (Using telescope plugin interface)
      • <leader>la Open code actions menu for the selected text in VISUAL mode (Using telescope plugin interface)
      • <leader>lw Open workspace diagnostics list (Using telescope plugin interface)
      • <leader>lr Show all references list for item under the cursor (Using telescope plugin interface)
      • <leader>lr Show all implementations list for item under the cursor (Using telescope plugin interface)
  • Lastly we configure to use all settings above in clojure-lsp server instance.

fnl/config/plugin/cmp.fnl

Here settings of which sources we want to show up in the autocomple menu like (conjure, lsp, buffer) and some mapping to navigate in the menu.

fnl/config/plugin/theme.fnl

This configuration uses the Neovim GitHub theme which gives 3 dark and 3 light themes to choose from. Individual colors and styles can be configured to change specific parts of the theme.

The light theme is used by default, with a softer background colour that is slightly red-shifted.

Options are specified in the theme.setup function, where the option names are keywords and the values are strings, boolean or hash-map of more option keywords and values.

(theme.setup {:theme_style "light"
              :colors {:bg "#f8f2e6"}
              :comment_style "italic"})

The colors (Hex values) for each theme are in the github-nvim-theme/lua/github-theme/palette with the overal theme definition in github-nvim-theme/lua/github-theme/theme.lua

fnl/config/plugin/sexp.fnl

Settings for vim-sexp like enabling it for another lisp languages like Fennel and Jannet

fnl/config/plugin/lualine.fnl

Configure the status line (lualine) that shows at the bottom of Neovim, defining colors and elements that appear on that line.

The Neovim GitHub theme includes definitions to set the look of the status line.

Neovim in action

Telescope - Find Files

telescope-find-files <leader>ff

Lsp - Syntax check

lsp-syntax-check <leader>le

Lsp - Go to definition

lsp-go-to-definition gd

Lsp - Document/Signature Help

lsp-document K/<leader>lh

Lsp - Find definition/references

lsp-find-references <leader>lr

Lsp - Formatting

lsp-format <leader>lf

Lsp - Code actions

lsp-code-actions <leader>la

Lsp - Refactorings

lsp-refactorings <leader>la

Lsp - Rename

lsp-rename <leader>ln

Conjure - Eval

conjure-eval <localleader>er

Conjure - Repl

conjure-repl <localleader>lv

Conjure - Document

conjure-document <localleader>K

Completion

auto-complete

Contributing

Please raise an issue for anything other than trivial changes

License

Creative Commons Attribution Share-Alike 4.0 International

Environment variables

:Telescope env list all the environment variables on the operating system, type patters to narrow the list

Getting help

:h menu followed by feature name that help is needed for, e.g. :h conjure

<leader>h/ list and preview help via telescope

Visual select tips

ve select to end of word

Where is...

Where is the neovim configuration?

:echo stdpath('config')

About

A Fennel based configuration for Neovim (0.7.0 onward), aimed mainly at Clojure developers

Languages

Language:Fennel 98.6%Language:Lua 1.4%