Skip to content

Internals

Documentation for contributors working on Typist itself. These documents describe internal architecture, analysis algorithms, coding conventions, and LSP implementation status.

Note

If you are looking to use Typist in your Perl projects, see the Guide instead.

Documents

Document Content
Architecture System lifecycle, module dependency graph, type node hierarchy, registry design, error system, LSP server architecture, runtime enforcement, module loading strategy
Static Analysis Analyzer pipeline, extractor, structural checker, TypeChecker, EffectChecker, type inference, gradual typing semantics, cross-file support, diagnostic infrastructure
Conventions Language and module conventions, type system patterns, syntax conventions, feature reference, namespace model, design principles, Perl gotchas
LSP Coverage Analyzer output → LSP consumer map, diagnostic kinds, completion contexts, hover, definition, signature help, inlay hints, code actions, semantic tokens, references/rename

Design Plans

Document Content
Scoped Effects Per-effect generics, effect discharge, scoped capability-based effects (completed)
HKT Generics Higher-kinded type parameters on datatype, struct, effect declarations
Associated Types & Indexed Protocols Associated types on type classes, parameterized protocol states with type flow