JSON & XML formaters

.gitignore

@@ -5,3 +5,6 @@ __pycache__
 /yamllint.egg-info
 /build
 /.eggs
+.venv
+venv
+.coverage

tests/test_cli.py

@@ -305,6 +305,9 @@ def test_run_with_user_global_config_file(self):
         config = os.path.join(dir, 'config')
 
         self.addCleanup(os.environ.update, HOME=os.environ['HOME'])
+        # remove other env vars to make sure we are using the HOME config file.
+        os.environ.pop('YAMLLINT_CONFIG_FILE', None)
+        os.environ.pop('XDG_CONFIG_HOME', None)
         os.environ['HOME'] = home
 
         with open(config, 'w') as f:

yamllint/cli.py

@@ -20,13 +20,13 @@
 import io
 import locale
 import os
-import platform
 import sys
 
 from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
 from yamllint import linter
 from yamllint.config import YamlLintConfig, YamlLintConfigError
 from yamllint.linter import PROBLEM_LEVELS
+from yamllint.format import show_all_problems, Formater
 
 
 def find_files_recursively(items, conf):
@@ -41,110 +41,6 @@ def find_files_recursively(items, conf):
             yield item
 
 
-def supports_color():
-    supported_platform = not (platform.system() == 'Windows' and not
-                              ('ANSICON' in os.environ or
-                               ('TERM' in os.environ and
-                                os.environ['TERM'] == 'ANSI')))
-    return (supported_platform and
-            hasattr(sys.stdout, 'isatty') and sys.stdout.isatty())
-
-
-class Format(object):
-    @staticmethod
-    def parsable(problem, filename):
-        return ('%(file)s:%(line)s:%(column)s: [%(level)s] %(message)s' %
-                {'file': filename,
-                 'line': problem.line,
-                 'column': problem.column,
-                 'level': problem.level,
-                 'message': problem.message})
-
-    @staticmethod
-    def standard(problem, filename):
-        line = '  %d:%d' % (problem.line, problem.column)
-        line += max(12 - len(line), 0) * ' '
-        line += problem.level
-        line += max(21 - len(line), 0) * ' '
-        line += problem.desc
-        if problem.rule:
-            line += '  (%s)' % problem.rule
-        return line
-
-    @staticmethod
-    def standard_color(problem, filename):
-        line = '  \033[2m%d:%d\033[0m' % (problem.line, problem.column)
-        line += max(20 - len(line), 0) * ' '
-        if problem.level == 'warning':
-            line += '\033[33m%s\033[0m' % problem.level
-        else:
-            line += '\033[31m%s\033[0m' % problem.level
-        line += max(38 - len(line), 0) * ' '
-        line += problem.desc
-        if problem.rule:
-            line += '  \033[2m(%s)\033[0m' % problem.rule
-        return line
-
-    @staticmethod
-    def github(problem, filename):
-        line = '::'
-        line += problem.level
-        line += ' file=' + filename + ','
-        line += 'line=' + format(problem.line) + ','
-        line += 'col=' + format(problem.column)
-        line += '::'
-        line += format(problem.line)
-        line += ':'
-        line += format(problem.column)
-        line += ' '
-        if problem.rule:
-            line += '[' + problem.rule + '] '
-        line += problem.desc
-        return line
-
-
-def show_problems(problems, file, args_format, no_warn):
-    max_level = 0
-    first = True
-
-    if args_format == 'auto':
-        if ('GITHUB_ACTIONS' in os.environ and
-                'GITHUB_WORKFLOW' in os.environ):
-            args_format = 'github'
-        elif supports_color():
-            args_format = 'colored'
-
-    for problem in problems:
-        max_level = max(max_level, PROBLEM_LEVELS[problem.level])
-        if no_warn and (problem.level != 'error'):
-            continue
-        if args_format == 'parsable':
-            print(Format.parsable(problem, file))
-        elif args_format == 'github':
-            if first:
-                print('::group::%s' % file)
-                first = False
-            print(Format.github(problem, file))
-        elif args_format == 'colored':
-            if first:
-                print('\033[4m%s\033[0m' % file)
-                first = False
-            print(Format.standard_color(problem, file))
-        else:
-            if first:
-                print(file)
-                first = False
-            print(Format.standard(problem, file))
-
-    if not first and args_format == 'github':
-        print('::endgroup::')
-
-    if not first and args_format != 'parsable':
-        print('')
-
-    return max_level
-
-
 def run(argv=None):
     parser = argparse.ArgumentParser(prog=APP_NAME,
                                      description=APP_DESCRIPTION)
@@ -162,8 +58,7 @@ def run(argv=None):
                               action='store',
                               help='custom configuration (as YAML source)')
     parser.add_argument('-f', '--format',
-                        choices=('parsable', 'standard', 'colored', 'github',
-                                 'auto'),
+                        choices=[*Formater.get_formaters_names(), 'auto'],
                         default='auto', help='format for parsing output')
     parser.add_argument('-s', '--strict',
                         action='store_true',
@@ -211,7 +106,8 @@ def run(argv=None):
     if conf.locale is not None:
         locale.setlocale(locale.LC_ALL, conf.locale)
 
-    max_level = 0
+    # problems dict: {file: problems}
+    all_problems = dict()
 
     for file in find_files_recursively(args.files, conf):
         filepath = file[2:] if file.startswith('./') else file
@@ -221,20 +117,22 @@ def run(argv=None):
         except EnvironmentError as e:
             print(e, file=sys.stderr)
             sys.exit(-1)
-        prob_level = show_problems(problems, file, args_format=args.format,
-                                   no_warn=args.no_warnings)
-        max_level = max(max_level, prob_level)
+        all_problems[file] = [pb for pb in problems if pb]
 
-    # read yaml from stdin
     if args.stdin:
+        # read yaml from stdin
         try:
             problems = linter.run(sys.stdin, conf, '')
         except EnvironmentError as e:
             print(e, file=sys.stderr)
             sys.exit(-1)
-        prob_level = show_problems(problems, 'stdin', args_format=args.format,
-                                   no_warn=args.no_warnings)
-        max_level = max(max_level, prob_level)
+        all_problems['stdin'] = [pb for pb in problems if pb]
+
+    max_level = show_all_problems(
+        all_problems,
+        args_format=args.format,
+        no_warn=args.no_warnings
+    )
 
     if max_level == PROBLEM_LEVELS['error']:
         return_code = 1