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

feat: add setting for showing linting fixes #262

Merged
merged 3 commits into from
Jan 23, 2025

Conversation

Hellebore
Copy link
Contributor

@Hellebore Hellebore commented Jan 21, 2025

Checklist

  • If package.json or yarn.lock have changed, then test the VSIX built by yarn run vsce package works from a direct install

Summary by Sourcery

New Features:

  • Add a user setting to show linting fixes for all problems.

Copy link
Contributor

sourcery-ai bot commented Jan 21, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new setting to control the display of linting fixes, and passes this setting to the language server.

Sequence diagram for language server initialization with new linting setting

sequenceDiagram
    participant Extension
    participant Workspace
    participant LanguageClient
    Extension->>Workspace: getConfiguration('sourcery')
    Workspace-->>Extension: configuration
    Extension->>Extension: get<boolean>('lintingFixes')
    Extension->>LanguageClient: initialize with show_linting_fixes
    Note right of LanguageClient: New setting passed to server
Loading

Class diagram showing updated configuration settings

classDiagram
    class SourceryConfiguration {
        +boolean codeLens
        +boolean lintingFixes
        +boolean ruleType.refactorings
    }
    note for SourceryConfiguration "New lintingFixes setting added"
Loading

File-Level Changes

Change Details Files
Added a new setting to control the display of linting fixes.
  • Added the sourcery.lintingFixes setting to the package.json file with a default value of true and a description of 'Show linting fixes for all problems.'
package.json
Pass the new setting to the language server.
  • Read the sourcery.lintingFixes setting from the workspace configuration.
  • Pass the show_linting_fixes setting to the language server during initialization
src/extension.ts

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
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 @Hellebore - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please verify and check off the PR checklist item about testing the VSIX package installation, since package.json was modified.
Here's what I looked at during the review
  • 🟢 Functionality: all looks good
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Review instructions: 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 ✨

LangSmith trace

Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Hellebore Hellebore merged commit bc0ae0b into main Jan 23, 2025
1 check passed
@Hellebore Hellebore deleted the nick/feat/show-linting-settings branch January 23, 2025 16:52
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