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

ci: Automatically check for typos #2855

Merged
merged 1 commit into from
Jan 31, 2025
Merged

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Jan 31, 2025

Summary by Sourcery

Fix typos across the codebase, documentation, and configuration files.

Enhancements:

  • Improve the clarity and correctness of documentation and comments in singer_sdk/helpers/capabilities.py, singer_sdk/connectors/sql.py, singer_sdk/contrib/filesystem/stream.py, singer_sdk/mapper.py, singer_sdk/plugin_base.py, singer_sdk/sinks/sql.py, and tests/core/test_streams.py.

CI:

  • Add a Codespell pre-commit hook to automatically check for typos.

Documentation:

  • Correct typos in various documentation files, including CONTRIBUTING.md, dev_guide.md, implementation/at_least_once.md, implementation/cli.md, partitioning.md, and stream_maps.md.

📚 Documentation preview 📚: https://meltano-sdk--2855.org.readthedocs.build/en/2855/

@edgarrmondragon edgarrmondragon requested review from a team and tayloramurphy as code owners January 31, 2025 14:22
Copy link
Contributor

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request introduces a pre-commit hook that automatically checks for typos in the codebase. It also updates the pre-commit configuration to use Python 3.13 and adds a codespell configuration to ignore certain files and words.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a codespell pre-commit hook to automatically check for typos.
  • Added a new codespell hook to the pre-commit configuration.
  • Added a codespell configuration to the pyproject.toml file to ignore certain files and words.
.pre-commit-config.yaml
pyproject.toml
Updated the pre-commit configuration to use Python 3.13.
  • Set the default language version for Python to 3.13 in the pre-commit configuration.
.pre-commit-config.yaml
Fixed typos in documentation and changelog files.
  • Corrected spelling of 'available' in CHANGELOG.md.
  • Corrected spelling of 'knowledge' in docs/implementation/at_least_once.md.
  • Corrected spelling of 'simpleeval' in docs/stream_maps.md.
  • Corrected spelling of 'additional' in singer_sdk/helpers/capabilities.py.
  • Corrected spelling of 'against' in docs/CONTRIBUTING.md.
  • Corrected spelling of 'The' in docs/dev_guide.md.
  • Corrected spelling of 'omitted' in docs/implementation/cli.md.
  • Corrected spelling of 'Implementation' in docs/partitioning.md.
  • Corrected spelling of 'split' in singer_sdk/connectors/sql.py.
  • Corrected spelling of 'filesystem' in singer_sdk/contrib/filesystem/stream.py.
  • Corrected spelling of 'transformer' in singer_sdk/mapper.py.
  • Corrected spelling of 'order' in singer_sdk/plugin_base.py.
  • Corrected spelling of 'schema' in singer_sdk/sinks/sql.py.
  • Corrected spelling of 'relation' in tests/core/test_streams.py.
CHANGELOG.md
docs/implementation/at_least_once.md
docs/stream_maps.md
singer_sdk/helpers/capabilities.py
docs/CONTRIBUTING.md
docs/dev_guide.md
docs/implementation/cli.md
docs/partitioning.md
singer_sdk/connectors/sql.py
singer_sdk/contrib/filesystem/stream.py
singer_sdk/mapper.py
singer_sdk/plugin_base.py
singer_sdk/sinks/sql.py
tests/core/test_streams.py

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@edgarrmondragon edgarrmondragon self-assigned this Jan 31, 2025
Copy link
Contributor

@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 @edgarrmondragon - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 8 issues found
  • 🟢 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.

.pre-commit-config.yaml Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
docs/implementation/at_least_once.md Show resolved Hide resolved
docs/stream_maps.md Show resolved Hide resolved
docs/CONTRIBUTING.md Show resolved Hide resolved
docs/dev_guide.md Show resolved Hide resolved
docs/implementation/cli.md Show resolved Hide resolved
docs/partitioning.md Show resolved Hide resolved
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.34%. Comparing base (2d566b8) to head (6d505bb).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2855   +/-   ##
=======================================
  Coverage   91.34%   91.34%           
=======================================
  Files          62       62           
  Lines        5209     5209           
  Branches      673      673           
=======================================
  Hits         4758     4758           
  Misses        319      319           
  Partials      132      132           

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

@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/chore/typos branch from 3ab235e to 6d505bb Compare January 31, 2025 14:24
Copy link

codspeed-hq bot commented Jan 31, 2025

CodSpeed Performance Report

Merging #2855 will not alter performance

Comparing edgarrmondragon/chore/typos (6d505bb) with main (2d566b8)

Summary

✅ 7 untouched benchmarks

@edgarrmondragon edgarrmondragon merged commit 7314a78 into main Jan 31, 2025
35 of 36 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/chore/typos branch January 31, 2025 14:28
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