Is harper supposed to work for git commit messages that are edited by neovim?

[alcroito]

Hi.

I've set up harper using mason to be used by neovim.
I'm trying to get linting to work for git commit messages, which are opened by neovim when running git commit.

I've confirmed that harper is loaded by running :LspInfo and seeing Detected filetype: gitcommit and Client: harper_ls (id: 1, bufnr: [1])

There are no relevant errors in ~/.local/state/nvim/lsp.log.

Yet i don't get any suggestions for obvious types or cursing. I get them when i edit .cpp files for example.

My neovim config contains:

if has('nvim')
    " LSP manager
    Plug 'williamboman/mason.nvim'
    Plug 'williamboman/mason-lspconfig.nvim'
    Plug 'neovim/nvim-lspconfig'
endif


if has('nvim-0.9') && PlugLoaded('mason.nvim')
    lua require("mason").setup()

    lua <<EOF
    require'mason-lspconfig'.setup{
        ensure_installed = {"harper_ls"}
    }
EOF

    lua <<EOF
        require'lspconfig'.harper_ls.setup {
            filetypes = {"gitcommit", "markdown", "cpp"},
            settings = {
                ["harper-ls"] = {
                    linters = {
                        spell_check = true,
                        spelled_numbers = false,
                        an_a = true,
                        sentence_capitalization = true,
                        unclosed_quotes = true,
                        wrong_quotes = false,
                        long_sentences = true,
                        repeated_words = true,
                        spaces = true,
                        matcher = true,
                        correct_number_suffix = true,
                        number_suffix_capitalization = true,
                        multiple_sequential_pronouns = true,
                        linking_verbs = false,
                        avoid_curses = true,
                        terminating_conjunctions = true
                    }
                }
            }
        }
EOF
endif

Is my use case supposed to work?

[elijah-potter]

What a coincidence! I was just looking into this problem. Yes, harper-ls is supposed to support commit buffers. I'll update you when I have insight as why it is not working.

[elijah-potter]

Alright! I've nailed it down. Apparently the standard language ID for git commit buffers is git-commit, as demonstrated here. Neovim, however, emits gitcommit. I've updated harper-ls to accept both options. It should be working in the next release.

[alcroito]

Thank you for your time!

[alcroito]

I confirmed it works after building master from scratch.

[claydugo]

Off topic but reading through this highlighted something else I think might be worthwhile to add to the contributors documentation.

Building from source and then using a branched version alongside the Mason+nvim setup was something I attempted and failed at on first pass.

@alcroito would you mind sharing your workflow?

[alcroito]

The relevant parts of my neovim config i've already shared above.
For building harper, i cloned the repo, looked at the tasks defined by the justfile, and just decided to build using cargo build --release.

I then simply ran cp ~/Dev/projects/harper/target/release/harper-ls ~/.local/share/nvim/mason/bin/harper-ls
to override the mason downloaded harper with my own custom one.
So not exactly maintainable, but it did its job.