Skip to content
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

Ensure first lines remain intact with AddMissingHeaderRule #143

Merged
merged 1 commit into from
Oct 3, 2020
Merged

Ensure first lines remain intact with AddMissingHeaderRule #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 18 additions & 2 deletions fixit/rules/add_file_header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,18 @@ class AddMissingHeaderRule(CstLintRule):
}
),
expected_replacement="# header line\n# wrong header",
)
),
Invalid(
"""
#!/usr/bin/env python
# wrong header""",
config=LintConfig(
rule_config={
"AddMissingHeaderRule": {"path": "*.py", "header": "# header line"}
}
),
expected_replacement="#!/usr/bin/env python\n# header line\n# wrong header",
),
]

def __init__(self, context: CstContext) -> None:
Expand Down Expand Up @@ -133,9 +144,14 @@ def visit_Module(self, node: cst.Module) -> None:
if self.rule_disabled:
return
if not m.matches(node, m.Module(header=[*self.header_matcher, m.ZeroOrMore()])):
shebang, header = [], node.header
if header:
comment = header[0].comment
if isinstance(comment, cst.Comment) and comment.value.startswith("#!"):
shebang, header = [header[0]], header[1:]
self.report(
node,
replacement=node.with_changes(
header=[*self.header_replacement, *node.header]
header=[*shebang, *self.header_replacement, *header]
),
)