Merge pull request #166 from lfrodrigues/master

Added vscode formater and updated docs.

docs/usage.rst

@@ -29,6 +29,8 @@ The default output format of ``prospector`` is designed to be human readable. Yo
 +=============+============================================================================+
 | ``emacs``   | | Support for emacs compilation output mode, see `issue_16`_.              |
 +-------------+----------------------------------------------------------------------------+
+| ``vscode``  | | Support for vscode python plugin                                         |
++-------------+----------------------------------------------------------------------------+
 | ``grouped`` | | Similar to ``text``, but groups all message on the same line together    |
 |             | | rather than having a separate entry per message.                         |
 +-------------+----------------------------------------------------------------------------+
@@ -43,6 +45,8 @@ The default output format of ``prospector`` is designed to be human readable. Yo
 +-------------+----------------------------------------------------------------------------+
 | ``yaml``    | | Same as JSON except produces YAML output.                                |
 +-------------+----------------------------------------------------------------------------+
+| ``xunit``   | | Same as JSON except produces xunit compatile XML output.                 |
++-------------+----------------------------------------------------------------------------+
 | ``text``    | | The default output format, a simple human readable format.               |
 +-------------+----------------------------------------------------------------------------+
 

prospector/formatters/__init__.py

@@ -1,4 +1,4 @@
-from prospector.formatters import json, text, grouped, emacs, yaml, pylint, xunit
+from prospector.formatters import json, text, grouped, emacs, yaml, pylint, xunit, vscode
 
 
 __all__ = (
@@ -14,4 +14,5 @@
     'yaml': yaml.YamlFormatter,
     'pylint': pylint.PylintFormatter,
     'xunit': xunit.XunitFormatter,
+    'vscode': vscode.VSCodeFormatter,
 }

prospector/formatters/vscode.py

@@ -0,0 +1,36 @@
+import os
+import re
+from prospector.formatters.base import Formatter
+
+
+class VSCodeFormatter(Formatter):
+
+    """
+    This formatter outputs messages in the same way as vscode prospector linter expects.
+    """
+
+    def render(self, summary=True, messages=True, profile=False):
+        # this formatter will always ignore the summary and profile
+        cur_loc = None
+        output = []
+
+        for message in sorted(self.messages):
+
+            if cur_loc != message.location.path:
+                cur_loc = message.location.path
+                module_name = message.location.path.replace(os.path.sep, '.')
+                module_name = re.sub(r'(\.__init__)?\.py$', '', module_name)
+
+                header = '************* Module %s' % module_name
+                output.append(header)
+
+            template = '%(line)s,%(character)s,%(code)s,%(code)s:%(source)s %(message)s'
+            output.append(template % {
+                'line': message.location.line,
+                'character': message.location.character,
+                'source': message.source,
+                'code': message.code,
+                'message': message.message.strip()
+            })
+
+        return '\n'.join(output)