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

add codespell ignore #76

Merged
merged 2 commits into from
Jan 14, 2025
Merged

add codespell ignore #76

merged 2 commits into from
Jan 14, 2025

Conversation

blooop
Copy link
Owner

@blooop blooop commented Jan 14, 2025

Summary by Sourcery

Build:

  • Add a codespell-ignore.txt file to specify words that should be ignored by the codespell hook.

Copy link

sourcery-ai bot commented Jan 14, 2025

Reviewer's Guide by Sourcery

This pull request adds a codespell-ignore.txt file to the project and updates the pre-commit config to use it. This allows us to ignore specific words that are flagged as spelling mistakes by codespell.

Flow diagram for updated codespell pre-commit hook configuration

flowchart LR
    A[Pre-commit Hook] --> B[Codespell Check]
    B --> C{Check Word}
    C -->|Word in ignore list| D[Skip Word]
    C -->|Word not in ignore list| E{Is Misspelled?}
    E -->|Yes| F[Fix Spelling]
    E -->|No| G[Keep Word]

    subgraph Configuration
    H[.pre-commit-config.yaml] -->|references| I[codespell-ignore.txt]
    end
Loading

File-Level Changes

Change Details Files
Update the codespell pre-commit hook to use the ignore file.
  • Add the --ignore-words=./codespell-ignore.txt argument to the codespell hook.
  • Update the list of excluded file extensions to include .hrd and .pgm files.
  • Update the revision of the codespell hook to v2.3.0 and add a TODO to update to the latest version in the future because it finds a lot of spelling mistakes but fails on "assertIn".
.pre-commit-config.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @blooop - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please remove the TODO comment or update to the latest version if that's the intention
  • The codespell-ignore.txt file is missing from this PR - please include it so we can review which words are being ignored
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@blooop blooop merged commit 248af73 into main Jan 14, 2025
7 checks passed
@blooop blooop deleted the feature/codespell_ignore branch January 14, 2025 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant