Git Product home page Git Product logo

diag_ignore.nvim's Introduction

diag_ignore.nvim

diag_ignore.nvim automates inserting of annotations to disable diagnostic checks in a line of code. Upon triggering the diag_ignore mapping, the user is presented with all the diagnostic messages on the current line. If the user selects a diagnostic code, the code will be ignored on the current line.

Currently supported languages are Lua (lua_ls) and Python (basedpyright, pyright).

Use your favourite plugin manager to install diag_ignore.nvim. For example, a minimal plugin spec with Lazy.nvim:

    {
      "amadanmath/diag_ignore.nvim",
      keys = {
        { '<Leader>ci', '<Plug>(diag_ignore)', mode = 'n', desc = 'Diagnostic: ignore' },
      },
      opts = {},
    }

The default options are:

    opts = {
      ignores = {
        python = { 'endline',  ' # pyright: ignore[', ']' },
        lua =    { 'prevline', '---@diagnostic disable-next-line: ' },
      },
    },

The ignores option lists the supported filetypes. Each value is a table:

    [filetype] = { type, prefix, suffix, joiner }

If suffix is nil, the default is '' (empty string). If joiner is nil, the default is ', ' (comma and space).

If type is 'endline', the annotation will be appended to the current line. For example, in Python, invoking diag_ignore.nvim on

    1

will result in

    1 # pyright: ignore[reportUnusedExpression]

If type is 'prevline', the annotation will be inserted on the previous line. For example, in Lua, invoking diag_ignore.nvim on

    1

will result in

    ---@diagnostic disable-next-line: exp-in-action
    1

If an annotation already exists and an additional diagnostic code is selected, the code will be inserted into the existing annotation, separated from the existing codes by joiner.

The default Python config is based on pyright/basedpyright. If you are using mypy, you will have to change the Python config as follows:

    python = { 'endline',  ' # type: ignore[', ']' },

diag_ignore.nvim's People

Contributors

amadanmath avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.