icholy / lsplinks.nvim Goto Github PK

View Code? Open in Web Editor NEW

70.0 3.0 0.0 1.8 MB

LSP textDocument/documentLink support for neovim

Lua 100.00%

neovim-plugin neovim-plugin-lua neovim-plugins

lsplinks.nvim's Introduction

LSPLINKS

Support for document links for neovim 0.9+.

Usage

The default behaviour of gx is described in the neovim help as:

Opens the current filepath or URL (decided by <cfile>, 'isfname') at cursor using the system default handler, by calling vim.ui.open().

This plugin extends this behaviour to support LSP document links.

Prerequisites:

An LSP server which supports textDocument/documentLink.

Configuration:

Call setup to initialise the plugin:

local lsplinks = require("lsplinks")
lsplinks.setup()
vim.keymap.set("n", "gx", lsplinks.gx)

Lazy Configuration:

{
    "icholy/lsplinks.nvim",
    config = function()
        local lsplinks = require("lsplinks")
        lsplinks.setup()
        vim.keymap.set("n", "gx", lsplinks.gx)
    end
}

Default Configuration:

lsplinks.setup({
    highlight = true,
    hl_group = "Underlined",
})

Demo 1:

Jump to $ref links in swagger/openapi files.

Demo 2:

Open https://pkg.go.dev from your go.mod or import statements.

lsplinks.nvim's People

Contributors

Stargazers

Watchers

lsplinks.nvim's Issues

Doesn't work with attached petstore.yml swagger v2

Placing the cursor over a $ref value and running require("lsplinks").jump() has no effect on this document:

swagger: "2.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
host: petstore.swagger.io
basePath: /v1
schemes:
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          type: integer
          format: int32
      responses:
        "200":
          description: A paged array of pets
          headers:
            x-next:
              type: string
              description: A link to the next page of responses
          schema:
            $ref: '#/definitions/Pets'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/Error'
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      responses:
        "201":
          description: Null response
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/Error'
  /pets/{petId}:
    get:
      summary: Info for a specific pet
      operationId: showPetById
      tags:
        - pets
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          type: string
      responses:
        "200":
          description: Expected response to a valid request
          schema:
            $ref: '#/definitions/Pets'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/Error'
definitions:
  Pet:
    type: "object"
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
      tag:
        type: string
  Pets:
    type: array
    items:
      $ref: '#/definitions/Pet'
  Error:
    type: "object"
    required:
      - code
      - message
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string

Please do not keep images in the repo

nvim package managers install plugins by cloning them, having images in the repo increases the download size. More detailed explanation: https://www.reddit.com/r/neovim/comments/wsg5yx/attention_to_all_plugin_authors_newcomers_careful/

FR: Do not set up `gx` keymap by default

Many people like me have a custom gx binding. It would be useful to not setup the gx keymap by default in the setup, or at least make it opt-out.

Invalid 'col ': out of range

Running the "Organize Imports" quickfix on a Go file with missing imports results in the following error:

Error executing vim.schedule lua callback: ...ly/.local/share/nvim/lazy/lsplinks.nvim/lua/lsplinks.lua:169: Invalid 'col': out of range
stack traceback:
        [C]: in function 'nvim_buf_set_extmark'
        ...ly/.local/share/nvim/lazy/lsplinks.nvim/lua/lsplinks.lua:169: in function 'display'
        ...ly/.local/share/nvim/lazy/lsplinks.nvim/lua/lsplinks.lua:150: in function 'handler'
        /usr/share/nvim/runtime/lua/vim/lsp/client.lua:680: in function ''
        vim/_editor.lua: in function <vim/_editor.lua:0>

Go Repro:

package main

import (
	"test"
)

func main() {
	os.Exit(1)
}

It's the CursorHold autocmd triggering the failing refresh:

{
  buf = 1,
  event = "CursorHold",
  file = "/tmp/scratch.YYJ7rD/main.go",
  group = 28,
  id = 39,
  match = "/tmp/scratch.YYJ7rD/main.go"
}

Invalid buffer id: 6

Error executing vim.schedule lua callback: ...ly/.local/share/nvim/lazy/lsplinks.nvim/lua/lsplinks.lua:138: Invalid buffer id: 6
stack traceback:
        [C]: in function 'nvim_buf_attach'
        ...ly/.local/share/nvim/lazy/lsplinks.nvim/lua/lsplinks.lua:138: in function 'handler'
        .../github.com/neovim/neovim/runtime/lua/vim/lsp/client.lua:687: in function ''
        vim/_editor.lua: in function <vim/_editor.lua:0>

[Feature Request] - To be able to disable highlight links

Hello, how are you? 👋
I want to congratulate you on this wonderful plugin? 👍

If it's not too much to ask, I would like to be able to configure this plugin to disable the link highlighting feature in future updates.
The link highlighting is great, but it doesn't look good with my current color scheme. 🙏

Another solution could be that the highlight link becomes active when the cursor hovers over it.