Skip to content

Improve ruff lint rules, indented functions and scons inbuilts#16804

Merged
seanbudd merged 4 commits intomasterfrom
ruffFixes
Jul 4, 2024
Merged

Improve ruff lint rules, indented functions and scons inbuilts#16804
seanbudd merged 4 commits intomasterfrom
ruffFixes

Conversation

@seanbudd
Copy link
Copy Markdown
Member

@seanbudd seanbudd commented Jul 3, 2024 •
edited
Loading

Link to issue number:

Closes #11905
Follow up to #16767

Summary of the issue:

scons files have a lot of inbuilt functions that the linter doesn't recognize. See also #11905

Ruff preserves indent/new-line formatting of function arguments, list items, and similar iterables, if a trailing comma is added.
Much of NVDA is missing these trailing commas causing the lint to collapse them.

Description of user facing changes

Description of development approach

A lint rule has been added to ignore F821 errors in scons files.

A pre-commit hook is added, which adds a trailing comma to python in case it was missed.

Testing strategy:

Tested running ruff commands on the code base

Known issues with pull request:

N/A

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • Chores
    • Updated project configuration for enhanced linting and formatting, including new rules and ignores for specific file types.

@seanbudd seanbudd requested a review from a team as a code owner July 3, 2024 06:45
@seanbudd seanbudd requested a review from gerald-hartig July 3, 2024 06:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 3, 2024 •
edited
Loading

Walkthrough

Recent updates to the pyproject.toml file focus on improving code linting and formatting. Key changes include the addition of the skip-magic-trailing-comma setting and specific lint ignore configurations for sconstruct and sconscript files. These changes aim to address undefined names errors in these scripts, enabling consistent coding style enforcement through the Linter.

Changes

Files Change Summary
pyproject.toml Added skip-magic-trailing-comma under [tool.ruff.format] and configured per-file lint ignores for sconstruct and sconscript.

Assessment against linked issues

Objective Addressed Explanation
Decide on a way of dealing with undefined names errors in sconstruct files (#11905) ✅
Document and re-enable Linter for sconstruct files (#11905) ✅

The changes successfully address the objectives by implementing lint configurations that handle undefined names errors in sconstruct and sconscript files, thereby ensuring consistent linting and coding styles.

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?

Share
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 @coderabbitai in 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 @coderabbitai in 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 pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to 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.yaml file 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.

@seanbudd seanbudd requested a review from LeonarddeR July 3, 2024 06:46
@seanbudd seanbudd mentioned this pull request Jul 3, 2024
Merged
5 tasks
@LeonarddeR
Copy link
Copy Markdown
Collaborator

LeonarddeR commented Jul 3, 2024 •
edited
Loading

A format rule has been added to preserve indentation of items separated by commas and newlines, rather than wrapping to a single line.

I'm afraid you reading the docs for skip-magic-trailing-comma the other way around.
The comment in the docs below skip-magic-trailing-comma = true changes the formatting to: is wrong. It should be something like:

# The arguments will be on a single line because of ignoring the trailing comma after b

@LeonarddeR
Copy link
Copy Markdown
Collaborator

LeonarddeR commented Jul 3, 2024

See astral-sh/ruff#9809 (comment)

@AppVeyorBot
Copy link
Copy Markdown

AppVeyorBot commented Jul 3, 2024

See test results for failed build of commit d10fc305a1

seanbudd
seanbudd commented Jul 4, 2024
View reviewed changes
@seanbudd seanbudd merged commit e7ecce0 into master Jul 4, 2024
@seanbudd seanbudd deleted the ruffFixes branch July 4, 2024 03:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gerald-hartig gerald-hartig Awaiting requested review from gerald-hartig gerald-hartig is a code owner automatically assigned from nvaccess/developers

@LeonarddeR LeonarddeR Awaiting requested review from LeonarddeR

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Decide on a way of dealing with undefined names errors in Sconscripts, document it and re-enable Linter for them

3 participants

@seanbudd @LeonarddeR @AppVeyorBot