Feature: Added single-unless-contains-escaped quote type to quoted strings.

Author: Timo Schrader

tests/rules/test_quoted_strings.py

@@ -227,6 +227,51 @@ def test_quote_type_consistent(self):
                    conf, problem1=(3, 10), problem2=(5, 18), problem3=(6, 11),
                    problem4=(8, 10), problem5=(10, 3), problem6=(12, 3))
 
+    def test_quote_type_single_unless_contains_escaped(self):
+        conf = 'quoted-strings: {quote-type: single-unless-contains-escaped}'
+        self.check('---\n'
+                   "string1: 'foo'\n"
+                   'string2: "bar\\nstool"\n'
+                   'string3: "baz"\n'             # fails
+                   "string4: 'quux'\n",
+                   conf, problem1=(4, 10))
+
+        conf = ('quoted-strings:\n'
+                '  quote-type: single-unless-contains-escaped\n'
+                '  check-keys: true\n')
+
+        self.check('---\n'
+                   "'string1': 'foo'\n"
+                   "\"string2\\tsplit\": 'foo'\n"
+                   "'string3': \"foo\\nbar\"\n"
+                   "string4: 'bar'\n"                # fails
+                   "\"string5\": 'baz'\n"            # fails
+                   "'string6': {'key': 'val'}\n"
+                   "'string7': \"foo\"\n",
+                   conf, problem1=(5, 1), problem2=(6, 1), problem3=(8, 12))
+
+        conf = ('quoted-strings:\n'
+                '  quote-type: single-unless-contains-escaped\n'
+                '  check-keys: true\n'
+                '  required: false\n')
+        self.check('---\n'
+                   'string1: \'foo\'\n'
+                   'string2: "bar"\n'               # fails
+                   'string3: \'baz\'\n'
+                   'string4: {\'key\': "val"}\n'    # fails
+                   'string5: {"key": \'val\'}\n'    # fails
+                   'string6:\n'
+                   '  \'key\': "val"\n'             # fails
+                   'string7:\n'
+                   '  "key": \'val\'\n'             # fails
+                   'string8:\n'
+                   '  "string"\n'                   # fails
+                   'string9: >\n'
+                   '  "string"\n'
+                   'string10: "bar\\nstool"\n',
+                   conf, problem1=(3, 10), problem2=(5, 18), problem3=(6, 11),
+                   problem4=(8, 10), problem5=(10, 3), problem6=(12, 3))
+
     def test_any_quotes_not_required(self):
         conf = 'quoted-strings: {quote-type: any, required: false}\n'
 

yamllint/rules/quoted_strings.py

@@ -20,7 +20,8 @@
 
 .. rubric:: Options
 
-* ``quote-type`` defines allowed quotes: ``single``, ``double`` or ``any``
+* ``quote-type`` defines allowed quotes: ``single``, ``double``,
+  ``single-unless-contains-escaped``, or ``any``
   (default).
 * ``required`` defines whether using quotes in string values is required
   (``true``, default) or not (``false``), or only allowed when really needed
@@ -165,6 +166,19 @@
    ::
 
     "foo:bar": baz
+#. With ``quoted-strings: {quote-type: single-unless-contains-escaped}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: 'bar'
+    baz: "quux\\nquux 2"
+
+   the following code snippet would **FAIL**:
+   ::
+
+    foo: 'bar'
+    baz: "quux quux 2"
 """
 
 import re
@@ -175,7 +189,14 @@
 
 ID = 'quoted-strings'
 TYPE = 'token'
-CONF = {'quote-type': ('any', 'single', 'double', 'consistent'),
+CONF = {'quote-type':
+        (
+            'any',
+            'single',
+            'double',
+            'consistent',
+            'single-unless-contains-escaped'
+        ),
         'required': (True, False, 'only-when-needed'),
         'extra-required': [str],
         'extra-allowed': [str],
@@ -212,14 +233,24 @@ def VALIDATE(conf):
     list('-+0123456789'))
 
 
-def _quote_match(quote_type, token_style, context):
+def _quote_match(quote_type, token, context):
+    token_style = token.style
+
     if quote_type == 'consistent' and token_style is not None:
         # The canonical token style in a document is assumed to be the first
         # one found for the purpose of 'consistent'
         if 'quoted_strings_consistent_token_style' not in context:
             context['quoted_strings_consistent_token_style'] = token_style
         return context['quoted_strings_consistent_token_style'] == token_style
 
+    if (quote_type == 'single-unless-contains-escaped' and
+            token_style is not None):
+        plain_value = token.start_mark.buffer[
+            token.start_mark.pointer:token.end_mark.pointer
+        ]
+        return ((token_style == "'") or
+                (token_style == '"' and '\\' in plain_value))
+
     return ((quote_type == 'any') or
             (quote_type == 'single' and token_style == "'") or
             (quote_type == 'double' and token_style == '"'))
@@ -315,15 +346,15 @@ def check(conf, token, prev, next, nextnext, context):
 
         # Quotes are mandatory and need to match config
         if (token.style is None or
-            not (_quote_match(quote_type, token.style, context) or
+            not (_quote_match(quote_type, token, context) or
                  (conf['allow-quoted-quotes'] and _has_quoted_quotes(token)))):
             msg = f"string {node} is not quoted with {quote_type} quotes"
 
     elif conf['required'] is False:
 
         # Quotes are not mandatory but when used need to match config
         if (token.style and
-                not _quote_match(quote_type, token.style, context) and
+                not _quote_match(quote_type, token, context) and
                 not (conf['allow-quoted-quotes'] and
                      _has_quoted_quotes(token))):
             msg = f"string {node} is not quoted with {quote_type} quotes"
@@ -349,7 +380,7 @@ def check(conf, token, prev, next, nextnext, context):
 
         # But when used need to match config
         elif (token.style and
-              not _quote_match(quote_type, token.style, context) and
+              not _quote_match(quote_type, token, context) and
               not (conf['allow-quoted-quotes'] and _has_quoted_quotes(token))):
             msg = f"string {node} is not quoted with {quote_type} quotes"