Ruff changes, expand pre-commit hooks to checkPot and unit tests
Link to issue number:
Fix up for #16751
Summary of the issue:
Ruff recently updated in the past 24 hours, so we might as well use the latest version.
Additionally a warning is omitted for the section we added logger-objects to in config.
Additionally, it was unclear in docs how to avoid pre-commit hooks from triggering
Summary of other changes:
- Added pre commit hooks for unit tests and translation comment checks.
- change the output of rununittests.bat to have simpler buffer output, only show failures. Ensure the verbose log is logged in AppVeyor.
- Added generic pre-commit hooks for python static syntax checking, basic whitespace rules, and file write safety checks
Summary by CodeRabbit
-
Chores
- Updated the
ruff-pre-commitlinter hook configuration to versionv0.5.0.
- Updated the
-
Documentation
- Added instructions on how to bypass pre-commit hooks using the
--no-verifyoption.
- Added instructions on how to bypass pre-commit hooks using the
-
Refactor
- Adjusted logger object configuration in
pyproject.toml.
- Adjusted logger object configuration in
Walkthrough
The recent update primarily deals with enhancing linters and documentation within the project. Specifically, the ruff-pre-commit hook has been upgraded from version v0.4.10 to v0.5.0, and documentation now includes instructions for bypassing pre-commit hooks. Additionally, the pyproject.toml file underwent a minor revision where the logger-objects configuration was briefly removed and then restored.
Changes
| Files | Change Summary |
|---|---|
| .pre-commit-config.yaml | Updated revision of ruff-pre-commit repository from v0.4.10 to v0.5.0. |
| projectDocs/dev/lint.md | Added instructions on using --no-verify to avoid triggering pre-commit hooks, including an example. |
| pyproject.toml | Removed and re-added logger-objects = ["logHandler.log"] at the end of the file. |
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>. -
Generate unit testing code for this file. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai generate unit testing code for this file. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai generate interesting stats about this repository and render them as a table. -
@coderabbitai show all the console.log statements in this repository. -
@coderabbitai read src/utils.ts and generate unit testing code. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -
@coderabbitai help me debug CodeRabbit configuration file.
-
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (invoked as PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
- PASS: Translation comments check.
- PASS: License check.
- PASS: Unit tests.
- FAIL: Lint check. See test results for more information.
- PASS: System tests (tags: installer NVDA).
- Build (for testing PR): https://ci.appveyor.com/api/buildjobs/q1ltrwu66wog9i25/artifacts/output/nvda_snapshot_pr16767-32727,9b142c36.exe
- CI timing (mins): INIT 0.0, INSTALL_START 1.2, INSTALL_END 1.0, BUILD_START 0.0, BUILD_END 11.0, TESTSETUP_START 0.0, TESTSETUP_END 0.3, TEST_START 0.0, TEST_END 18.0, FINISH_END 0.1
See test results for failed build of commit 9b142c3627
- PASS: Translation comments check.
- PASS: License check.
- PASS: Unit tests.
- FAIL: Lint check. See test results and lint artifacts for more information.
- PASS: System tests (tags: installer NVDA).
- Build (for testing PR): https://ci.appveyor.com/api/buildjobs/uu4st9a0jvopnasx/artifacts/output/nvda_snapshot_pr16767-32733,d49215a8.exe
- CI timing (mins): INIT 0.0, INSTALL_START 1.2, INSTALL_END 1.0, BUILD_START 0.0, BUILD_END 11.7, TESTSETUP_START 0.0, TESTSETUP_END 0.3, TEST_START 0.0, TEST_END 18.3, FINISH_END 0.2
See test results for failed build of commit d49215a8c0