josiadmin/awesome-copilot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enhance precedence rules documentation with explicit boolean behaviors and detailed examples

Browse Source 
Co-authored-by: AstroSteveo <34114851+AstroSteveo@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-09-23 06:39:47 +00:00
parent 1967b59786
commit 9367292d95
1 changed files with 36 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -89,14 +89,22 @@ See [CONFIG.md](CONFIG.md) for detailed configuration documentation.
#### ⚖️ Configuration Precedence Rules #### ⚖️ Configuration Precedence Rules
Awesome Copilot uses an **effective state system** that respects explicit overrides while allowing collections to provide convenient defaults: Awesome Copilot uses an **effective state system** that respects explicit overrides while allowing collections to provide convenient defaults. The effective state computation follows these precise rules:
1. **Explicit Settings Override Everything** **Boolean Value Behavior:**
- `true` → **enabled** (explicit override)
- `false` → **disabled** (explicit override)
- `undefined` → **inherit from collections** (union of enabled collections)
**Precedence Hierarchy:**
1. **Explicit Per-Item Overrides Take Precedence Over Collections**
```yaml ```yaml
collections: collections:
testing-automation: true # Enables 11 items testing-automation: true # Enables 11 items including playwright-generate-test
prompts: prompts:
playwright-generate-test: false # Explicitly disabled, overrides collection playwright-generate-test: false # Explicitly disabled, overrides collection
create-readme: true # Explicitly enabled, regardless of collections
``` ```
2. **Collections Enable Groups of Items** 2. **Collections Enable Groups of Items**
@ -106,18 +114,35 @@ Awesome Copilot uses an **effective state system** that respects explicit overri
testing-automation: true # Enables testing tools and frameworks testing-automation: true # Enables testing tools and frameworks
``` ```
3. **Undefined Items Follow Collections** 3. **Undefined Items Inherit from Collections (Union Behavior)**
- Items not explicitly listed inherit from enabled collections - Items not explicitly listed (`undefined`) inherit from enabled collections
- Only explicitly set true/false values override collection settings - **Effective state = explicit override OR union of enabled collections**
- This allows collections to work as intended while preserving explicit choices - Multiple enabled collections combine their items (union operation)
- Only explicitly set `true`/`false` values override collection settings
**Detailed Examples:**
```yaml
# Configuration example showing precedence rules
collections:
testing-automation: true # Enables: playwright-generate-test, csharp-nunit, etc.
frontend-web-dev: true # Enables: react-component, vue-component, etc.
prompts:
playwright-generate-test: false # Explicitly disabled (overrides testing-automation)
create-readme: true # Explicitly enabled (regardless of collections)
# vue-component: undefined # Inherits from frontend-web-dev → enabled
# api-testing: undefined # Not in any enabled collection → disabled
```
**Examples:**
```bash ```bash
# See effective states and why each item is enabled # See effective states and why each item is enabled
awesome-copilot list prompts awesome-copilot list prompts
# [✓] create-readme (explicit) # [✓] create-readme (explicit: true)
# [✓] playwright-generate-test (collection) # [✓] vue-component (collection: frontend-web-dev)
# [ ] react-component # [✓] react-component (collection: frontend-web-dev)
# [ ] playwright-generate-test (explicit: false - overrides collection)
# [ ] api-testing (disabled: not in any enabled collection)
# Collection toggle shows what will change # Collection toggle shows what will change
awesome-copilot toggle collections frontend-web-dev on awesome-copilot toggle collections frontend-web-dev on