mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
d112ded3da
* docs: Add config merging design spec for #114 Defines the merge-during-setup-install approach for keeping user configs up to date with new template keys while preserving all existing values, comments, and formatting. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: Add implementation plan for config merging TDD-based plan with 6 tasks: dependency setup, failing tests, core merge implementation, integration test, WriteTemplateConfig integration, and full verification. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: Merge template config into existing user config during setup install Instead of skipping when a config file exists, WriteTemplateConfig() now merges missing keys from the embedded template into the user's config using YAML AST manipulation. Preserves all user values, comments, and formatting. Only adds keys present in the template but absent in the user's config. Closes #114 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: Graceful error handling for config loading and setup commands Replace panics in loadViperConfig with error returns so the app falls back to defaults instead of crashing on malformed config files. Add SilenceUsage to setup install/remove commands so runtime errors don't dump the full usage text. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * add test cmd in readme * update copy text * refactor: Address review feedback on config merging - Rename existing/template to dest/source for generic util naming - Remove unnecessary code comments (Rule N references, obvious comments) - Add AGENTS.md with dev guide and code style rules, symlink CLAUDE.md - Add BenchmarkMergeYAML (~46μs/op on M4 Pro) - Remove stale design spec Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * update `MergeYAML` to use from dry/utils * update AGENTS.md --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
30 lines
972 B
Markdown
30 lines
972 B
Markdown
# PMG - Development Guide
|
|
|
|
## Build & Test
|
|
|
|
```bash
|
|
go build ./... # Build
|
|
go test ./... -count=1 # Run all tests
|
|
go test ./config/ -v -count=1 # Run specific package tests
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
- `cmd/` — CLI commands (npm, pypi, setup, version)
|
|
- `config/` — Configuration loading, templates, merging
|
|
- `sandbox/` — Sandbox policy enforcement (macOS Seatbelt, Linux Bubblewrap)
|
|
- `proxy/` — Proxy-based package interception
|
|
- `guard/` — Guard-based package analysis
|
|
- `analyzer/` — Package security analysis
|
|
- `internal/` — Internal utilities (analytics, eventlog, flows, ui)
|
|
|
|
## Code Style
|
|
|
|
- Keep things short and simple
|
|
- Avoid unnecessary code comments
|
|
- Use comments for trade-offs, known uncovered cases, and anything useful for a human reader
|
|
- Code itself should be readable without comments explaining the obvious
|
|
- Follow existing patterns in the codebase
|
|
- Use `testify` (assert/require) for tests
|
|
- Table-driven tests preferred
|