Skip to content

feat: add setting to disable changelog popup on update #57

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

avarayr
Copy link

@avarayr avarayr commented Jun 6, 2025

🔧 Add setting to disable changelog popup and update notifications

Summary

This PR implements a new user setting to disable the automatic changelog popup and update notifications when the extension updates, addressing issue #56. The feature makes both the changelog popup and update notifications opt-in rather than automatic, providing a completely quiet update experience for users who prefer not to be disturbed by update-related notifications.

Changes Made

🆕 New Setting

  • Added cursorStats.showChangelogOnUpdate configuration setting
  • Default value: false (disabled by default to reduce distraction)
  • Type: boolean
  • Description: "Show changelog popup and update notifications when extension updates"
  • Controls: Both changelog webview AND update notification messages

🔧 Implementation Details

  1. Extension Activation (src/extension.ts)

    • Check the setting before showing changelog on extension update
    • Log appropriate messages based on user preference
  2. GitHub Service (src/services/github.ts)

    • Respect the setting for both automatic update checks and specific version displays
    • Hide both changelog popup AND update notification when disabled
    • Maintain existing functionality when setting is enabled
  3. Configuration (package.json)

    • Added the new setting to the extension's configuration schema
    • Placed logically with other extension settings

📚 Documentation Updates

  • README.md: Added the new setting to the configuration table
  • CHANGELOG.md: Documented the new feature in version 1.1.4

Behavior

When showChangelogOnUpdate is false (default):

  • ✅ No changelog popup appears on extension updates
  • ✅ No update notifications appear (completely quiet)
  • ✅ Extension updates silently in the background
  • ✅ Users can still manually view changelogs via other means

When showChangelogOnUpdate is true:

  • ✅ Maintains existing behavior
  • ✅ Changelog popup appears on updates as before
  • ✅ Update notifications are shown as before

🌍 Internationalization

  • Fully compatible with existing i18n implementation
  • ✅ All user-facing strings already translated in English, Chinese, and Korean
  • ✅ Configuration setting follows VS Code standard (not requiring translation)

🧪 Testing

  • ✅ Code compiles without errors
  • ✅ No linting issues
  • ✅ Maintains backward compatibility
  • ✅ Existing functionality preserved when setting is enabled

📋 Checklist

  • New setting added to package.json
  • Implementation respects the setting in all relevant code paths
  • Documentation updated (README + CHANGELOG)
  • Default value set to false (opt-in behavior)
  • Backward compatibility maintained
  • i18n compatibility verified
  • Code quality checks passed

🔗 Resolves

Closes #56

🎯 Impact

This change significantly improves the user experience by:

  • Providing a completely quiet update experience for users who don't want to be disturbed
  • Making all update-related notifications opt-in rather than forced behavior
  • Maintaining flexibility for users who do want to see changelogs and notifications
  • Following best practices for non-intrusive extension behavior

Users can enable the setting if they want to see changelogs and update notifications, but by default, the extension will update completely silently without any interruption to the user's workflow.

avarayr added 2 commits June 6, 2025 15:13
- Add new setting 'cursorStats.showChangelogOnUpdate' (defaults to false)
- Make changelog popup opt-in instead of automatic to reduce distraction
- Update extension activation logic to respect the setting
- Update github service to check setting before showing changelog
- Update documentation in README and CHANGELOG
- Resolves Dwtexe#56
- Make update notifications also controlled by showChangelogOnUpdate setting
- Provide completely quiet update experience by default
- Update documentation to reflect expanded scope
- Update PR description with new behavior
@Dwtexe
Copy link
Owner

Dwtexe commented Jun 6, 2025

Good idea I will review the codes when I get home thanks ❤
(Sorry to hear it distracted you 😥)

@avarayr
Copy link
Author

avarayr commented Jun 6, 2025

No problem!

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.

Please disable changelog popup on update
2 participants