style: restructure cli and registry packages #43

Merged
mvhutz merged 7 commits from style/move-cli into main 2026-02-07 05:39:33 +00:00
Owner

Description

The internal/cli package had grown to contain both CLI utilities (source/destination I/O) and registry-level abstractions (repr, conversion, engine, marshaler).
This PR separates concerns by moving registry types into internal/registry and keeping only CLI I/O types in internal/cli.
It also simplifies several core abstractions and aligns naming conventions.

  • Move Source, Destination from internal/config to internal/cli.
  • Move Repr, Conversion, Engine, Process, Codec from internal/cli to internal/registry.
  • Rename "marshalers" to "codecs" throughout the codebase.
  • Simplify codec.Codec[T, U] to codec.Codec[T] (string-based marshaling only).
  • Add codec.Conversion[T, U] as a function type alias.
  • Change engine.Engine[T] from an interface to a function type.
  • Merge Engine.Load() + Process.Set() into a single Engine.Load(Repr) call.
  • Convert Saccharine2Lambda from a struct to standalone conversion functions.
  • Replace registry methods (MustAddMarshaler, MustAddEngine, MustAddConversions) with generic free functions (RegisterCodec, RegisterEngine, RegisterConversion).
  • Remove unused internal/config package (Config, GetLogger, ParseFromArgs).
  • Remove unused pkg/emitter package.
  • Rename Id() to ID() per Go conventions.
  • Add documentation comments and enable checkPublicInterface lint rule.
  • Rename reduce_one.go to reduce_once.go.

Decisions

  • Engine[T] is now a function type (func(T) (Process[T], error)) rather than an interface, since the only method was Load.
  • Codec[T, U] was split into Codec[T] (string marshaling) and Conversion[T, U] (type-to-type conversion function), which better reflects how they are actually used.
  • Registration uses free generic functions (RegisterCodec, RegisterEngine, RegisterConversion) instead of methods on Registry, enabling type inference at the call site.

Benefits

  • Clearer separation of concerns between CLI I/O and the registry's internal type system.
  • Simpler abstractions: fewer interfaces, fewer wrapper types, fewer indirections.
  • Removing unused packages (config, emitter) reduces maintenance burden.
  • Naming conventions (ID, codecs, reduce_once) are more idiomatic.

Checklist

  • Code follows conventional commit format.
  • Branch follows naming convention (<type>/<description>).
  • Tests pass (if applicable).
  • Documentation updated (if applicable).
## Description The `internal/cli` package had grown to contain both CLI utilities (source/destination I/O) and registry-level abstractions (repr, conversion, engine, marshaler). This PR separates concerns by moving registry types into `internal/registry` and keeping only CLI I/O types in `internal/cli`. It also simplifies several core abstractions and aligns naming conventions. - Move `Source`, `Destination` from `internal/config` to `internal/cli`. - Move `Repr`, `Conversion`, `Engine`, `Process`, `Codec` from `internal/cli` to `internal/registry`. - Rename "marshalers" to "codecs" throughout the codebase. - Simplify `codec.Codec[T, U]` to `codec.Codec[T]` (string-based marshaling only). - Add `codec.Conversion[T, U]` as a function type alias. - Change `engine.Engine[T]` from an interface to a function type. - Merge `Engine.Load()` + `Process.Set()` into a single `Engine.Load(Repr)` call. - Convert `Saccharine2Lambda` from a struct to standalone conversion functions. - Replace registry methods (`MustAddMarshaler`, `MustAddEngine`, `MustAddConversions`) with generic free functions (`RegisterCodec`, `RegisterEngine`, `RegisterConversion`). - Remove unused `internal/config` package (`Config`, `GetLogger`, `ParseFromArgs`). - Remove unused `pkg/emitter` package. - Rename `Id()` to `ID()` per Go conventions. - Add documentation comments and enable `checkPublicInterface` lint rule. - Rename `reduce_one.go` to `reduce_once.go`. ### Decisions - `Engine[T]` is now a function type (`func(T) (Process[T], error)`) rather than an interface, since the only method was `Load`. - `Codec[T, U]` was split into `Codec[T]` (string marshaling) and `Conversion[T, U]` (type-to-type conversion function), which better reflects how they are actually used. - Registration uses free generic functions (`RegisterCodec`, `RegisterEngine`, `RegisterConversion`) instead of methods on `Registry`, enabling type inference at the call site. ## Benefits - Clearer separation of concerns between CLI I/O and the registry's internal type system. - Simpler abstractions: fewer interfaces, fewer wrapper types, fewer indirections. - Removing unused packages (`config`, `emitter`) reduces maintenance burden. - Naming conventions (`ID`, codecs, `reduce_once`) are more idiomatic. ## Checklist - [x] Code follows conventional commit format. - [x] Branch follows naming convention (`<type>/<description>`). - [x] Tests pass (if applicable). - [x] Documentation updated (if applicable).
mvhutz added 7 commits 2026-02-07 05:37:25 +00:00
mvhutz merged commit bbe027e9f4 into main 2026-02-07 05:39:33 +00:00
mvhutz deleted branch style/move-cli 2026-02-07 05:39:33 +00:00
Sign in to join this conversation.