Skip to content

docs: add M1 kickoff scope for protocompile (RFC-001) - #70

Merged
trendvidia merged 1 commit into
mainfrom
m1-kickoff-doc
Jun 5, 2026
Merged

docs: add M1 kickoff scope for protocompile (RFC-001)#70
trendvidia merged 1 commit into
mainfrom
m1-kickoff-doc

Conversation

@trendvidia

Copy link
Copy Markdown
Owner

Summary

  • Adds docs/M1-kickoff-protocompile.md — the concrete first-PR plan for protocompile's M1 work toward RFC-001 issue docs(pxq): land design doc for the jq-style query tool #30 (extended grammar parser).
  • Splits issue docs(pxq): land design doc for the jq-style query tool #30 into five sequential PRs (lexer keywords → type decls → function decls → annotation decls → @annotation use sites). PR 1 is intentionally tiny: ~5 lines in parser/lexer.go + token decls in proto.y, no grammar productions.
  • Includes acceptance criteria, soft-break audit grep commands, branch strategy, and follow-ups for the maintainer.

Tracked by umbrella #55.

Why land it here (not in protocompile)

The doc is implementation-specific (file/line pointers, y.go regen steps) but lives in protowire/docs/ for consistency with the rest of the RFC-001 planning corpus (RFC, IETF draft, issue scaffold, umbrella). The team picking up M1 will cross-link from the actual protocompile PR descriptions back to this doc.

Test plan

  • Read pass — confirm file pointers in §"PR 1" match the current protocompile layout.
  • Confirm the soft-break grep commands in §"Soft-break audit" find no surprising matches across the trendvidia ecosystem.
  • Confirm estimates feel calibrated to whoever will pick up M1.

Adds docs/M1-kickoff-protocompile.md — the concrete first-PR plan
for protocompile's M1 work (extended grammar parser) tracked by
RFC-001 issue #30 in the umbrella tracker (#55).

Scope:
- Splits issue #30 into 5 sequential PRs (lexer keywords, type
  decls, function decls, annotation decls, @annotation use sites)
- PR 1 is a minimal-footprint change: 5 keywords reserved at the
  lexer level, no grammar productions yet — ~5 lines plus tests
- Acceptance criteria, soft-break audit grep commands, branch
  strategy, and follow-ups for the maintainer
- PRs 2-5 sketched with file pointers and estimates

Doc is implementation-specific but lands here for consistency
with the rest of the RFC-001 planning corpus.
@trendvidia
trendvidia merged commit d31d352 into main Jun 5, 2026
4 checks passed
@trendvidia
trendvidia deleted the m1-kickoff-doc branch June 5, 2026 11:20
trendvidia added a commit that referenced this pull request Jul 17, 2026
…README layout (#115)

- Umbrella #30#35 ticked: M1 shipped June + the spec-#91/#35
  catch-up landed 2026-07-17 (protocompile#66/#67/#69 closed, PRs
  #70#72 + follow-ups #77#80).
- #4 round-trip box ticked: annotations.proto verified against
  protocompile @ 03ef9d8 (GH #58 closed) — parses clean, all 9
  declarations lower into FileAnnotationDecls; fixtures 01–06, 09,
  10, 12 all compile with zero diagnostics.
- #5 boxes ticked; README repository-layout now lists
  proto/schema/v1/{annotations,descriptor,report}.proto,
  proto/schema/config/v1/config.proto, and the draft -01 artifacts —
  the missing README listing was the one genuinely unmet box.
trendvidia added a commit that referenced this pull request Jul 24, 2026
- Implementation boxes #40#43 ticked: protocheck v2.0.0 (2026-07-23)
  shipped the engine SPI (PR#22), function registration + init-time
  verification (PR#23), and validation execution — WithFailFast (PR#21),
  wire-aligned EnrichedViolation model (PR#24), carrier-rule dispatch
  with source-map enrichment (PR#26); catalog + i18n (PR#28, M6).
  v2.1.0 added per-element repeated/map dispatch (PR#35).
- #50#52 ticked: protolsp shipped RFC-001 extended-grammar parsing
  and semantic tokens (protolsp#218 Phases A/B, 2026-07-16), source-map
  navigation with descriptor fallback (protolsp#219 Phase C, #220), and
  annotation-aware diagnostics (#220; completion parity #228,
  runtime-violation overlay #231).
- #70 ticked: protowire-go v1.3.1 (2026-07-23) wires the Validator
  seam through the pxf/pb/sbe decoders (protowire-go#49/PR#59) with the
  protocheck-side adapter (protocheck PR#38); protovalidate adapter as
  nested module (PR#60), noted on #17.
- M0 spec boxes #4#7 ticked (landed via GH #54; annotations.proto
  round-trip verified per GH #58); #6 acceptance boxes ticked against
  the shipped STABILITY.md section.
- #19 annotated: §5.3 executable fixtures shipped (GH #135, PR #138);
  corpus expansion continues in GH #68.

Remaining implementation fronts: #60/#61 (protobuf-go codegen) and
#80 (OpenAPI, GH #93).
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.

1 participant