Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,15 +276,15 @@ Most extensions include configuration files in their install directory:
```text
.specify/extensions/<ext>/
├── <ext>-config.yml # Project config (version controlled)
├── <ext>-config.local.yml # Local overrides (gitignored)
├── local-config.yml # Local overrides (gitignored)
└── <ext>-config.template.yml # Template reference
```

Configuration is merged in this order (highest priority last):

1. **Extension defaults** (from `extension.yml`)
2. **Project config** (`<ext>-config.yml`)
3. **Local overrides** (`<ext>-config.local.yml`)
3. **Local overrides** (`local-config.yml`)
4. **Environment variables** (`SPECKIT_<EXT>_*`)

To set up configuration for a newly installed extension, copy the template:
Expand Down
4 changes: 2 additions & 2 deletions extensions/EXTENSION-API-REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ field_mappings:

1. **Extension Defaults** (from `extension.yml` `defaults` section)
2. **Project Config** (`{extension-id}-config.yml`)
3. **Local Override** (`{extension-id}-config.local.yml`, gitignored)
3. **Local Override** (`local-config.yml`, gitignored)
4. **Environment Variables** (`SPECKIT_{EXTENSION}_*`)

### Environment Variable Pattern
Expand Down Expand Up @@ -884,7 +884,7 @@ satisfied = version_satisfies("1.2.3", ">=1.0.0,<2.0.0") # bool
│ ├── {extension-id}/ # Extension directory
│ │ ├── extension.yml # Manifest
│ │ ├── {ext}-config.yml # User config
│ │ ├── {ext}-config.local.yml # Local overrides (gitignored)
│ │ ├── local-config.yml # Local overrides (gitignored)
│ │ ├── {ext}-config.template.yml # Template
│ │ ├── commands/ # Command files
│ │ │ └── *.md
Expand Down
2 changes: 1 addition & 1 deletion extensions/EXTENSION-DEVELOPMENT-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ In your command, load config with layered precedence:

1. Extension defaults (`extension.yml` → `defaults`)
2. Project config (`.specify/extensions/my-ext/my-ext-config.yml`)
3. Local overrides (`.specify/extensions/my-ext/my-ext-config.local.yml` - gitignored)
3. Local overrides (`.specify/extensions/my-ext/local-config.yml` - gitignored)
4. Environment variables (`SPECKIT_MY_EXT_*`)

**Example loading script**:
Expand Down
12 changes: 6 additions & 6 deletions extensions/EXTENSION-USER-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ Extensions can have multiple configuration files:
```text
.specify/extensions/jira/
├── jira-config.yml # Main config (version controlled)
├── jira-config.local.yml # Local overrides (gitignored)
├── local-config.yml # Local overrides (gitignored)
└── jira-config.template.yml # Template (reference)
```

Expand All @@ -358,7 +358,7 @@ Configuration is merged in this order (highest priority last):

1. **Extension defaults** (from `extension.yml`)
2. **Project config** (`jira-config.yml`)
3. **Local overrides** (`jira-config.local.yml`)
3. **Local overrides** (`local-config.yml`)
4. **Environment variables** (`SPECKIT_JIRA_*`)

### Example: Jira Configuration
Expand All @@ -374,7 +374,7 @@ defaults:
labels: ["spec-driven"]
```

**Local override** (`.specify/extensions/jira/jira-config.local.yml`):
**Local override** (`.specify/extensions/jira/local-config.yml`):

```yaml
project:
Expand Down Expand Up @@ -868,15 +868,15 @@ specify extension add --dev /path/to/extension

- `.specify/extensions/.cache/` (catalog cache)
- `.specify/extensions/.backup/` (config backups)
- `.specify/extensions/*/*.local.yml` (local overrides)
- `.specify/extensions/*/local-config.yml` (local overrides)
- `.specify/extensions/.registry` (installation state)

Add to `.gitignore`:

```gitignore
.specify/extensions/.cache/
.specify/extensions/.backup/
.specify/extensions/*/*.local.yml
.specify/extensions/*/local-config.yml
.specify/extensions/.registry
```

Expand Down Expand Up @@ -907,7 +907,7 @@ To install: `specify extension add jira`
Use local config for development:

```yaml
# .specify/extensions/jira/jira-config.local.yml
# .specify/extensions/jira/local-config.yml
Comment thread
Copilot marked this conversation as resolved.
project:
key: "DEVTEST" # Your test project

Expand Down
1 change: 1 addition & 0 deletions extensions/template/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Local configuration overrides
local-config.yml
*-config.local.yml

# Python
Expand Down
2 changes: 1 addition & 1 deletion extensions/template/config-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,5 @@ advanced:
# Note: Use uppercase and replace dots with underscores

# Local Overrides:
# For local development, create my-extension-config.local.yml (gitignored)
# For local development, create local-config.yml (gitignored)
# to override settings without affecting the team configuration
Loading