Prompt file imported from ruaan-deysel/ha-unraid-management-agent (.github/prompts/Add Config Option.prompt.md). Copyright stays with the author.

Add Config Option

Name: Add Config Option
Author: ruaan-deysel

Your goal is to add a new configuration option to the config flow (setup or options flow).

If not provided, ask for:

Option name and purpose
Data type (string, int, float, bool, selector)
Where to add (initial setup or options flow)
Default value (if applicable)
Validation requirements

Requirements

Schema Definition:

Add to appropriate schema in config_flow.py
Use voluptuous validators from homeassistant.helpers.config_validation as cv
Use selectors for better UI (BooleanSelector, NumberSelector, etc.)
Set appropriate default values with vol.Optional()

Config Flow Logic:

Update flow step in config_flow.py
Handle new field in async_step_user() or options flow
Validate input if needed
Store value in config_entry.data or config_entry.options

Using the Option:

Access via entry.data[CONF_OPTION_KEY] or entry.options.get(CONF_OPTION_KEY)
Pass to coordinator if needed for data fetching
Update entity behavior based on option value

Translations:

Add label to translations/en.json under config.step.[step_name].data
Add helper text under data_description
Add error messages under config.error.[error_key]

Constants:

Add constant to const.py: CONF_[OPTION_NAME]
Document purpose with inline comment

Migration (if changing existing config):

Increment VERSION in config flow handler
Implement async_migrate_entry() if needed
Handle both old and new format for backwards compatibility

Code Quality:

Follow existing config flow patterns in config_flow.py
Use proper selector types for best UX
Run script/lint to validate before completion

Related Files:

Config Flow: custom_components/unraid_management_agent/config_flow.py
Constants: custom_components/unraid_management_agent/const.py
Translations: custom_components/unraid_management_agent/translations/en.json

DO NOT create tests unless explicitly requested.

# Add Config Option Your goal is to add a new configuration option to the config flow (setup or options flow). If not provided, ask for: - Option name and purpose - Data type (string, int, float, bool, selector) - Where to add (initial setup or options flow) - Default value (if applicable) - Validation requirements ## Requirements **Schema Definition:** - Add to appropriate schema in `config_flow.py` - Use voluptuous validators from `homeassistant.helpers.config_validation as cv` - Use selectors for better UI (BooleanSelector, NumberSelector, etc.) - Set appropriate default values with `vol.Optional()` **Config Flow Logic:** - Update flow step in `config_flow.py` - Handle new field in `async_step_user()` or options flow - Validate input if needed - Store value in `config_entry.data` or `config_entry.options` **Using the Option:** - Access via `entry.data[CONF_OPTION_KEY]` or `entry.options.get(CONF_OPTION_KEY)` - Pass to coordinator if needed for data fetching - Update entity behavior based on option value **Translations:** - Add label to `translations/en.json` under `config.step.[step_name].data` - Add helper text under `data_description` - Add error messages under `config.error.[error_key]` **Constants:** - Add constant to `const.py`: `CONF_[OPTION_NAME]` - Document purpose with inline comment **Migration (if changing existing config):** - Increment `VERSION` in config flow handler - Implement `async_migrate_entry()` if needed - Handle both old and new format for backwards compatibility **Code Quality:** - Follow existing config flow patterns in `config_flow.py` - Use proper selector types for best UX - Run `script/lint` to validate before completion **Related Files:** - Config Flow: `custom_components/unraid_management_agent/config_flow.py` - Constants: `custom_components/unraid_management_agent/const.py` - Translations: `custom_components/unraid_management_agent/translations/en.json` **DO NOT create tests unless explicitly requested.**

{ "prompt": "# Add Config Option\n\nYour goal is to add a new configuration option to the config flow (setup or options flow).\n\nIf not provided, ask for:\n\n- Option name and purpose\n- Data type (string, int, float, bool, selector)\n- Where to add (initial setup or options flow)\n- Default value (if applicable)\n- Validation requirements\n\n## Requirements\n\n**Schema Definition:**\n\n- Add to appropriate schema in `config_flow.py`\n- Use voluptuous validators from `homeassistant.helpers.config_validation as cv`\n- Use selectors for better UI (BooleanSelector, NumberSelector, etc.)\n- Set appropriate default values with `vol.Optional()`\n\n**Config Flow Logic:**\n\n- Update flow step in `config_flow.py`\n- Handle new field in `async_step_user()` or options flow\n- Validate input if needed\n- Store value in `config_entry.data` or `config_entry.options`\n\n**Using the Option:**\n\n- Access via `entry.data[CONF_OPTION_KEY]` or `entry.options.get(CONF_OPTION_KEY)`\n- Pass to coordinator if needed for data fetching\n- Update entity behavior based on option value\n\n**Translations:**\n\n- Add label to `translations/en.json` under `config.step.[step_name].data`\n- Add helper text under `data_description`\n- Add error messages under `config.error.[error_key]`\n\n**Constants:**\n\n- Add constant to `const.py`: `CONF_[OPTION_NAME]`\n- Document purpose with inline comment\n\n**Migration (if changing existing config):**\n\n- Increment `VERSION` in config flow handler\n- Implement `async_migrate_entry()` if needed\n- Handle both old and new format for backwards compatibility\n\n**Code Quality:**\n\n- Follow existing config flow patterns in `config_flow.py`\n- Use proper selector types for best UX\n- Run `script/lint` to validate before completion\n\n**Related Files:**\n\n- Config Flow: `custom_components/unraid_management_agent/config_flow.py`\n- Constants: `custom_components/unraid_management_agent/const.py`\n- Translations: `custom_components/unraid_management_agent/translations/en.json`\n\n**DO NOT create tests unless explicitly requested.**", "variables": [], "notes": "Add a new configuration option to initial setup or options flow with validation Tools: search/codebase, edit, search, runCommands.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/ruaan-deysel/ha-unraid-management-agent", "path": ".github/prompts/Add Config Option.prompt.md", "ref": "3f28644c0af550721e02724fd503d145ae09e26f", "url": "https://github.com/ruaan-deysel/ha-unraid-management-agent/blob/3f28644c0af550721e02724fd503d145ae09e26f/.github/prompts/Add Config Option.prompt.md", "key": "ruaan-deysel/ha-unraid-management-agent/.github/prompts/Add Config Option.prompt.md" } } }

Add Config Option

About

Add Config Option

Requirements

Use it

Manifest

Reviews