Skip to content

Commit

Permalink
introduce roadmap
Browse files Browse the repository at this point in the history
  • Loading branch information
widmogrod committed Mar 3, 2024
1 parent 4e25aa8 commit ac3378c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Roadmap

## Learning and adoption

- [_] feature: `mkunion watch ./...` command that watches for changes in files and runs faster than go generate
- [_] docs: document simple state machine and how to use `mkunion` for it
- [_] docs: document other packages in `x/` directory
- [_] docs: document typescript types generation and end-to-end typs concepts (from backend to frontend)
- [_] feature: expose functions to extract `go:tag` metadata
- [_] docs: describe philosophy of "data as resource" and how it translates to some of library concepts

## Long tern experiments and prototypes

- [_] experiment: generate other serialization formats (e.g. grpc)
- [_] prototype: http & gRPC client for end-to-end types.
2 changes: 1 addition & 1 deletion example/tree.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package example

//go:generate go run ../cmd/mkunion/main.go
//go:generate go run ../cmd/mkunion/main.go --type-registry

//go:tag mkunion:"Tree"
type (
Expand Down

0 comments on commit ac3378c

Please sign in to comment.