-
-
Notifications
You must be signed in to change notification settings - Fork 717
feat(biome_js_analyze): align no_unused_private_class_members_with_semantic_class and dynamic prop access #7684
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
Open
vladimir-ivanov
wants to merge
4
commits into
biomejs:main
Choose a base branch
from
vladimir-ivanov:feat/no_unused_private_class_members_dynamic_prop_access
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,685
−881
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d951e0d
feat(biome_js_analyze): Improve no_unused_private_class_members to ha…
vladimir-ivanov 209a878
feat(biome_js_analyze): Improve no_unused_private_class_members to ha…
vladimir-ivanov fba354c
feat(biome_js_analyze): Improve no_unused_private_class_members to ha…
vladimir-ivanov 59dfee8
[autofix.ci] apply automated fixes
autofix-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
"@biomejs/biome": patch | ||
--- | ||
|
||
Changed [`noUnusedPrivateClassMembers`](https://biomejs.dev/linter/rules/no-unused-private-class-members/) to align more fully with meaningful reads. | ||
|
||
This rule now distinguishes more carefully between writes and reads of private class members. | ||
|
||
- A *meaningful read* is any access that affects program behavior. | ||
- For example, `this.#x += 1` both reads and writes `#x`, so it counts as usage. | ||
- Pure writes without a read (e.g. `this.#x = 1` with no getter) are no longer treated as usage. | ||
|
||
This change ensures that private members are only considered “used” when they are actually read in a way that influences execution. | ||
|
||
***Invalid examples (previously valid)*** | ||
|
||
```ts | ||
class UsedMember { | ||
set #x(value) { | ||
doSomething(value); | ||
} | ||
|
||
foo() { | ||
// This assignment does not actually read #x, because there is no getter. | ||
// Previously, this was considered a usage, but now it’s correctly flagged. | ||
this.#x = 1; | ||
} | ||
} | ||
``` | ||
|
||
***Valid example (Previously invalid)*** | ||
|
||
```js | ||
class Foo { | ||
#usedOnlyInWriteStatement = 5; | ||
|
||
method() { | ||
// This counts as a meaningful read because we both read and write the value. | ||
this.#usedOnlyInWriteStatement += 42; | ||
} | ||
} | ||
``` | ||
|
||
***Summary*** | ||
• Only accesses that read a value are considered meaningful for the purpose of this rule. | ||
• Simple assignments to a setter without a corresponding getter no longer count as usage. | ||
• Operations like +=, method calls returning a value, or reading the property for computation are considered meaningful reads. | ||
30 changes: 30 additions & 0 deletions
30
.changeset/no_unused_private_class_members_dynamic_usages.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
"@biomejs/biome": patch | ||
--- | ||
|
||
**Improved detection of used private class members** | ||
|
||
The analysis for private class members has been improved: now the tool only considers a private member “used” if it is actually referenced in the code. | ||
|
||
- Previously, some private members might have been reported as used even if they weren’t actually accessed. | ||
- With this change, only members that are truly read or called in the code are counted as used. | ||
- Members that are never accessed will now be correctly reported as unused. | ||
|
||
This makes reports about unused private members more accurate and helps you clean up truly unused code. | ||
|
||
***Example (previously valid)*** | ||
|
||
```ts | ||
type YesNo = "yes" | "no"; | ||
|
||
export class SampleYesNo { | ||
private yes: () => void; | ||
private no: () => void; | ||
private dontKnow: () => void; // <- will now report as unused | ||
|
||
on(action: YesNo): void { | ||
this[action](); | ||
} | ||
} | ||
|
||
``` |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: I feel like this is just a little too verbose for what users actually care about. Maybe others feel differently.