Add space to separate comments from tokens

https://yaml.org/spec/1.2/spec.html#id2780069
This commit is contained in:
Daniel M. Capella 2019-09-17 20:00:58 -04:00
parent 9585c8f908
commit 0c439c0c02
No known key found for this signature in database
GPG key ID: EA4F7B321A906AD9
2 changed files with 12 additions and 12 deletions

View file

@ -45,10 +45,10 @@ def _comment_out_line(line):
# Comment out the names of optional sections. # Comment out the names of optional sections.
one_indent = ' ' * INDENT one_indent = ' ' * INDENT
if not line.startswith(one_indent): if not line.startswith(one_indent):
return '#' + line return '# ' + line
# Otherwise, comment out the line, but insert the "#" after the first indent for aesthetics. # Otherwise, comment out the line, but insert the "#" after the first indent for aesthetics.
return '#'.join((one_indent, line[INDENT:])) return '# '.join((one_indent, line[INDENT:]))
REQUIRED_KEYS = {'source_directories', 'repositories', 'keep_daily'} REQUIRED_KEYS = {'source_directories', 'repositories', 'keep_daily'}

View file

@ -31,17 +31,17 @@ def test_comment_out_line_skips_already_commented_out_line():
def test_comment_out_line_comments_section_name(): def test_comment_out_line_comments_section_name():
line = 'figgy-pudding:' line = 'figgy-pudding:'
assert module._comment_out_line(line) == '#' + line assert module._comment_out_line(line) == '# ' + line
def test_comment_out_line_comments_indented_option(): def test_comment_out_line_comments_indented_option():
line = ' enabled: true' line = ' enabled: true'
assert module._comment_out_line(line) == ' #enabled: true' assert module._comment_out_line(line) == ' # enabled: true'
def test_comment_out_optional_configuration_comments_optional_config_only(): def test_comment_out_optional_configuration_comments_optional_config_only():
flexmock(module)._comment_out_line = lambda line: '#' + line flexmock(module)._comment_out_line = lambda line: '# ' + line
config = ''' config = '''
foo: foo:
bar: bar:
@ -57,17 +57,17 @@ location:
''' '''
expected_config = ''' expected_config = '''
#foo: # foo:
# bar: # bar:
# - baz # - baz
# - quux # - quux
# #
location: location:
repositories: repositories:
- one - one
- two - two
# #
# other: thing # other: thing
''' '''
assert module._comment_out_optional_configuration(config.strip()) == expected_config.strip() assert module._comment_out_optional_configuration(config.strip()) == expected_config.strip()