yamllint version 1.2.2

Patch allow-non-breakable-words on '-'

README.rst

@@ -82,7 +82,7 @@ Usage
  yamllint -d relaxed file.yaml
 
  # Use a custom lint configuration
- yamllint -c ~/myconfig file.yml
+ yamllint -c /path/to/myconfig file-to-lint.yaml
 
 .. code:: bash
 

docs/configuration.rst

@@ -1,16 +1,24 @@
 Configuration
 =============
 
-yamllint uses a set of *rules* to check sources files for problems. Each rule is
-independent from the others, and can be enabled, disabled or tweaked. All these
-settings can be gathered in a configuration file.
+yamllint uses a set of :doc:`rules <rules>` to check source files for problems.
+Each rule is independent from the others, and can be enabled, disabled or
+tweaked. All these settings can be gathered in a configuration file.
 
-To use a custom configuration file, either name it ``.yamllint`` in your working
-directory, or use the ``-c`` option:
+To use a custom configuration file, use the ``-c`` option:
 
 .. code:: bash
 
- yamllint -c ~/myconfig file.yaml
+ yamllint -c /path/to/myconfig file-to-lint.yaml
+
+If ``-c`` is not provided, yamllint will look for a configuration file in the
+following locations (by order of preference):
+
+- ``.yamllint`` in the current working directory
+- ``$XDG_CONFIG_HOME/yamllint/config``
+- ``$HOME/.config/yamllint/config``
+
+Finally if no config file is found, the default configuration is applied.
 
 Default configuration
 ---------------------

tests/rules/test_line_length.py

@@ -78,6 +78,12 @@ class LineLengthTestCase(RuleTestCase):
                    '        # http://localhost/very/long/url\n'
                    '        comment\n'
                    '...\n', conf)
+        self.check('---\n'
+                   'this:\n'
+                   'is:\n'
+                   'another:\n'
+                   '  - https://localhost/very/very/long/url\n'
+                   '...\n', conf)
 
         conf = 'line-length: {max: 20, allow-non-breakable-words: no}'
         self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21))
@@ -94,3 +100,9 @@ class LineLengthTestCase(RuleTestCase):
                    '        # http://localhost/very/long/url\n'
                    '        comment\n'
                    '...\n', conf, problem=(5, 21))
+        self.check('---\n'
+                   'this:\n'
+                   'is:\n'
+                   'another:\n'
+                   '  - https://localhost/very/very/long/url\n'
+                   '...\n', conf, problem=(5, 21))

tests/test_cli.py

@@ -153,6 +153,49 @@ class CommandLineTestCase(unittest.TestCase):
         self.assertEqual(out, '')
         self.assertRegexpMatches(err, r'^invalid config: not a dict')
 
+    def test_run_with_config_file(self):
+        with open(os.path.join(self.wd, 'config'), 'w') as f:
+            f.write('rules: {trailing-spaces: disable}')
+
+        with self.assertRaises(SystemExit) as ctx:
+            cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
+        self.assertEqual(ctx.exception.code, 0)
+
+        with open(os.path.join(self.wd, 'config'), 'w') as f:
+            f.write('rules: {trailing-spaces: enable}')
+
+        with self.assertRaises(SystemExit) as ctx:
+            cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
+        self.assertEqual(ctx.exception.code, 1)
+
+    def test_run_with_user_global_config_file(self):
+        home = os.path.join(self.wd, 'fake-home')
+        os.mkdir(home)
+        dir = os.path.join(home, '.config')
+        os.mkdir(dir)
+        dir = os.path.join(dir, 'yamllint')
+        os.mkdir(dir)
+        config = os.path.join(dir, 'config')
+
+        temp = os.environ['HOME']
+        os.environ['HOME'] = home
+
+        with open(config, 'w') as f:
+            f.write('rules: {trailing-spaces: disable}')
+
+        with self.assertRaises(SystemExit) as ctx:
+            cli.run((os.path.join(self.wd, 'a.yaml'), ))
+        self.assertEqual(ctx.exception.code, 0)
+
+        with open(config, 'w') as f:
+            f.write('rules: {trailing-spaces: enable}')
+
+        with self.assertRaises(SystemExit) as ctx:
+            cli.run((os.path.join(self.wd, 'a.yaml'), ))
+        self.assertEqual(ctx.exception.code, 1)
+
+        os.environ['HOME'] = temp
+
     def test_run_version(self):
         sys.stdout, sys.stderr = StringIO(), StringIO()
         with self.assertRaises(SystemExit) as ctx:

yaml-fix-indentation

@@ -1,50 +0,0 @@
-#!/bin/bash
-
-set -euf
-
-DIR=$(dirname "$(readlink -f $0)")
-
-fix_one_problem_in_file() {
-  local filename=$1
-  local error
-  error=$(yamllint -f parsable "$filename" | grep 'wrong indentation: expected' \
-    | head -n 1)
-  if [ -z "$error" ]; then
-    return 1
-  fi
-  local line=$(echo $error | cut -d: -f2)
-  local expected=$(echo $error | cut -d: -f5 | sed 's/.* expected //;s/ but found.*//')
-  local found=$(echo $error | cut -d: -f5 | sed 's/.*but found //;s/(inde.*//')
-  "$DIR/yaml-remove-indentation" "$filename" $line $expected $found
-  return 0
-}
-
-reformat_yaml() {
-  local in=$1
-  local out=$2
-  python -c 'import sys, yaml; yaml.dump(yaml.load(sys.stdin), sys.stdout)' <"$in" >"$out"
-}
-
-fix_one_file() {
-  local filename=$1
-  local backup=$(mktemp originalXXXXX)
-  cp "$filename" "$backup"
-  echo "FIXING    $file"
-  while fix_one_problem_in_file "$filename"; do continue; done
-  echo "CHECKING  $file"
-  local tmp_old=$(mktemp oldXXXXX)
-  local tmp_new=$(mktemp newXXXXX)
-  reformat_yaml "$backup" "$tmp_old"
-  reformat_yaml "$filename" "$tmp_new"
-  if ! diff -q "$tmp_old" "$tmp_new" &>/dev/null; then
-    echo "error: after reformating, the file contents is detected different."
-    echo "diff $backup $filename"
-    echo "diff $tmp_old $tmp_new"
-    exit 1
-  fi
-  rm "$backup" "$tmp_old" "$tmp_new"
-}
-
-for file in "$@"; do
-  fix_one_file "$file"
-done

yaml-remove-indentation

@@ -1,37 +0,0 @@
-#!/usr/bin/env python3
-
-import sys
-
-file = sys.argv[1]
-line = int(sys.argv[2]) - 1
-indent_expected = int(sys.argv[3])
-indent_found = int(sys.argv[4])
-
-with open(file) as f:
-    lines = f.readlines()
-
-    before = lines[:line]
-
-    is_a_list = lines[line].strip()[0] == '-'
-
-    i = line
-    while (i < len(lines) and
-           (lines[i].strip() == '' or
-            (not is_a_list and lines[i].startswith(indent_found * ' ')) or
-            (is_a_list and (lines[i].startswith(indent_found * ' ' + '-') or
-                            lines[i].startswith(indent_found * ' ' + ' '))))):
-        i += 1
-
-    contents = lines[line:i]
-    after = lines[i:]
-
-    new_contents = []
-    for line in contents:
-        if line.strip() != '':
-            line = (indent_expected * ' ') + line[indent_found:]
-        new_contents.append(line)
-
-with open(file, 'w') as f:
-    f.write(''.join(before))
-    f.write(''.join(new_contents))
-    f.write(''.join(after))

yamllint/__init__.py

@@ -22,7 +22,7 @@ indentation, etc."""
 
 
 APP_NAME = 'yamllint'
-APP_VERSION = '1.2.1'
+APP_VERSION = '1.2.2'
 APP_DESCRIPTION = __doc__
 
 __author__ = u'Adrien Vergé'

yamllint/cli.py

@@ -86,6 +86,15 @@ def run(argv=None):
               'simultaneously.', file=sys.stderr)
         sys.exit(-1)
 
+    # User-global config is supposed to be in ~/.config/yamllint/config
+    user_global_config = None
+    if 'XDG_CONFIG_HOME' in os.environ:
+        user_global_config = os.path.join(
+            os.environ['XDG_CONFIG_HOME'], 'yamllint', 'config')
+    elif 'HOME' in os.environ:
+        user_global_config = os.path.join(
+            os.environ['HOME'], '.config', 'yamllint', 'config')
+
     try:
         if args.config_data is not None:
             if args.config_data != '' and ':' not in args.config_data:
@@ -95,6 +104,8 @@ def run(argv=None):
             conf = YamlLintConfig(file=args.config_file)
         elif os.path.isfile('.yamllint'):
             conf = YamlLintConfig(file='.yamllint')
+        elif user_global_config and os.path.isfile(user_global_config):
+            conf = YamlLintConfig(file=user_global_config)
         else:
             conf = YamlLintConfig('extends: default')
     except YamlLintConfigError as e:

yamllint/rules/empty_lines.py

@@ -62,7 +62,7 @@ CONF = {'max': int,
 
 def check(conf, line):
     if line.start == line.end and line.end < len(line.buffer):
-        # Only alert on the last blank line of a serie
+        # Only alert on the last blank line of a series
         if (line.end < len(line.buffer) - 1 and
                 line.buffer[line.end + 1] == '\n'):
             return

yamllint/rules/line_length.py

@@ -59,7 +59,7 @@ Use this rule to set a limit to lines length.
    the following code snippet would **FAIL**:
    ::
 
-    - this line is waaaaaaaaaaaaaay too long but could be easily splitted...
+    - this line is waaaaaaaaaaaaaay too long but could be easily split...
 
 #. With ``line-length: {max: 60, allow-non-breakable-words: no}``
 
@@ -90,7 +90,7 @@ def check(conf, line):
                 start += 1
 
             if start != line.end:
-                if line.buffer[start] == '#':
+                if line.buffer[start] in ('#', '-'):
                     start += 2
 
                 if line.buffer.find(' ', start, line.end) == -1: