Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Do not break XML files special first line #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 15, 2021
Merged

Do not break XML files special first line #378

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0361dd8
Preserving first line in XML files #230
hoijui Jun 12, 2021
97c935f
Adds meself as author to header.py
hoijui Jun 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 27 additions & 17 deletions src/reuse/header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# SPDX-FileCopyrightText: © 2020 Liferay, Inc. <https://liferay.com>
# SPDX-FileCopyrightText: 2021 Alvar Penning
# SPDX-FileCopyrightText: 2021 Alliander N.V. <https://alliander.com>
# SPDX-FileCopyrightText: 2021 Robin Vobruba <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

Expand Down Expand Up @@ -37,6 +38,7 @@
CommentParseError,
CommentStyle,
EmptyCommentStyle,
HtmlCommentStyle,
PythonCommentStyle,
UncommentableCommentStyle,
)
Expand Down Expand Up @@ -259,23 +261,31 @@ def find_and_replace_header(
_LOGGER.debug(f"header = {repr(header)}")
_LOGGER.debug(f"after = {repr(after)}")

# Extract shebang from header and put it in before. It's a bit messy, but
# it ends up working.
if header.startswith("#!") and not before.strip():
before = ""
for line in header.splitlines():
if line.startswith("#!"):
before = before + "\n" + line
header = header.replace(line, "", 1)
else:
break
elif after.startswith("#!") and not any((before, header)):
for line in after.splitlines():
if line.startswith("#!"):
before = before + "\n" + line
after = after.replace(line, "", 1)
else:
break
# Keep special first-line-of-file lines as the first line in the file,
# or say, move our comments after it.
for (com_style, prefix) in [
(PythonCommentStyle, "#!"),
(HtmlCommentStyle, "<?xml"),
]:
# Extract shebang from header and put it in before. It's a bit messy, but
# it ends up working.
if style is not com_style:
continue
if header.startswith(prefix) and not before.strip():
before = ""
for line in header.splitlines():
if line.startswith(prefix):
before = before + "\n" + line
header = header.replace(line, "", 1)
else:
break
elif after.startswith(prefix) and not any((before, header)):
for line in after.splitlines():
if line.startswith(prefix):
before = before + "\n" + line
after = after.replace(line, "", 1)
else:
break

header = create_header(
spdx_info,
Expand Down