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

add rule to forbid empty values

Browse Source
This commit is contained in:
Maxime Picque
2022-02-03 14:09:06 +01:00
parent 4f1bbc33dc
commit 63f08c6f56
2 changed files with 52 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
tests/rules/test_empty_values.py
View File

@@ -62,6 +62,30 @@ class EmptyValuesTestCase(RuleTestCase):
'implicitly-null:with-colons:in-key2:\n', conf,
problem1=(2, 37))
def test_forbid_key_without_values_eof(self):
conf = ('empty-values: {forbid-in-block-mappings: false,\n'
' forbid-in-flow-mappings: false,\n'
' forbid-key-without-values-eof: true}\n')
self.check('---\n'
'implicitly-null\n', conf, problem1=(2, 16))
self.check('---\n'
'implicitly-null:\n', conf)
self.check('---\n'
'explicitly-null: null\n', conf)
self.check('---\n'
'implicitly-null:with-colons:in-key\n', conf,
problem1=(2, 35))
self.check('---\n'
'implicitly-null:with-colons:in-key:\n', conf)
self.check('---\n'
'explicitly-null:with-colons:in-key: null\n', conf)
self.check('---\n'
'implicitly-null:with-colons:in-key\n'
'key: value\n', conf, problem1=(3, 4, 'syntax'))
self.check('---\n'
'implicitly-null:with-colons:in-key:\n'
'key: value\n', conf)
def test_in_block_mappings_all_lines(self):
conf = ('empty-values: {forbid-in-block-mappings: true,\n'
' forbid-in-flow-mappings: false}\n')

32
yamllint/rules/empty_values.py
View File

@@ -22,6 +22,7 @@ Use this rule to prevent nodes with empty content, that implicitly result in
* Use ``forbid-in-block-mappings`` to prevent empty values in block mappings.
* Use ``forbid-in-flow-mappings`` to prevent empty values in flow mappings.
* Use ``forbid-key-without-values-eof`` to prevent empty values at the end of a file.
.. rubric:: Default values (when enabled)
@@ -31,6 +32,7 @@ Use this rule to prevent nodes with empty content, that implicitly result in
empty-values:
forbid-in-block-mappings: true
forbid-in-flow-mappings: true
forbid-key-without-values-eof: false
.. rubric:: Examples
@@ -73,23 +75,35 @@ Use this rule to prevent nodes with empty content, that implicitly result in
{a: 1, b:, c: 3}
#. With ``empty-values: {forbid-key-without-values-eof: true}``
the following code snippet would **PASS**:
::
key: value
the following code snippet would **FAIL**:
::
key:value
"""
import yaml
from yamllint.linter import LintProblem
ID = 'empty-values'
TYPE = 'token'
CONF = {'forbid-in-block-mappings': bool,
'forbid-in-flow-mappings': bool}
'forbid-in-flow-mappings': bool,
'forbid-key-without-values-eof': bool}
DEFAULT = {'forbid-in-block-mappings': True,
'forbid-in-flow-mappings': True}
'forbid-in-flow-mappings': True,
'forbid-key-without-values-eof': False}
def check(conf, token, prev, next, nextnext, context):
if conf['forbid-in-block-mappings']:
if isinstance(token, yaml.ValueToken) and isinstance(next, (
yaml.KeyToken, yaml.BlockEndToken)):
@@ -103,3 +117,13 @@ def check(conf, token, prev, next, nextnext, context):
yield LintProblem(token.start_mark.line + 1,
token.end_mark.column + 1,
'empty value in flow mapping')
if conf['forbid-key-without-values-eof']:
if isinstance(prev, (yaml.KeyToken, yaml.DocumentStartToken,
yaml.StreamStartToken)) \
and isinstance(token, yaml.ScalarToken) \
and isinstance(next, (yaml.DocumentEndToken,
yaml.StreamEndToken)):
yield LintProblem(token.start_mark.line + 1,
token.end_mark.column + 1,
'key with no value found')