Skip to content

Update best practices with new features and clarity fixes#121

Merged
waldekmastykarz merged 5 commits intomainfrom
add-v2.2.0-best-practices
Apr 27, 2026
Merged

Update best practices with new features and clarity fixes#121
waldekmastykarz merged 5 commits intomainfrom
add-v2.2.0-best-practices

Conversation

@garrytrinder
Copy link
Copy Markdown
Member

@garrytrinder garrytrinder commented Apr 27, 2026

Updates the best practices document with new content and fixes existing contradictions and ambiguities.

New content

  • YAML config supportdevproxyrc.yaml/devproxyrc.yml as config formats, devproxy config new --format yaml
  • Config validationdevproxy config validate subcommand
  • @dynamic=initialvalue — per-response Retry-After with initial values in GenericRandomErrorPlugin
  • --no-watch flag — disable config auto-reload in CI/CD and automated environments
  • Detached mode — new section covering background execution, --output json, random ports (port: 0), asSystemProxy: false, multi-instance support, devproxy status, and proxy URL output
  • Updated curl section — references actual port instead of hardcoded 8000

Clarity fixes

  • Plugin ordering — replaced three conflicting rules ("put X first", "put Y last", "put Z before others") with a single definitive ordering list
  • Removed duplicate $schema rule — already covered in the Configuration section, was repeated in Plugins
  • Hot reload — updated to cover all config file types (JSON, JSONC, YAML), removed fluff
  • LatencyPlugin — replaced redundant ordering guidance with a reference to the plugin ordering list

Replaces #113.

Adds guidance for new v2.2.0 features:
- YAML config support (devproxyrc.yaml/yml)
- Config validation (devproxy config validate)
- @dynamic=initialvalue for GenericRandomErrorPlugin
- --no-watch flag to disable hot reload
- Detached mode with random ports, asSystemProxy false, and devproxy status
- Updated curl section to reference actual port
@garrytrinder garrytrinder changed the title Add v2.2.0 best practices content Add best practices for v2.2.0–v2.3.x features Apr 27, 2026
- Replace three conflicting plugin ordering rules with single definitive order
- Remove duplicate $schema rule (already covered in Configuration section)
- Update hot reload to cover all config types (JSON, JSONC, YAML)
- Remove fluff line about hot reload iterating faster
- Simplify LatencyPlugin guidance to reference plugin ordering
- Clarify curl section wording
- Fix proxy URL bullet to be more actionable
Assume users are on the latest version. Version tags add noise
without providing actionable value for coding agents.
@garrytrinder garrytrinder changed the title Add best practices for v2.2.0–v2.3.x features Update best practices with new features and clarity fixes Apr 27, 2026
@waldekmastykarz waldekmastykarz merged commit f93f989 into main Apr 27, 2026
1 check passed
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.

2 participants