fix: jsx slot modelvalue can't update value

[chilingling]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: close #731

modelValue 绑定时，如果是生成 jsx，需要同时声明 onUpdate:modelValue 事件

比如：

<template>
    <!--  这里 template v-model 语法糖可以让我们省去 @update:modelValue 事件的声明 -->
	<tiny-intput v-model="state.input"></tiny-input>
</template>

但是，如果声明在 scrript 中，则为 jsx，需要为 modelValue 补充声明 onUpdate:modelValue 事件

<script setup>
	const jsxSnippet = () => (
		<div>
          <TinyInput
              modelValue={state.input}
             // 出码时，如果判断当前在生成 jsx，需要补充声明 onUpdate:modelValue 事件
              onUpdate:modelValue={(value) => (state.input = value)}
           >
          </TinyInput>
        </div>
	)
</script>

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced a new hook for handling JSX model value updates in component generation.
  • Added functionality for automatic binding of the onUpdate:modelValue event in JSX contexts.
  • Added a structured template for an editable data grid component.
  • Defined a schema for a "Page" component to enhance data representation.

• Configuration Improvements

  • Enhanced ESLint configuration with additional external linting rules for better code organization and reusability.

• Tests

  • Introduced unit tests for validating the generation of Vue Single File Components, focusing on event handling consistency.

[coderabbitai]

Walkthrough

The recent changes enhance the Vue generator's functionality by introducing a new hook for handling JSX model value updates and integrating this with the existing attribute generation process. Additionally, the ESLint configuration has been modularized for better rule management. These modifications collectively aim to refine the codebase's maintainability and responsiveness to user interactions.

Changes

Files	Change Summary
packages/vue-generator/.eslintrc.cjs	Added import for external rules and included them in the exported configuration; modified ignorePatterns for consistency.
packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js	Added handleJsxModelValueUpdate hook to defaultAttributeHook, enhancing JSX attribute handling.
packages/vue-generator/src/generator/vue/sfc/generateAttribute.js	Introduced handleJsxModelValueUpdate function to manage onUpdate:modelValue event binding in JSX, ensuring reactive updates of model values.
packages/vue-generator/test/testcases/sfc/slotModelValue/slotModel.test.js	Added a unit test to validate the generation of Vue SFCs with a focus on the onUpdate:modelValue event.

Assessment against linked issues

Objective	Addressed	Explanation
🐛 TinyGrid使用default插槽中使用tiny-input无法触发onChange事件 (Issue #731)	✅

🐰 In the fields where we play and hop,
New hooks and rules make coding a bop!
With changes so bright, our code shines anew,
Binding events, making updates true!
Happy coding in this lovely burrow,
Where every line springs joy and no sorrow! 🌼✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1ed9198 and 3d99826.

Files selected for processing (3)

• packages/vue-generator/.eslintrc.cjs (2 hunks)
• packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js (2 hunks)
• packages/vue-generator/src/generator/vue/sfc/generateAttribute.js (1 hunks)

Additional comments not posted (3)

packages/vue-generator/.eslintrc.cjs (1)

1-1: Modularize ESLint configuration.

The inclusion of external rules in the ESLint configuration enhances modularity and maintainability. The trailing comma in ignorePatterns ensures consistency.

Also applies to: 22-23

packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js (1)

22-23: Enhance JSX model value handling.

The addition of handleJsxModelValueUpdate to defaultAttributeHook enhances the handling of JSX model value updates, aligning with the PR's objectives.

Also applies to: 217-217

packages/vue-generator/src/generator/vue/sfc/generateAttribute.js (1)

518-547: Implement automatic JSX model value updates.

The handleJsxModelValueUpdate function effectively manages automatic binding for onUpdate:modelValue, ensuring proper updates in JSX contexts.

Verify the integration with existing components to ensure compatibility.

Verification successful

---

Integration of handleJsxModelValueUpdate verified in Vue SFC setup

The handleJsxModelValueUpdate function is referenced in genSetupSFC.js, indicating its integration in the Vue single file component setup process. This suggests compatibility with existing components using JSX.

• File References:
  • packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the integration of `handleJsxModelValueUpdate` with existing components.

# Test: Search for the function usage. Expect: Proper integration in components using JSX.
rg --type js --type jsx $'handleJsxModelValueUpdate'

Length of output: 79

---

Script:

#!/bin/bash
# Description: Verify the integration of `handleJsxModelValueUpdate` with existing components.

# Test: Search for the function usage. Expect: Proper integration in components using JSX.
rg --type js 'handleJsxModelValueUpdate'

Length of output: 365

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3d99826 and 028df9f.

Files selected for processing (5)

• packages/vue-generator/src/generator/vue/sfc/generateAttribute.js (1 hunks)
• packages/vue-generator/test/testcases/sfc/slotModelValue/components-map.json (1 hunks)
• packages/vue-generator/test/testcases/sfc/slotModelValue/expected/slotModelValueTest.vue (1 hunks)
• packages/vue-generator/test/testcases/sfc/slotModelValue/page.schema.json (1 hunks)
• packages/vue-generator/test/testcases/sfc/slotModelValue/slotModel.test.js (1 hunks)

Files skipped from review due to trivial changes (1)

• packages/vue-generator/test/testcases/sfc/slotModelValue/components-map.json

Files skipped from review as they are similar to previous changes (1)

• packages/vue-generator/src/generator/vue/sfc/generateAttribute.js

Additional comments not posted (3)

packages/vue-generator/test/testcases/sfc/slotModelValue/slotModel.test.js (1)

1-12: Good test structure! Verify snapshot existence.

The test is well-structured and uses snapshot testing effectively. Ensure that the snapshot file slotModelValueTest.vue exists and is up-to-date.

Verification successful

---

Snapshot file exists and is correctly referenced.

The snapshot file slotModelValueTest.vue is present at the expected location. The test setup is complete, and the snapshot testing should work as intended.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the snapshot file exists.

# Test: Check for the existence of the snapshot file.
fd 'slotModelValueTest.vue' --type f

Length of output: 125

packages/vue-generator/test/testcases/sfc/slotModelValue/expected/slotModelValueTest.vue (1)

1-95: JSX usage looks correct! Verify component imports.

The JSX syntax and usage of onUpdate:modelValue are correct and align with the PR objectives. Ensure that TinyGrid, TinyNumeric, and TinyInput are correctly imported and available in the project.

Verification successful

Let's correct the syntax error in the shell script and rerun it to verify the imports of the components.

---

Let's adjust the regex pattern to escape special characters and rerun the script to verify the imports of the components.

---

Component imports are verified and correct!

The components TinyGrid, TinyNumeric, and TinyInput are correctly imported from @opentiny/vue in the file slotModelValueTest.vue. Everything is set up as expected.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the components are correctly imported.

# Test: Check for the import statements of the components.
rg --type js 'import { Grid as TinyGrid, Numeric as TinyNumeric, Input as TinyInput } from \'@opentiny/vue\''

Length of output: 93

---

Script:

#!/bin/bash
# Description: Verify that the components are correctly imported.

# Test: Check for the import statements of the components.
rg --type js "import { Grid as TinyGrid, Numeric as TinyNumeric, Input as TinyInput } from '@opentiny/vue'"

Length of output: 299

---

Script:

#!/bin/bash
# Description: Verify that the components are correctly imported.

# Test: Check for the import statements of the components.
rg --type js "import \{ Grid as TinyGrid, Numeric as TinyNumeric, Input as TinyInput \} from '@opentiny/vue'"

Length of output: 299

packages/vue-generator/test/testcases/sfc/slotModelValue/page.schema.json (1)

1-150: Schema structure is detailed and correct! Verify method bindings.

The JSON schema is well-structured and aligns with the Vue component setup. Ensure that the method bindings onChangeInput and onChangeNumber are correctly implemented and used in the code.