feat(lint): implement `noVueReservedProps` rule #6757

mdevils · 2025-07-07T15:41:32Z

Summary

Implementation of noVueReservedProps rule.

Includes an abstraction to work with Vue components.

What is supported:

Finding component definitions.
Collecting declarations of those components, including props, methods, computed, data.
Has logic for both normal components and setup-components.

What doesn't work:

Since there is no ability to know if the script tag has setup attribute, setup-components are not returned.
Multiple scripts per file don't work, which makes it harder to test things.
Tests are treating vue files as js files.
data() method is not yet supported, need control flow graph (work in progress).
setup() method is not yet supported, need control flow graph (work in progress).

These points don't prevent this rule from being compatible with eslint rule.

Test Plan

Tests are included.

Closes #6309

changeset-bot · 2025-07-07T15:41:36Z

🦋 Changeset detected

Latest commit: cc6e247

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

codspeed-hq · 2025-07-07T15:55:20Z

CodSpeed Performance Report

Merging #6757 will not alter performance

_{Comparing mdevils:feat/no-vue-reserved-props (cc6e247) with main (3e6ab16)}

Summary

✅ 114 untouched benchmarks

dyc3

Overall looks good, but I think there is a case you have missed (correct me if i'm wrong)

It's possible to use the composition api inside a export default {} defined component. Example: https://github.com/dyc3/opentogethertube/blob/2b680f4200d9d2e00cfd67dba4b08a0edc8f2009/client/src/views/RoomList.vue#L68

<script setup> and the compiler macros are effectively syntax sugar for this way of defining components.

crates/biome_js_analyze/tests/specs/nursery/noVueReservedProps/falidNotVue.js

crates/biome_js_analyze/src/lint/nursery/no_vue_reserved_props.rs

dyc3 · 2025-07-07T15:45:07Z

crates/biome_js_analyze/src/lint/nursery/no_vue_reserved_props.rs

+    pub NoVueReservedProps {
+        version: "next",
+        name: "noVueReservedProps",
+        language: "js",
+        recommended: false,
+        severity: Severity::Warning,
+        domains: &[RuleDomain::Vue],
+    }


is the original rule recommended by the plugin? if so, we should follow that.

Yes, it is. Changed.

crates/biome_js_analyze/src/lint/nursery/no_vue_reserved_props.rs

dyc3 · 2025-07-07T15:51:03Z

crates/biome_js_analyze/src/frameworks/vue/vue_component.rs

+pub enum VueComponent {
+    /// This is referred to as "normal script" Vue component.
+    /// <script> export default { props: [ ... ], data: { ... }, ... }; </script>
+    Normal(VueNormalComponent),
+    /// A component may be defined right in the createApp call.
+    /// createApp({ props: [ ... ], ... });
+    CreateApp(VueCreateApp),
+    /// Define Component is one of the ways to define a Vue component.
+    /// defineComponent({ props: [ ... ], ... });
+    DefineComponent(VueDefineComponent),
+    /// Setup component is a Vue 3 component that uses the Composition API.
+    /// <script setup> defineProps({ ... }); const someData = { ... }; </script>
+    /// FIXME: Remove `allow(dead_code)` when <script setup> is supported.
+    #[expect(dead_code)]
+    Setup(VueSetupComponent),
+}


nit: the code examples should go in markdown code blocks

crates/biome_js_analyze/src/frameworks/vue/vue_component.rs

mdevils · 2025-07-07T16:18:08Z

Overall looks good, but I think there is a case you have missed (correct me if i'm wrong)

It's possible to use the composition api inside a export default {} defined component. Example: https://github.com/dyc3/opentogethertube/blob/2b680f4200d9d2e00cfd67dba4b08a0edc8f2009/client/src/views/RoomList.vue#L68

<script setup> and the compiler macros are effectively syntax sugar for this way of defining components.

@dyc3 Thanks for reminding, I know about this case. I just need control flow for that to work. Working on it in order to support both setup() and data().

mdevils · 2025-07-09T11:30:39Z

@dyc3 I believe I've addressed all the issues.

Also:

Commented out some setup-related code until we have ability to parse "<script setup>" properly.
Split tests into multiple files with 1 script per file.
Added many comments and docs.
Simplified some code and removed what was not needed.
Added data_declarations_container to be used in feat(biome_js_analyze): noVueDataObjectDeclaration #6574.
Removed v2 reserved names, kept v3 only.

dyc3

Looking good!

dyc3 · 2025-07-09T11:55:18Z

.changeset/lovely-moments-join.md

+"@biomejs/biome": minor
+---
+
+Added the rule [`noVueReservedProps`](https://biomejs.dev/linter/rules/no-vue-reserved-props/).


nit: Link to the issue

crates/biome_js_analyze/src/frameworks/vue/vue_call.rs

Co-authored-by: Carson McManus <dyc3@users.noreply.github.com>

feat(lint): implement noVueReservedProps rule

6837b28

github-actions bot added A-Linter Area: linter A-Parser Area: parser L-JavaScript Language: JavaScript and super languages A-Diagnostic Area: diagnostocis labels Jul 7, 2025

dyc3 self-requested a review July 7, 2025 15:48

dyc3 reviewed Jul 7, 2025

View reviewed changes

dyc3 added the D-Vue Domains: Vue label Jul 7, 2025

chore: finalize work in the rule

af2a6c9

mdevils requested a review from dyc3 July 9, 2025 11:27

github-actions bot added A-CLI Area: CLI A-Project Area: project labels Jul 9, 2025

mdevils marked this pull request as ready for review July 9, 2025 11:39

dyc3 mentioned this pull request Jul 9, 2025

feat(biome_js_analyze): noVueDataObjectDeclaration #6574

Open

dyc3 approved these changes Jul 9, 2025

View reviewed changes

mdevils and others added 2 commits July 9, 2025 14:41

docs: better is_vue_compiler_macro_call description

4b3a99c

Co-authored-by: Carson McManus <dyc3@users.noreply.github.com>

docs: include issue link to the changeset.

cc6e247

mdevils merged commit 13a0818 into biomejs:main Jul 9, 2025
31 checks passed

github-actions bot mentioned this pull request Jul 9, 2025

ci: release #6807

Merged

Uh oh!

feat(lint): implement noVueReservedProps rule #6757

feat(lint): implement noVueReservedProps rule #6757

Uh oh!

Conversation

mdevils commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

codspeed-hq bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #6757 will not alter performance

Summary

Uh oh!

dyc3 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!

Uh oh!

Uh oh!

dyc3 Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

mdevils Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dyc3 Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

mdevils Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mdevils commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mdevils commented Jul 9, 2025

Uh oh!

dyc3 left a comment

Choose a reason for hiding this comment

Uh oh!

dyc3 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

mdevils Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat(lint): implement `noVueReservedProps` rule #6757

feat(lint): implement `noVueReservedProps` rule #6757

mdevils commented Jul 7, 2025 •

edited

Loading

changeset-bot bot commented Jul 7, 2025 •

edited

Loading

codspeed-hq bot commented Jul 7, 2025 •

edited

Loading

dyc3 left a comment •

edited

Loading

mdevils commented Jul 7, 2025 •

edited

Loading