#177: Forbid to use CRLF end-of-line #708

nifadyev · 2024-09-30T14:01:32Z

I have made things!

Checklist

I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
I have created at least one test case for the changes I have made
I have updated the documentation for the changes I have made
I have added my changes to the CHANGELOG.md

Related issues

Closes Forbid to use \r\n for line breaks #177

nifadyev · 2024-09-30T14:03:14Z

Hey @sobolevn . Should file .env.eol be committed with \r\n line endings? Also, I don't know how to properly write the reasoning for this violation rule

sobolevn

Thanks!

sobolevn · 2024-09-30T14:10:49Z

dotenv_linter/violations/values.py

+    Restricts to use `/r/n` (CRLF) end-of-line.
+
+    Reasoning:
+        ???


Mixing different end-of-line chars can lead to different hard-to-debug problems.

sobolevn · 2024-09-30T14:11:05Z

dotenv_linter/violations/values.py

+        ???
+
+    Solution:
+        Use `/n` (LF) end-of-line.


Please, mention .gitattributes file here.

sobolevn · 2024-09-30T14:11:16Z

dotenv_linter/violations/values.py

+    Solution:
+        Use `/n` (LF) end-of-line.
+
+    Example::


Please, remove this section.

sobolevn · 2024-09-30T14:12:44Z

dotenv_linter/visitors/fst/values.py

@@ -35,3 +39,9 @@ def _check_value_quotes(self, node: Value) -> None:
            self._add_violation(QuotedValueViolation(node, text=node.raw_text))
        elif text.startswith("'") and text.endswith("'"):
            self._add_violation(QuotedValueViolation(node, text=node.raw_text))
+
+    def _is_crlf_eol_used(self, node: Value) -> None:
+        crlf_eol = '\r'


Please, make this a module-level final constant.

sobolevn · 2024-09-30T14:12:55Z

setup.cfg

@@ -65,7 +65,8 @@ addopts =
  --strict-markers
  --strict-config
  --doctest-modules
-  --cov=dotenv_linter
+  # Disable with option to allow debugging
+  ; --cov=dotenv_linter


Please, re-enable

No problem. Should it be mentioned somewhere? For example, in Development README section?

sobolevn · 2024-09-30T14:13:19Z

tests/fixtures/.env.correct

@@ -4,3 +4,4 @@
 # See: https://github.com/wemake-services/dotenv-linter/issues/20
 TEST=1
 EMPTY=
+VARIABLE_WITH_TRAILING_SLASH_R=value/r


/r and \r are clearly not the same

sobolevn · 2024-09-30T14:13:58Z

tests/fixtures/.env.eol

@@ -0,0 +1 @@
+VARIABLE_WITH_CRLF_EOL=123


Please, make this test a code-only, no fixtures should be used. Since there are lots of editors / tools / etc that fix eofs.

Just to make it clear - Are you suggest creating temp file inside test?

sobolevn · 2024-09-30T14:14:25Z

tests/test_cli/test_lint_command.py

        assert str(violation_class.code) in stderr
+
+
+def test_lint_wrong_eol(fixture_path: Callable) -> None:


Suggested change

def test_lint_wrong_eol(fixture_path: Callable) -> None:

def test_lint_wrong_eol(fixture_path: Callable[[str], str]) -> None:

nifadyev · 2024-09-30T14:20:50Z

Is violation name suitable? InvalidEOLViolation is the first thing that came up into my mind

sobolevn · 2024-10-01T19:03:54Z

dotenv_linter/visitors/fst/values.py

@@ -8,6 +8,8 @@
 )
 from dotenv_linter.visitors.base import BaseFSTVisitor

+CRLF_EOL: Final[str] = '\r'


Suggested change

CRLF_EOL: Final[str] = '\r'

CRLF_EOL: Final = '\r'

sobolevn · 2024-10-01T19:06:08Z

tests/test_cli/test_lint_command.py

    """Checks that `lint` command works for with with CRLF end-of-line."""
+    temp_file_path = fixture_path('.env.temp')
+    with open(temp_file_path, mode='w') as temp_file:


Please, use tempfile module instead here.

I've used tmp_path pytest fixture instead, tempfile.NamedTemporaryFile didn't work out

sobolevn · 2024-10-01T19:06:17Z

tests/test_cli/test_lint_command.py

    """Checks that `lint` command works for with with CRLF end-of-line."""
+    temp_file_path = fixture_path('.env.temp')
+    with open(temp_file_path, mode='w') as temp_file:
+        _ = temp_file.write("VARIABLE_WITH_CRLF_EOL=123\r\n")


Suggested change

_ = temp_file.write("VARIABLE_WITH_CRLF_EOL=123\r\n")

temp_file.write("VARIABLE_WITH_CRLF_EOL=123\r\n")

sobolevn

Thanks! Great work!

codecov · 2024-10-04T10:08:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.28%. Comparing base (460b6fe) to head (a81dfda).
Report is 76 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #708      +/-   ##
==========================================
- Coverage   97.62%   97.28%   -0.35%     
==========================================
  Files          22       22              
  Lines         463      478      +15     
  Branches       74       95      +21     
==========================================
+ Hits          452      465      +13     
- Misses          8       10       +2     
  Partials        3        3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nifadyev added 6 commits September 30, 2024 16:33

Add InvalidEOLViolation for values

5b03923

Add examples for new rule

44d2787

Add comment about pytest flag and debugging

fcd8159

Add test for new EOL rule

e35f1b9

Fix too long comments

5ad4d9a

Add rule 302 to CHANGELOG

96d62f8

sobolevn reviewed Sep 30, 2024

View reviewed changes

nifadyev added 6 commits September 30, 2024 17:48

Add detailed documentation for InvalidEOFViolation

96be525

Move crlf_eol to module constants

4891a82

Fix invalid slash

5636cdb

Remove extra test fixture, create temp file in test instead

1fecd63

Uncomment pytest flag

10ca2a4

Fix lint issues

66a4128

sobolevn reviewed Oct 1, 2024

View reviewed changes

nifadyev added 2 commits October 4, 2024 12:26

Fix type annotation

77a6b9d

Use pytest tmp_path fixture for creating temp file

a81dfda

sobolevn approved these changes Oct 4, 2024

View reviewed changes

sobolevn merged commit 0fee69a into wemake-services:master Oct 4, 2024
7 of 8 checks passed

nifadyev deleted the feature/#177/forbid-to-use-crlf-eol branch October 4, 2024 11:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#177: Forbid to use CRLF end-of-line #708

#177: Forbid to use CRLF end-of-line #708

nifadyev commented Sep 30, 2024 •

edited

Loading

nifadyev commented Sep 30, 2024

sobolevn left a comment

sobolevn Sep 30, 2024

sobolevn Sep 30, 2024

sobolevn Sep 30, 2024

sobolevn Sep 30, 2024

sobolevn Sep 30, 2024

nifadyev Sep 30, 2024

sobolevn Sep 30, 2024

sobolevn Sep 30, 2024

nifadyev Sep 30, 2024

sobolevn Sep 30, 2024

sobolevn Sep 30, 2024

nifadyev commented Sep 30, 2024

sobolevn Oct 1, 2024

sobolevn Oct 1, 2024

nifadyev Oct 4, 2024

sobolevn Oct 1, 2024

sobolevn left a comment

codecov bot commented Oct 4, 2024 •

edited

Loading

		assert str(violation_class.code) in stderr


		def test_lint_wrong_eol(fixture_path: Callable) -> None:

	_ = temp_file.write("VARIABLE_WITH_CRLF_EOL=123\r\n")
	temp_file.write("VARIABLE_WITH_CRLF_EOL=123\r\n")

		@@ -0,0 +1 @@
		VARIABLE_WITH_CRLF_EOL=123

#177: Forbid to use CRLF end-of-line #708

#177: Forbid to use CRLF end-of-line #708

Conversation

nifadyev commented Sep 30, 2024 • edited Loading

I have made things!

Checklist

Related issues

nifadyev commented Sep 30, 2024

sobolevn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nifadyev commented Sep 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sobolevn left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 4, 2024 • edited Loading

Codecov Report

nifadyev commented Sep 30, 2024 •

edited

Loading

codecov bot commented Oct 4, 2024 •

edited

Loading