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

Provide more specific error message for StrictUsedVariable check based on unused variable type #2835

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

IlanaRadinsky
Copy link

@IlanaRadinsky IlanaRadinsky commented Aug 13, 2024

Fixes #2361

Before this PR

Turns out this was just a confusing error message. Previously, a code snippet like

public class Test {
    private final String myField;

    public Test(String myField) {
        this.myField = myField;
    }
}

would result in an error message

error: [StrictUnusedVariable] The field 'field' is never read. Intentional occurrences are acknowledged by renaming the unused variable with a leading underscore. '_field', for example.
  private String field;
                 ^
    (see https://github.com/palantir/gradle-baseline#baseline-error-prone-checks)
  Did you mean to remove this line?

If you applied the fix from the error message, checks would fail because the field is read but has 'StrictUnusedVariable' suppressed because of its name (prefixed with an underscore).

But really, the correct fix is suggested below the code snippet/link - to remove the field (Did you mean to remove this line?).

After this PR

==COMMIT_MSG==
Provide more specific error message for StrictUsedVariable check based on unused variable type
==COMMIT_MSG==

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Aug 13, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Provide more specific error message for StrictUsedVariable check based on unused variable type

Check the box to generate changelog(s)

  • Generate changelog entry

@IlanaRadinsky IlanaRadinsky force-pushed the ir/strict-unused-variable-error-message branch from dd6bf76 to 8b6b337 Compare August 13, 2024 19:02
}
} else {
fixes = buildUnusedVarFixes(symbol, allUsageSites, state);
reportUnusedAssignment(symbol, unused, specs, allUsageSites, state);
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only reports a match if the var is a local var, so no need to do it for all vars (including parameters) as we were before.

@IlanaRadinsky IlanaRadinsky marked this pull request as ready for review August 13, 2024 19:11
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.

StrictUnusedVariable check should suggest removing variables assigned in constructor but never read
2 participants