Introduced typos pre-commit hook.
#490
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @jessp01, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances code quality by introducing an automated typo-checking mechanism. It integrates the typos tool as a pre-commit hook, ensuring that common spelling errors are caught early in the development cycle. A custom configuration is included to prevent typos from flagging legitimate patterns found in email headers as errors.
Highlights
- New typos pre-commit hook: Integrates the typos spell checker into the pre-commit workflow to automatically identify and fix typos before commits.
- typos configuration for email headers: A _typos.toml configuration file is added to instruct typos to ignore specific patterns in UTF-8 encoded email headers, preventing false positives.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a typos pre-commit hook, which is a valuable addition for maintaining code quality. However, I've identified two critical configuration issues that will prevent the hook from functioning correctly. The specified version for the typos hook does not exist, and the configuration file _typos.toml uses an invalid structure. My review provides specific suggestions to resolve these problems.
|
Build failed. ❌ pre-commit FAILURE in 2m 04s |
|
Build failed. ❌ pre-commit FAILURE in 2m 05s |
|
Build succeeded. ✔️ pre-commit SUCCESS in 2m 04s |
This is false (see https://github.com/packit/specfile/pull/490/files/4c5bea2c65ce9a7eddcf64344322db829c88661b#r2341657423). |
|
nforro
force-pushed
the
add-typos-pre-commit-check
branch
from
e61a595 to
bfa06da
Compare
|
Build succeeded. ✔️ pre-commit SUCCESS in 2m 11s |
|
Hi @nforro , I noticed this still wasn't merged, although you approved it and added the Cheers, |
|
regate |
|
Sorry, it seems Zuul had some issues and didn't pick it up. Let me rebase and try again. |
_typos.toml is used to discard false positives in email headers: error: `Forr` should be `For` --> tests/data/spec_no_trailing_newline/patch0.patch:2:26 | 2 | From: =?UTF-8?q?Nikola=20Forr=C3=B3?= <[email protected]> | ^^^^
error: `SOURCEN` should be `SOURCE`
╭▸ specfile/spec_parser.py:241:46
│
241 │ # source references: %SOURCEN, %{SOURCEN}, %{S:N}
╰╴ ━━━━━━━
nforro
force-pushed
the
add-typos-pre-commit-check
branch
from
bfa06da to
02f922e
Compare
|
Build succeeded. ✔️ pre-commit SUCCESS in 2m 05s |
|
regate |
|
Build succeeded (gate pipeline). ✔️ pre-commit SUCCESS in 2m 06s |
softwarefactory-project-zuul
bot
merged commit 61e261c
into
packit:main
2 participants
_typos.toml is used to discard false positives in email headers:
On the subject of pre-commit hooks, might I suggest removing https://github.com/pre-commit/mirrors-prettier?
pre-commit/mirrors-prettier was actually archived back in Apr 11, 2024.
Further, on my Rocky8 machine, with both Python 3.9 and 3.12, it kept on failing to retrieve the nodejs tar it claimed to need:
On my Debian GNU/Linux 13 (trixie) machine:
Considering that this code base is basically pure Python and we use:
I'm not sure what value
pre-commit/mirrors-prettieractually adds but if there's something it checks the other hooks do not address, I'd recommend finding a maintained alternative.