Mirrors/yamllint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

quoted-strings: rename skip-quoted-quote

Browse Source 
to allow-quoted-quotes
This commit is contained in:
Roman Geraskin
2022-08-06 21:14:21 +03:00
parent 140fac7ec8
commit 468b8a22bc
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
yamllint/rules/quoted_strings.py
View File

@@ -30,7 +30,7 @@ used.
``required: false`` and ``required: only-when-needed``. ``required: false`` and ``required: only-when-needed``.
* ``extra-allowed`` is a list of PCRE regexes to allow quoted string values, * ``extra-allowed`` is a list of PCRE regexes to allow quoted string values,
even if ``required: only-when-needed`` is set. even if ``required: only-when-needed`` is set.
* ``skip-quoted-quote`` allows (``true``) using disallowed quotes for strings * ``allow-quoted-quotes`` allows (``true``) using disallowed quotes for strings
with allowed quotes inside. Default ``false``. with allowed quotes inside. Default ``false``.
**Note**: Multi-line strings (with ``|`` or ``>``) will not be checked. **Note**: Multi-line strings (with ``|`` or ``>``) will not be checked.
@@ -45,7 +45,7 @@ used.
required: true required: true
extra-required: [] extra-required: []
extra-allowed: [] extra-allowed: []
skip-quoted-quote: false allow-quoted-quotes: false
.. rubric:: Examples .. rubric:: Examples
@@ -117,7 +117,7 @@ used.
- this is a string that needs to be QUOTED - this is a string that needs to be QUOTED
#. With ``quoted-strings: {quote-type: double, required: true, #. With ``quoted-strings: {quote-type: double, required: true,
skip-quoted-quote: false}`` allow-quoted-quotes: false}``
the following code snippet would **PASS**: the following code snippet would **PASS**:
:: ::
@@ -130,7 +130,7 @@ used.
foo: 'bar"baz' foo: 'bar"baz'
#. With ``quoted-strings: {quote-type: double, required: true, #. With ``quoted-strings: {quote-type: double, required: true,
skip-quoted-quote: true}`` allow-quoted-quotes: true}``
the following code snippet would **PASS**: the following code snippet would **PASS**:
:: ::
@@ -151,12 +151,12 @@ CONF = {'quote-type': ('any', 'single', 'double'),
'required': (True, False, 'only-when-needed'), 'required': (True, False, 'only-when-needed'),
'extra-required': [str], 'extra-required': [str],
'extra-allowed': [str], 'extra-allowed': [str],
'skip-quoted-quote': (True, False)} 'allow-quoted-quotes': (True, False)}
DEFAULT = {'quote-type': 'any', DEFAULT = {'quote-type': 'any',
'required': True, 'required': True,
'extra-required': [], 'extra-required': [],
'extra-allowed': [], 'extra-allowed': [],
'skip-quoted-quote': False} 'allow-quoted-quotes': False}
def VALIDATE(conf): def VALIDATE(conf):
@@ -166,8 +166,8 @@ def VALIDATE(conf):
return 'cannot use both "required: true" and "extra-required"' return 'cannot use both "required: true" and "extra-required"'
if conf['required'] is False and len(conf['extra-allowed']) > 0: if conf['required'] is False and len(conf['extra-allowed']) > 0:
return 'cannot use both "required: false" and "extra-allowed"' return 'cannot use both "required: false" and "extra-allowed"'
if conf['skip-quoted-quote'] is True and conf['quote-type'] == 'any': if conf['allow-quoted-quotes'] is True and conf['quote-type'] == 'any':
return '"skip-quoted-quote" has no effect with "quote-type: any"' return '"allow-quoted-quotes" has no effect with "quote-type: any"'
DEFAULT_SCALAR_TAG = u'tag:yaml.org,2002:str' DEFAULT_SCALAR_TAG = u'tag:yaml.org,2002:str'
@@ -230,7 +230,7 @@ def check(conf, token, prev, next, nextnext, context):
return return
# Check value is quoted qoute # Check value is quoted qoute
if (conf['skip-quoted-quote'] is True and (not token.plain) if (conf['allow-quoted-quotes'] is True and (not token.plain)
and ((token.style == "'" and '"' in token.value) or and ((token.style == "'" and '"' in token.value) or
(token.style == '"' and "'" in token.value))): (token.style == '"' and "'" in token.value))):
is_quoted_quote = True is_quoted_quote = True