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.

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

Test to check our string escape word triggers on its own #2879

Merged
merged 7 commits into from
Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/codespell-private.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
test:
env:
REQUIRE_ASPELL: true
RUFF_FORMAT: github
# Make sure we're using the latest aspell dictionary
runs-on: ubuntu-22.04
strategy:
Expand Down Expand Up @@ -75,6 +76,8 @@ jobs:
- run: make check-dictionaries

ruff-annotation:
env:
RUFF_FORMAT: github
runs-on: ubuntu-latest
steps:
- name: Setup python
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ codespell
=========

Fix common misspellings in text files. It's designed primarily for checking
misspelled words in source code, but it can be used with other files as well.
misspelled words in source code (backslash escapes are skipped), but it can be used with other files as well.
It does not check for word membership in a complete dictionary, but instead
looks for a set of common misspellings. Therefore it should catch errors like
"adn", but it will not catch "adnasdfasdf". This also means it shouldn't
Expand Down
11 changes: 8 additions & 3 deletions codespell_lib/tests/test_basic.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,6 @@ def test_basic(
with fname.open("a") as f:
f.write("this is a test file\n")
assert cs.main(fname) == 0, "good"
with fname.open("a") as f:
f.write("var = '\\nDoes not error on newline'\n")
assert cs.main(fname) == 0, "with string escape"
with fname.open("a") as f:
f.write("abandonned\n")
assert cs.main(fname) == 1, "bad"
Expand All @@ -110,6 +107,14 @@ def test_basic(
f.write("tim\ngonna\n")
assert cs.main(fname) == 2, "with a name"
assert cs.main("--builtin", "clear,rare,names,informal", fname) == 4
with fname.open("w") as f: # overwrite the file
f.write("var = 'nwe must check codespell likes escapes nin strings'\n")
assert cs.main(fname) == 1, "checking our string escape test word is bad"
# the first one is missed because the apostrophe means its not currently
# treated as a word on its own
with fname.open("w") as f: # overwrite the file
f.write("var = '\\nwe must check codespell likes escapes \\nin strings'\n")
assert cs.main(fname) == 0, "with string escape"
result = cs.main(fname, "--builtin", "foo", std=True)
assert isinstance(result, tuple)
code, _, stderr = result
Expand Down