Skip to content
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

docs(playground): playground only supply latest 3 version #2488

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Nov 5, 2024

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
    • Introduced a notification system to inform users about available versions and allow them to mute notifications.
    • Added functionality to determine the latest application version based on preview mode.
  • Improvements
    • Updated versioning system to reflect the latest version and reduced the displayed version history.
    • Simplified logic for retrieving runtime URLs and managing version checks.

Copy link

coderabbitai bot commented Nov 5, 2024

Walkthrough

The changes in this pull request focus on the App.vue file, enhancing the version management and notification system of the application. Key updates include transitioning to JSX syntax, updating the version constant and the versions array, and introducing new functions for version retrieval and notification management. The logic for determining the latest version has been encapsulated in the new getVersion function, while the showNotify function manages user notifications. Additionally, the tiny-select component is modified to trigger notifications upon interaction.

Changes

File Change Summary
examples/sites/playground/App.vue - Added getVersion and showNotify functions.
- Updated version constant to 'tiny-vue-version-3.19'.
- Reduced versions array to the latest three versions.
- Simplified getRuntime function.
- Modified tiny-select to include @click="showNotify" event.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • zzcr

Poem

🐇 In the meadow where versions play,
A new update hops in today.
With notifications bright and clear,
The latest version's finally here!
So click and see, don't delay,
A joyful change in every way! 🌼


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
🪧 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 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.

Copy link

github-actions bot commented Nov 5, 2024

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
examples/sites/playground/App.vue (1)

43-65: Enhance notification accessibility and consistency

Consider the following improvements:

  1. Add ARIA labels for better accessibility
  2. Consider internationalizing the messages for consistency

Apply this diff to enhance the notification:

 notify = Notify({
   type: 'info',
-  title: '温馨提示:',
+  title: 'Notice:',
   message: () => (
     <div>
-      <div>演练场仅保留最新的三个版本可选。</div>
+      <div role="alert" aria-live="polite">
+        Only the latest three versions are available in the playground.
+      </div>
       <div style="text-align: right;margin-top: 12px;">
         <TinyButton onClick={muteNotify} type={'primary'}>
-          不再提示
+          Don't show again
         </TinyButton>
       </div>
     </div>
   ),
   duration: -1,
   position: 'top-right',
   verticalOffset: 200
 })
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dce3b6e and d0c0cc7.

📒 Files selected for processing (1)
  • examples/sites/playground/App.vue (4 hunks)
🧰 Additional context used
🪛 eslint
examples/sites/playground/App.vue

[error] 87-88: Replace ⏎······@opentiny/vue-design-${tinyTheme}with@opentiny/vue-design-${tinyTheme}]·=

(prettier/prettier)


[error] 89-89: Replace ]·= with ·

(prettier/prettier)

🔇 Additional comments (1)
examples/sites/playground/App.vue (1)

307-313: LGTM! Version selection implementation looks good

The tiny-select component correctly:

  • Disables version selection in preview mode
  • Shows notification about version limitations
  • Handles version changes appropriately

Comment on lines +27 to +35
const getVersion = () => {
if (isPreview) {
return versions[0]
}
if (versions.includes(localStorage.getItem(VERSION))) {
localStorage.getItem(VERSION)
}
return versions[0]
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix logical error in getVersion function

The function has a bug in the conditional block that checks localStorage value. The return statement is missing, causing the function to always return versions[0].

Apply this diff to fix the logic:

 const getVersion = () => {
   if (isPreview) {
     return versions[0]
   }
-  if (versions.includes(localStorage.getItem(VERSION))) {
-    localStorage.getItem(VERSION)
+  const storedVersion = localStorage.getItem(VERSION)
+  if (versions.includes(storedVersion)) {
+    return storedVersion
   }
   return versions[0]
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const getVersion = () => {
if (isPreview) {
return versions[0]
}
if (versions.includes(localStorage.getItem(VERSION))) {
localStorage.getItem(VERSION)
}
return versions[0]
}
const getVersion = () => {
if (isPreview) {
return versions[0]
}
const storedVersion = localStorage.getItem(VERSION)
if (versions.includes(storedVersion)) {
return storedVersion
}
return versions[0]
}

Comment on lines +87 to +89
imports[
`@opentiny/vue-design-${tinyTheme}`
] = `${cdnHost}/@opentiny/vue-design-${tinyTheme}${versionDelimiter}${version}/${fileDelimiter}index.js`
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix template literal formatting

The current formatting of the imports object key causes ESLint errors.

Apply this diff to fix the formatting:

-    imports[
-      `@opentiny/vue-design-${tinyTheme}`
-    ] = `${cdnHost}/@opentiny/vue-design-${tinyTheme}${versionDelimiter}${version}/${fileDelimiter}index.js`
+    imports[`@opentiny/vue-design-${tinyTheme}`] = `${cdnHost}/@opentiny/vue-design-${tinyTheme}${versionDelimiter}${version}/${fileDelimiter}index.js`
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
imports[
`@opentiny/vue-design-${tinyTheme}`
] = `${cdnHost}/@opentiny/vue-design-${tinyTheme}${versionDelimiter}${version}/${fileDelimiter}index.js`
imports[`@opentiny/vue-design-${tinyTheme}`] = `${cdnHost}/@opentiny/vue-design-${tinyTheme}${versionDelimiter}${version}/${fileDelimiter}index.js`
🧰 Tools
🪛 eslint

[error] 87-88: Replace ⏎······@opentiny/vue-design-${tinyTheme}with@opentiny/vue-design-${tinyTheme}]·=

(prettier/prettier)


[error] 89-89: Replace ]·= with ·

(prettier/prettier)

@zzcr zzcr merged commit 1afb7ee into release-3.19.0 Nov 6, 2024
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants