Metadata-Version: 2.1
Name: flake8-efm
Version: 1.0.2
Summary: Plugin for EFM-compatible output.
Home-page: https://git.sr.ht/~whynothugo/flake8-efm
Author: Hugo Osvaldo Barrera
Author-email: hugo@barrera.io
License: ISC
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: flake8 (>3.0.0)

flake8-efm
==========

A plugin for flake8 to print output in a format compatible with Vim's
errorformat (efm).

This lets other tools pick up flake8 errors and identify them as
error/warning/etc.

Designed for efm-langserver_, but should work on any tool that expects a
similar format.

.. _efm-langserver: https://github.com/mattn/efm-langserver/

Usage
-----

For usage via `nvim-lspconfig` + `efm-langserver` use:

.. code-block:: lua

    local flake8 =  {
      -- Requires flake8-efm
      lintCommand = "flake8 --format efm --stdin-display-name ${INPUT} -",
      lintStdin = true,
      lintIgnoreExitCode = true,
      lintFormats = {
        "%f:%l:%c:%t:%m",
      }
    }

Details
-------

The default error format of flake8 shows an error code and a message, but
there's no obvious way to determine if something is an error or a warning. This
is especially true for third-party codes.

For now, the leading code of each letter is mapped to an error level
(error/warning/etc). There's support for _some_ third-party plugins, and
patches for others are most welcome.


