Skip to content

feat: [file-upload] Add file names to restricted prompt texts #3171

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

Merged
merged 1 commit into from
Mar 25, 2025

Conversation

chenxi-20
Copy link
Collaborator

@chenxi-20 chenxi-20 commented Mar 24, 2025

image

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)

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:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Enhanced file upload error messages to now include the file name along with size limits, helping users quickly identify which file triggered the validation error.
    • Updated messages consistently across multiple languages for improved clarity during file uploads.

@chenxi-20 chenxi-20 added the enhancement New feature or request (功能增强) label Mar 24, 2025
Copy link

coderabbitai bot commented Mar 24, 2025

Walkthrough

This update revises error messages in file upload validations. The properFileSize function now includes the file name in its modal messages when file size limits are not met. Localization files for English, Spanish (LA), Portuguese (BR), and Chinese now also incorporate the {fileName} placeholder in their error strings.

Changes

File(s) Summary of Changes
packages/renderless/.../file-upload/index.ts Modified the properFileSize function to include fileName in error messages for both exceeding maximum and sub-minimum file sizes.
packages/vue-locale/.../lang/{en, es-LA, pt-BR, zh-CN}.ts Updated error messages in the fileUpload sections to prepend the {fileName} placeholder to messages for file size limits.

Possibly related PRs

Suggested reviewers

  • zzcr

Poem

I’m a rabbit hopping in the code,
Adding file names along the upload road,
Clear error messages now take the stage,
Guiding users on the file size page,
With every line, a little cheer—
CodeRabbit smiles, bringing joy near!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/renderless/src/file-upload/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue-locale/src/lang/zh-CN.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue-locale/src/lang/en.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 2 others

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffdd027 and c637356.

📒 Files selected for processing (5)
  • packages/renderless/src/file-upload/index.ts (2 hunks)
  • packages/vue-locale/src/lang/en.ts (1 hunks)
  • packages/vue-locale/src/lang/es-LA.ts (1 hunks)
  • packages/vue-locale/src/lang/pt-BR.ts (1 hunks)
  • packages/vue-locale/src/lang/zh-CN.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (10)
packages/vue-locale/src/lang/pt-BR.ts (2)

286-286: Added file name to error message for better context.

The addition of the {fileName} placeholder at the beginning of this error message improves user experience by clearly identifying which specific file has exceeded the size limit.


288-288: Added file name to minimum file size error message.

Including the {fileName} placeholder in this error message provides better context to users when a file is smaller than the minimum required size, making it clear which specific file is causing the validation error.

packages/vue-locale/src/lang/es-LA.ts (2)

286-286: Added file name to maximum size error message for Spanish locale.

The inclusion of the {fileName} placeholder at the beginning of this Spanish error message improves user experience by identifying which file exceeds the size limit, maintaining consistency with other language implementations.


288-288: Added file name to minimum size error message for Spanish locale.

The addition of the {fileName} placeholder enhances the error message by clearly identifying which file is smaller than the required minimum size, improving error context for Spanish-speaking users.

packages/vue-locale/src/lang/zh-CN.ts (2)

286-286: Added file name to maximum size error message for Chinese locale.

The inclusion of {fileName} at the beginning of this Chinese error message improves user experience by specifically identifying which file exceeds the maximum size limit, following the same pattern as other language implementations.


288-288: Added file name to minimum size error message for Chinese locale.

The addition of the {fileName} placeholder enhances the error message by clearly identifying which file fails to meet the minimum size requirement, improving the clarity of validation feedback for Chinese-speaking users.

packages/renderless/src/file-upload/index.ts (2)

383-387: Improved error message clarity by including file name.

The addition of the fileName parameter to the error message makes it clearer which specific file exceeds the maximum size limit, enhancing user experience.


408-408: Enhanced error message with file name for minimum size restriction.

Including the file name in the error message for minimum size restriction improves clarity, helping users identify which specific file is too small.

packages/vue-locale/src/lang/en.ts (2)

286-286: Enhanced max size error message with file name context.

Adding the {fileName} placeholder to the beginning of the exceed error message improves user experience by clearly identifying which file has the issue.


288-288: Improved min size error message with file name.

Adding the {fileName} placeholder to the beginning of the fileSize error message provides better context to users about which specific file is too small.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added the bug Something isn't working label Mar 24, 2025
Copy link

Walkthrough

This pull request enhances the file upload feature by adding file names to the restricted prompt texts. This change aims to provide more informative messages when file size restrictions are exceeded or not met, improving user feedback.

Changes

Files Changed Summary
packages/renderless/src/file-upload/index.ts Updated to include file names in the warning messages for file size restrictions.
packages/vue-locale/src/lang/en.ts
packages/vue-locale/src/lang/es-LA.ts
packages/vue-locale/src/lang/pt-BR.ts
packages/vue-locale/src/lang/zh-CN.ts
Localization files updated to include file names in the prompt texts for size restrictions in multiple languages.

@@ -381,7 +381,10 @@ export const properFileSize =
if (state.isEdm || (Array.isArray(props.fileSize) && props.fileSize[1])) {
if (!isNaN(Number(maxSize)) && file.size > maxSize * 1024 * 1024) {
Modal.message({
message: t(constants.EDM.EXCEED, { maxSize: api.formatFileSize(Number(maxSize * 1024 * 1024)) }),
message: t(constants.EDM.EXCEED, {

Choose a reason for hiding this comment

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

Ensure that the fileName property is correctly populated and sanitized to prevent any potential security issues, such as script injection, when displaying file names in messages.

@zzcr zzcr merged commit 9cf817a into dev Mar 25, 2025
14 of 16 checks passed
@kagol kagol removed the bug Something isn't working label Mar 31, 2025
@kagol kagol deleted the feat/file-upload-tip-20250324 branch April 14, 2025 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request (功能增强)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants