Ensure a newline (\n) at the end of a file
Change-Id: I1ab532b4c3d7410d3f0826f1ba678d2933780b52
This commit is contained in:
parent
d313c1ad51
commit
45cf0461e4
@ -1,6 +1,11 @@
|
|||||||
Release notes
|
Release notes
|
||||||
=============
|
=============
|
||||||
|
|
||||||
|
0.20
|
||||||
|
----
|
||||||
|
|
||||||
|
* ``openstack-doc-test``: Check for a ``\n`` in the last line of a file.
|
||||||
|
|
||||||
0.19
|
0.19
|
||||||
----
|
----
|
||||||
|
|
||||||
|
@ -193,6 +193,17 @@ def verify_profiling(doc):
|
|||||||
verify_attribute_profiling(doc, "audience", KNOWN_AUDIENCE_VALUES)
|
verify_attribute_profiling(doc, "audience", KNOWN_AUDIENCE_VALUES)
|
||||||
|
|
||||||
|
|
||||||
|
def verify_newline_end_of_file(docfile):
|
||||||
|
"""Check that there is a newline at the end of file."""
|
||||||
|
|
||||||
|
with open(docfile, 'r') as fp:
|
||||||
|
lines = fp.readlines()
|
||||||
|
lastline = lines[-1]
|
||||||
|
|
||||||
|
if not lastline.endswith('\n'):
|
||||||
|
raise ValueError('last line of a file must end with a \\n')
|
||||||
|
|
||||||
|
|
||||||
def verify_whitespace_niceness(docfile):
|
def verify_whitespace_niceness(docfile):
|
||||||
"""Check that no unnecessary whitespaces are used."""
|
"""Check that no unnecessary whitespaces are used."""
|
||||||
checks = [
|
checks = [
|
||||||
@ -494,6 +505,7 @@ def validate_one_json_file(rootdir, path, verbose, check_syntax,
|
|||||||
try:
|
try:
|
||||||
if check_niceness:
|
if check_niceness:
|
||||||
verify_whitespace_niceness(path)
|
verify_whitespace_niceness(path)
|
||||||
|
verify_newline_end_of_file(path)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
any_failures = True
|
any_failures = True
|
||||||
print(" %s: %s" % (os.path.relpath(path, rootdir), e))
|
print(" %s: %s" % (os.path.relpath(path, rootdir), e))
|
||||||
@ -524,6 +536,7 @@ def validate_one_file(schema, rootdir, path, verbose,
|
|||||||
verify_valid_links(doc)
|
verify_valid_links(doc)
|
||||||
if check_niceness:
|
if check_niceness:
|
||||||
verify_whitespace_niceness(path)
|
verify_whitespace_niceness(path)
|
||||||
|
verify_newline_end_of_file(path)
|
||||||
except etree.XMLSyntaxError as e:
|
except etree.XMLSyntaxError as e:
|
||||||
any_failures = True
|
any_failures = True
|
||||||
print(" %s: %s" % (os.path.relpath(path, rootdir), e))
|
print(" %s: %s" % (os.path.relpath(path, rootdir), e))
|
||||||
|
Loading…
Reference in New Issue
Block a user