Skip to content

Conversation

@AlphaLawless
Copy link
Contributor

@AlphaLawless AlphaLawless commented Nov 23, 2025

✍️ Description

This PR implements a script disable system that allows scripts to be temporarily disabled while remaining visible in the interface with clear explanations. Instead of removing scripts entirely when issues arise, they now display a prominent disabled state with contextual information about why they're unavailable and links to related discussions or fixes.

Key Features:

  • Scripts can be marked as disable: true with a required disable_description explaining the reason
  • Disabled scripts show a styled alert banner with the description (supporting URLs and code blocks)
  • Installation section is hidden for disabled scripts
  • Sidebar displays a "Disabled" badge with reduced opacity for easy identification
  • JSON editor includes toggle and description field for easy management
  • Includes example implementation with opnsense-vm.json

Problem Solved:
Previously, problematic scripts were removed entirely, causing confusion for users trying to find them. This new system keeps scripts discoverable while clearly communicating their status, enabling community contributions toward fixes and maintaining transparency about known issues.

Screenshots

Dark Mode image
Light Mode image

🔗 Related PR / Issue

Link: #6183

✅ Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing functionality in a way that may require updates.
  • 🆕 New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.
- Add disable and disable_description optional fields to Script type - Implement validation: disable_description required when disable=true - Create DisableDescription component with AlertColors styling - Add TextParseLinks utility to parse URLs and code blocks in descriptions - Hide installation section when script is disabled - Display disabled badge in sidebar with reduced opacity - Update JSON editor with disable toggle and description field - Add opnsense-vm.json with disable example and GitHub issue reference
@AlphaLawless AlphaLawless requested a review from a team as a code owner November 23, 2025 01:57
@github-actions github-actions bot added feature json website A change to the website labels Nov 23, 2025
@AlphaLawless AlphaLawless changed the title feat: add script disable functionality with visual indicators feat(frontend): add script disable functionality with visual indicators Nov 23, 2025
@michelroegl-brunner michelroegl-brunner merged commit 72a3901 into community-scripts:main Nov 23, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature json website A change to the website

4 participants