feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties by vladimir-ivanov · Pull Request #6297 · biomejs/biome

vladimir-ivanov · 2025-06-12T17:27:48Z

Summary

Adds a new lint useReadonlyClassProperties rule.
This rule implements ESLint's prefer-readonly rule.

Example:

class Example {
    // All properties below can be marked as readonly
    public constantValue = 42;
    protected initializedInConstructor: string;
    private privateField = true;

    constructor(initializedInConstructor: string) {
        this.initializedInConstructor = initializedInConstructor;
    }
}

collect all mutated class properties (their names in Vec)
collect all class member properties defined normally (not in constructor) -> e.g. class Test {public prop1}
collect all constructor (not marked as readonly) parameters which typescipt turns into class properties e.g. constructor(public prop1) {}
merges the class members and class properties (and excludes dups if found from constructor params)
checks the merged collection against all mutated class properties and extracts their Text and Range to be used in diagnostics and action

closes #4356

codspeed-hq · 2025-06-12T17:43:51Z

CodSpeed Performance Report

Merging #6297 will not alter performance

_{Comparing vladimir-ivanov:feat/useReadonlyClassProperties (aaf0bfd) with main (00e97ad)}

Summary

✅ 115 untouched benchmarks

vladimir-ivanov · 2025-06-13T05:35:17Z

any ideas on what to do about performance please? does it need addressing to start with?

ematipico · 2025-06-13T05:55:32Z

We recently changed the way we do benchmarks (sharding), so the benchmarks we ignored before need to be ignored again, unfortunately. That's one of them.

TLDR: no need to address the benchmark

ematipico

Thank you @vladimir-ivanov, I left some suggestions. There's a bit of rework to do, so please take your time to address the suggestions. Mainly, here's the important things to address:

Documentation: let's follow the same format we use everywhere. Use other rules to check how we do it
Doc comments: please document all internal functions, explaining what they do. Since this is a shared code base, we want to make sure to document as much know-how that we can, so the next developer won't have hard time understanding things
Tests: let's borrow the test suite from the eslint rule
Strong typed coding: let's avoid returning SyntaxNodes, and let's try to use a stricter approach, it will make the code more readable, safer and easier to use.

vladimir-ivanov · 2025-06-18T07:02:09Z

need to remove the unwrap() usages in fact, please bare with me a couple of hours

ematipico · 2025-06-18T08:24:21Z

I think the benchmarks message is the result of a bad commit, or merge resolution. In fact, there are now 333 files changed.

vladimir-ivanov · 2025-06-18T09:18:09Z

@ematipico @Conaclos please resume the review, all covered now, no more unwrap() etc. many thanks

vladimir-ivanov · 2025-06-18T09:18:38Z

Thank you @vladimir-ivanov, I left some suggestions. There's a bit of rework to do, so please take your time to address the suggestions. Mainly, here's the important things to address:

Documentation: let's follow the same format we use everywhere. Use other rules to check how we do it

Doc comments: please document all internal functions, explaining what they do. Since this is a shared code base, we want to make sure to document as much know-how that we can, so the next developer won't have hard time understanding things

Tests: let's borrow the test suite from the eslint rule

Strong typed coding: let's avoid returning SyntaxNodes, and let's try to use a stricter approach, it will make the code more readable, safer and easier to use.

hope everything is covered now here, but please shout if I missed anything

ematipico

Thank you @vladimir-ivanov. There's a comment that hasn't been addressed, I tagged you in it.

The implementation of the rule has become big. In such cases, we ask the contributors to use the PR description to explain the implementation of the code, which helps reviewers to assimilate an overview of the algorithm and how to review the PR.

There's a regression in our benchmarks, so we should take a look at it if possible.

vladimir-ivanov · 2025-06-18T17:31:34Z

Thank you @vladimir-ivanov. There's a comment that hasn't been addressed, I tagged you in it.

The implementation of the rule has become big. In such cases, we ask the contributors to use the PR description to explain the implementation of the code, which helps reviewers to assimilate an overview of the algorithm and how to review the PR.

There's a regression in our benchmarks, so we should take a look at it if possible.

please check the description at the top of this pr, and also added more details per fn description. Hope it is a bit more intuitive now? if not, please let me know, will add more :_0

vladimir-ivanov · 2025-06-18T20:11:32Z

@ematipico hope we are close to where we should be, please re check and answer my questions?

changeset-bot · 2025-06-20T11:58:31Z

🦋 Changeset detected

Latest commit: aaf0bfd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 14 packages

Name	Type
@biomejs/biome	Minor
@biomejs/cli-win32-x64	Minor
@biomejs/cli-win32-arm64	Minor
@biomejs/cli-darwin-x64	Minor
@biomejs/cli-darwin-arm64	Minor
@biomejs/cli-linux-x64	Minor
@biomejs/cli-linux-arm64	Minor
@biomejs/cli-linux-x64-musl	Minor
@biomejs/cli-linux-arm64-musl	Minor
@biomejs/wasm-web	Minor
@biomejs/wasm-bundler	Minor
@biomejs/wasm-nodejs	Minor
@biomejs/backend-jsonrpc	Patch
@biomejs/js-api	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

ematipico

Thank you @vladimir-ivanov ! I know it was a lot of work, but I hope you had fun and learned a bit more about how Biome works. (CI is failing)

vladimir-ivanov · 2025-06-20T12:26:50Z

Thank you @vladimir-ivanov ! I know it was a lot of work, but I hope you had fun and learned a bit more about how Biome works. (CI is failing)

yep, this was my graduation pr :-). Now I feel a bit more confident with what I am doing and can actually think about making things better too.

many thanks for your help.

And please merge once the build goes green? had a small issue with Empasis tag

vladimir-ivanov · 2025-06-20T19:15:20Z

can we merge this pr please?

github-actions Bot added A-CLI Area: CLI A-Project Area: project A-Linter Area: linter L-JavaScript Language: JavaScript and super languages A-Diagnostic Area: diagnostocis labels Jun 12, 2025

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch 2 times, most recently from e85d341 to 34afc91 Compare June 12, 2025 17:43

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch 2 times, most recently from 2cb99b6 to 420d2b3 Compare June 13, 2025 05:32

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch 3 times, most recently from 44d7dc0 to 7b0dce7 Compare June 13, 2025 05:53

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch from 7b0dce7 to c40ead4 Compare June 13, 2025 06:00

ematipico requested changes Jun 13, 2025

View reviewed changes

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch 8 times, most recently from c628c77 to d2440e8 Compare June 13, 2025 14:55

Conaclos reviewed Jun 13, 2025

View reviewed changes

Comment thread crates/biome_js_analyze/src/lint/nursery/use_readonly_class_properties.rs Outdated

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch 3 times, most recently from f7c4d03 to f4b89e4 Compare June 13, 2025 16:19

vladimir-ivanov commented Jun 13, 2025

View reviewed changes

Comment thread crates/biome_js_analyze/tests/specs/nursery/useReadonlyClassProperties/valid.ts Outdated

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch from b0b1c8c to e0e1925 Compare June 18, 2025 06:43

github-actions Bot added A-Formatter Area: formatter L-CSS Language: CSS and super languages labels Jun 18, 2025

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch from e0e1925 to 8c9c1ef Compare June 18, 2025 08:15

vladimir-ivanov force-pushed the feat/useReadonlyClassProperties branch 2 times, most recently from fd4435f to f590ac2 Compare June 18, 2025 08:39

github-actions Bot removed A-Project Area: project A-Linter Area: linter A-Formatter Area: formatter labels Jun 18, 2025

ematipico reviewed Jun 18, 2025

View reviewed changes

vladimir-ivanov commented Jun 18, 2025

View reviewed changes

Comment thread crates/biome_js_analyze/src/lint/nursery/use_readonly_class_properties.rs Outdated

ematipico reviewed Jun 20, 2025

View reviewed changes

Comment thread crates/biome_js_analyze/src/lint/nursery/use_readonly_class_properties.rs

ematipico approved these changes Jun 20, 2025

View reviewed changes

vladimir-ivanov added 6 commits June 20, 2025 20:26

feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties

0c78eca

feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties

65025a9

feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties

c32c710

feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties

9a834d0

feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties

da1b330

feat(biome_js_analyze): adds new lint rule useReadonlyClassProperties

aaf0bfd

github-actions Bot mentioned this pull request Jun 20, 2025

ci: release #6444

Merged

siketyan mentioned this pull request Jun 21, 2025

chore: update changeset to patch #6449

Merged

Uh oh!

Conversation

vladimir-ivanov commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

codspeed-hq Bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #6297 will not alter performance

Summary

Uh oh!

vladimir-ivanov commented Jun 13, 2025

Uh oh!

ematipico commented Jun 13, 2025

Uh oh!

ematipico left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vladimir-ivanov commented Jun 18, 2025

Uh oh!

ematipico commented Jun 18, 2025

Uh oh!

vladimir-ivanov commented Jun 18, 2025

Uh oh!

vladimir-ivanov commented Jun 18, 2025

Uh oh!

ematipico left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vladimir-ivanov commented Jun 18, 2025

Uh oh!

vladimir-ivanov commented Jun 18, 2025

Uh oh!

Uh oh!

changeset-bot Bot commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

ematipico left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladimir-ivanov commented Jun 20, 2025

Uh oh!

vladimir-ivanov commented Jun 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vladimir-ivanov commented Jun 12, 2025 •

edited

Loading

codspeed-hq Bot commented Jun 12, 2025 •

edited

Loading

changeset-bot Bot commented Jun 20, 2025 •

edited

Loading

ematipico left a comment •

edited

Loading