Neovim

This is my neovim config 🤘. I've documented some findings after struggling to configure some things/going down rabbit holes.

Completion

Install coc-nvim. In there documentation, they provide some configruation to make sure things like tab completion and autosuggestion capabilities work. Copy it and paste it in your init.vim

CocConfig

Coc config is where we can configure our coc extensions, as well as coc as a whole.

Completion Item Kind Labels

If we don't configure this, our popup menu for autosuggestion/autocompletion will use the default labels set by coc-nvim. You can configure them as such:

"suggest.completionItemKindLabels": {
    "keyword": " ",
    "variable": " ",
    "value": " ",
    "operator": "",
    "constructor": " ",
    "function": " ",
    "reference": " ",
    "constant": " ",
    "method": " ",
    "struct": " ",
    "class": " ",
    "interface": " ",
    "text": " ",
    "enum": "練",
    "enumMember": " ",
    "module": " ",
    "color": " ",
    "property": "ﰠ ",
    "field": " ",
    "unit": "塞",
    "event": " ",
    "file": "",
    "folder": " ",
    "snippet": " ",
    "typeParameter": " ",
    "default": ""
  }

Configure Float Config and Highlights

We can configure the highlights/color of our float window for autosuggesiton. Example:

"hover.floatConfig": {
    "border": true,
    "title": " 🙈",
    "winblend": 10,
    "maxHeight": 10,
    "highlight": "GruvboxGreen"
  },
  "suggest.floatConfig": {
    "border": true,
    "winblend": 10,
    "highlight": "GruvboxGreen"
  },
  "signature.floatConfig": {
    "border": true,
    "title": " 🙈",
    "winblend": 10,
    "highlight": "GruvboxGreen"
  }

I suggest using a highlight from your colorscheme.

Linting

Coc does a lot out of the box: autocompletion (obviously) autosuggestions, diagnostics, linting (based on your lsp), fixing linting errors, display sybmols via an outline tree, etc.

We want to primarily use coc-nvim for autocompletion and autosuggestions and leave the linting and correction of linting errors to ale.

Setup

Setup for ale involves editing coc-settings.json, setting our linters, and setting our linting-fixers.

Coc Config

First, make sure that these settings in your coc-settings.json file are removed:

"coc.preferences.formatOnSaveFiletypes": ["*"]
"coc.preferences.formatOnType": true <- this is set to false by default

And make sure this is set to false:

"diagnostic.enable": false
"diagnostic.displayByAle": true

Make sure to uninstall coc-prettier and coc-eslint and remove them from g:coc_global_extensions if you have them within the list.

Ale global settings

Next, we need to set some settings in init.vim our a vimscript file

let g:ale_lint_on_text_changed=0 " Don't let ale eat up resources
let g:ale_lint_on_insert_leave=1 " We want to only do linting on insert leave
let g:ale_lint_on_enter=1        " Or lint on insert enter
let g:ale_lint_on_save=1         " Lint on save
let g:ale_set_highlights=0       " Cosmetic
let g:ale_set_quickfix = 1       " Ale linting errors will be forwarded to quickfix. Ale and coc-diagnostics share this
let g:ale_set_loclist=1          " Ale linting errors will be forwarded to here too
let g:ale_cursor_detail=0
let g:ale_set_signs=1            " Cosmetic, we want to display signs
let g:ale_virtualtext_cursor=1
let g:ale_change_sign_column_color=0
let g:ale_sign_error = '🚨'
let g:ale_sign_warning = '🚧'
let g:ale_list_vertical=1
let g:ale_sign_info = '📣'
let g:ale_fix_on_save=1 "Let ale do the work for autoformatting, not coc

Ale Linters and Fixers

Lastly, we want to explicitly set our ale linters and our fixers Must have fixers installed! Globally for golang, locally for javascript.

Ex:

bash~$: go get <golangci-lint>

bash~$: npm install --save-dev <eslint/prettier>

OR:

bash!$: npx eslint --init (the better option)

let g:ale_linters={
      \ 'javascript': ['prettier', 'eslint'],
      \ 'go': ['golangci-lint'] 
      \}

let g:ale_go_golangci_lint_executable = 'golangci-lint'

let g:ale_go_golangci_lint_options = '' " don't use the default, with is --enable-all

let g:ale_fixers = {
      \ 'javascript': ['eslint'],
      \ 'go': ['gofumpt', 'gofmt'],
      \}

Disclaimer about golangci-lint

It's fairly aggressive on linting errors. It enforces us to create pkgs if we are importing functions external to main pkg. It also errors if we aren't checking errors. We can always use another linter, like gofmt or gofumpt.

If we don't want the linting errors above, we set the below to 1.

let g:ale_go_golangci_lint_package=1

However, it will lint everything in the current pkg, which means it may lint vendored pkgs too :(. This setting sounds very resource intensive so it's better to set to 0. Instead, we primarily want to lint our current file, not every file in every vendored and local pkg.

Check :help ale-go

Checking for Supported Linters and Fixers

Run :help ale to find supported linters or :ALEInfo while in a specific filetype. Run :ALEFixSuggestions and you'll see supported fixers.