refactor: adopt standard Go project layout #71
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Move cmd/main.go to cmd/ocap-webserver/main.go - Move server/ to internal/server/ - Move storage/ and conversion/ to internal/ as siblings - Move schemas/ to pkg/schemas/ for public API - Move ammo/ and markers/ to assets/ - Remove data/ and maps/ (now gitignored runtime dirs) - Update all import paths and build configurations
Use /ocap-webserver to only match the binary at root level
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Restructures the codebase to follow the standard Go project layout:
cmd/ocap-webserver/- Application entry point (named after binary)internal/- Private application codeserver/- HTTP handlers, repositories, configurationstorage/- Storage engines (JSON, Protobuf, FlatBuffers)conversion/- Background format conversion workerpkg/schemas/- Public API (protobuf/flatbuffers schemas)assets/- Static assets (markers, ammo icons)Changes
cmd/main.go→cmd/ocap-webserver/main.goserver/→internal/server/server/storage/→internal/storage/server/conversion/→internal/conversion/schemas/→pkg/schemas/ammo/andmarkers/→assets/data/andmaps/directories (now gitignored)Test plan
go build ./cmd/ocap-webserversucceedsgo test ./...passes