TypeScript Tutorial 0/102 lessons ~6 min read Lesson 77

    Project References and Build Systems

    Split a large repo into referenced projects so checking stays incremental.

    Course progress0%
    Focus
    20 guided sections
    Practice signal
    Examples included
    Career prep
    Interview Q&A included

    Learning Objectives

    After completing this lesson, you will be able to:

    • Explain Project References and Build Systems in terms of composite, references, and tsc -b.
    • Model domain, application, and web packages at TechLearningPro without weakening the contract to any.
    • Trace what the compiler checks and what JavaScript remains at runtime.
    • Recognize and correct this recurring failure mode: circular references or checking the whole repo as one program forever.
    • Defend when to use Project References and Build Systems and when a simpler design is clearer.
    • Distinguish the compile-time guarantees of Project References and Build Systems from runtime behavior.
    • Read and explain compiler diagnostics related to Project References and Build Systems.
    • Choose a simpler alternative when Project References and Build Systems would add unnecessary complexity.
    • Apply Project References and Build Systems without weakening untrusted input to any.
    • Review Project References and Build Systems for maintainability in a multi-team codebase.
    • Test both accepted and intentionally rejected type scenarios.
    • Identify the trust boundaries around code that uses Project References and Build Systems.
    • Evaluate checker, build, bundle, and runtime costs separately.
    • Explain the security limitations of erased TypeScript types.
    • Use Project References and Build Systems in a production-oriented TechLearningPro design.

    Introduction

    A growing TechLearningPro codebase must support domain, application, and web packages at TechLearningPro. Copying loosely related types makes valid changes expensive and lets assumptions drift between the UI, application services, and API adapters. The team needs a design that expresses the relationship explicitly while remaining understandable to reviewers.

    This lesson approaches Project References and Build Systems as an engineering decision rather than syntax to memorize. You will connect the developer experience to the TypeScript compiler, emitted JavaScript, production boundaries, and the maintenance costs paid by a team over time.

    What Is This Concept?

    In simple language: Project references make TypeScript treat packages as a build graph.

    Professional explanation: Project References and Build Systems is a compile-time modeling technique based on composite, references, and tsc -b. It lets the checker preserve domain relationships, reject inconsistent programs, and communicate intent without claiming that a TypeScript type validates values at runtime.

    Why Do We Need It?

    Without Project References and Build Systems
            │
            ▼
    Ambiguous intent and defects discovered late
            │
            ▼
    TypeScript models the contract
            │
            ▼
    Earlier feedback, safer change, clearer design
    • It makes the relationship behind domain, application, and web packages at TechLearningPro visible in the program.
    • It moves many integration mistakes into editor and CI feedback.
    • It reduces duplicated contracts that can drift during refactoring.
    • It gives maintainers a precise vocabulary for reviewing design changes.
    • It supports the key engineering decision: one project per publishable package plus a solution tsconfig.

    Real-World Analogy

    Floors are inspected in order; the roof is not rebuilt to change a kitchen drawer.

    How It Works

    Compile time

    The checker applies composite, references, and tsc -b, resolves the resulting relationships, and reports assignments or operations that violate them. These checks happen during editing or compilation and are erased from ordinary JavaScript output.

    Runtime

    At runtime, Project References and Build Systems has no independent type-level behavior: emitted JavaScript follows ordinary JavaScript semantics. External data still requires runtime validation.

    Critical boundary: TypeScript types are erased before execution. A successful type check does not validate JSON, environment variables, form data, database rows, or messages received from another process. Validate untrusted values at runtime, then narrow them into trusted domain types.
    1. 1. Identify the invariant in the requirement: domain, application, and web packages at TechLearningPro.
    2. 2. Represent only the information the compiler needs to preserve that invariant.
    3. 3. Apply composite, references, and tsc -b and inspect inference rather than guessing it.
    4. 4. Compile under strict mode and test both accepted and rejected calls.
    5. 5. Inspect emitted JavaScript when runtime behavior matters.
    6. 6. Validate unknown input before it enters the trusted typed core.

    Architecture / Flow Diagram

    Domain requirement: domain, application, and web packages at TechLearningPro
            │
            ▼
    Type model: Project References and Build Systems
            │  compiler applies composite, references, and tsc -b
            ▼
    Accepted program ──or── precise diagnostic
            │
            ▼
    Emitted JavaScript (types erased)
            │
            ▼
    Runtime validation at every untrusted boundary

    Code Examples

    Basic Example: Smallest useful model

    This isolates the essential behavior of Project References and Build Systems.

    ts
    {
    "files": [],
    "references": [{ "path": "packages/domain" }, { "path": "apps/web" }]
    }

    Intermediate Example: Application boundary

    This applies the idea to domain, application, and web packages at TechLearningPro.

    ts
    {
    "compilerOptions": { "composite": true, "declaration": true }
    }

    Advanced Example: Production-oriented design

    This version makes the trade-off—one project per publishable package plus a solution tsconfig—explicit.

    ts
    npx tsc -b --pretty false

    Enterprise Example

    TechLearningPro uses Project References and Build Systems while implementing domain, application, and web packages at TechLearningPro. A boundary adapter first validates HTTP or queue payloads as unknown. The application layer then relies on the static contract, and the domain layer stays independent of transport details. Reviewers can distinguish a compile-time guarantee from authorization, validation, and other runtime controls.

    Student
       │
       ▼
    React / Angular UI
       │ typed command
       ▼
    Application service
       │ validated DTO
       ▼
    API client ─────► Runtime schema at trust boundary
       │
       ▼
    Backend API

    Deep Dive

    composite, references, and tsc -b is useful because it preserves a relationship rather than merely replacing a long annotation with a short name. If no meaningful relationship is being enforced, the abstraction may be ceremony.

    The principal design risk is circular references or checking the whole repo as one program forever. A strong design keeps diagnostics readable, exposes a small public surface, and documents the invariant in domain language.

    Project References and Build Systems should end at a trust boundary. Parsed JSON, storage records, environment variables, and third-party SDK values begin as unknown; validation creates runtime evidence before a typed domain value is constructed.

    The governing trade-off is one project per publishable package plus a solution tsconfig. Prefer the least powerful construct that keeps invalid states unrepresentable and remains easy for another engineer to modify.

    Common Mistakes

    For each mistake, identify the false assumption and replace it with an explicit contract:

    1. 1. Treating Project References and Build Systems as runtime validation; types are erased and hostile input is unchanged.
    2. 2. Using any to silence a failure instead of understanding composite, references, and tsc -b.
    3. 3. Ignoring the central pitfall: circular references or checking the whole repo as one program forever.
    4. 4. Adding assertions before proving the asserted fact.
    5. 5. Designing from implementation shapes instead of domain invariants.
    6. 6. Publishing an abstraction whose diagnostics are harder than the duplicated code.
    7. 7. Testing only successful examples and never adding compile-time negative cases.
    8. 8. Coupling domain contracts to a framework, transport, or generated client unnecessarily.
    9. 9. Assuming a more sophisticated type improves runtime speed; it does not.
    10. 10. Repeating a previously taught contract instead of composing the next layer of the design.

    Best Practices

    • Enable strict mode and keep strictNullChecks on.
    • Start with a concrete domain example before extracting an abstraction.
    • Name the invariant behind domain, application, and web packages at TechLearningPro.
    • Document why composite, references, and tsc -b is necessary.
    • Prefer unknown to any at untrusted boundaries.
    • Validate external values with runtime code or a schema library.
    • Keep public contracts smaller than private implementation types.
    • Let inference handle local details; annotate exported boundaries.
    • Use type tests for both expected success and expected failure.
    • Keep compiler diagnostics understandable to the consuming team.
    • Avoid assertions unless runtime evidence or construction proves them.
    • Inspect generated declarations for library-facing APIs.
    • Measure checker latency before blaming an advanced construct.
    • Separate domain types from wire-format DTOs.
    • Review optionality, mutability, and nullability deliberately.
    • Revisit the decision periodically: one project per publishable package plus a solution tsconfig.

    Performance

    Type annotations normally have no direct runtime cost because they are removed from emitted JavaScript. Performance work must separate editor/type-checking cost, compilation cost, bundle output, and actual JavaScript execution.

    • Project References and Build Systems normally changes checker work, not JavaScript execution speed.
    • Deep composition can increase editor and CI type-checking time; measure with compiler diagnostics before simplifying.
    • Runtime performance depends on emitted algorithms, allocations, I/O, and validation—not on erased annotations.
    • Type-driven refactoring may enable better code, but benchmark the emitted application rather than claiming a type-level speedup.

    Security

    Static types improve reviewability and make invalid internal states harder to express, but they are not a security boundary. Attackers interact with the emitted JavaScript and network interfaces, not your type declarations.

    • Parse untrusted input as unknown and validate structure, ranges, formats, and size at runtime.
    • Keep authentication and authorization checks in executable code.
    • Do not let an assertion convert attacker-controlled data into a trusted domain value.
    • Avoid exposing sensitive fields merely because a projected type hides them; the runtime object may still contain them.
    • Use Project References and Build Systems to improve reviewability, while treating validation and policy enforcement as separate controls.

    Real-World Architecture

    Place Project References and Build Systems in the narrowest stable layer that owns its invariant. Transport adapters validate data and map DTOs; application services coordinate use cases; domain modules expose purposeful contracts; infrastructure implements those contracts.

    Interview Questions & Answers

    Beginner

    1What problem does Project References and Build Systems solve?+
    It models domain, application, and web packages at TechLearningPro by using composite, references, and tsc -b. The value is earlier, clearer feedback about inconsistent code; it is not runtime validation.
    2Does Project References and Build Systems exist at runtime?+
    Its type information does not. The compiler erases types, although JavaScript constructs such as classes or imports may emit runtime code. Therefore external data must still be checked.
    3What JavaScript remains after the types used by Project References and Build Systems are erased?+
    Only the executable JavaScript constructs remain. Type aliases, interfaces, annotations, and most type operators do not become runtime checks. Inspecting emitted output is the reliable way to answer this for a specific compiler configuration.
    4How should a developer read an error related to Project References and Build Systems?+
    Start from the first incompatible relationship, identify the expected and actual types, and trace where each was inferred. Avoid immediately adding an assertion because that removes evidence without correcting the model.
    5When is unknown safer than any in this lesson?+
    Unknown is safer whenever a value has not yet been proven, especially at network, storage, environment, or user-input boundaries. It requires validation or narrowing before use; any suppresses that review point.

    Intermediate

    1How would you test this type-level design?+
    Write accepted and rejected cases. Use @ts-expect-error for the unsafe call, then compile under strict mode so a future widening is caught.
    2How would you add a negative type test for Project References and Build Systems?+
    Write a small call or assignment that must be rejected and use the repository's type-test convention, such as @ts-expect-error with a reason. CI then fails if a future change unexpectedly makes the unsafe case valid.
    3Where should annotations be explicit and where should inference lead?+
    Annotate exported APIs, domain boundaries, callbacks with contextual ambiguity, and long-lived public contracts. Prefer inference for local implementation details so types stay precise and refactors do not duplicate information.
    4How do runtime schemas cooperate with Project References and Build Systems?+
    A schema checks unknown data while the program is running and returns evidence or an error. After successful parsing, TypeScript can safely carry the inferred domain type through trusted internal code.

    Senior

    1When would you reject this construct in review?+
    When the central pitfall appears: circular references or checking the whole repo as one program forever. Prefer a simpler model if the invariant is not actually protected.
    2How would you keep Project References and Build Systems from leaking across architectural layers?+
    Place the contract in the layer that owns the invariant, map wire DTOs at adapters, and expose narrow application or domain interfaces. Framework and generated-client types should not become the universal domain vocabulary.
    3What metrics would you inspect before optimizing this type design?+
    Measure editor latency, tsc extended diagnostics, incremental build time, declaration generation, and affected-project scope. Separately profile bundle size and runtime behavior because erased type complexity is not runtime CPU cost.
    4When should a team simplify its use of Project References and Build Systems?+
    Simplify when diagnostics become opaque, checker cost is measurable, the abstraction has few consumers, or maintainers cannot state the invariant it protects. Preserve domain safety while reducing type-level cleverness.

    Architect

    1How should this live in a large platform?+
    Own the contract in one layer, version shared types, validate at trust boundaries, and measure checker cost. The decision is one project per publishable package plus a solution tsconfig.
    2How would you govern Project References and Build Systems across a monorepo?+
    Define ownership and public entry points, publish small declaration surfaces, enforce dependency direction, add type and runtime contract tests, version shared contracts, and measure build impact through project references or affected builds.
    3What is the migration strategy if teams currently rely on any?+
    Inventory escape hatches by risk, start at external boundaries with unknown plus schemas, enable strict options incrementally, add typed facades around legacy modules, and prevent new any usage while paying down existing hotspots.
    4How do security and maintainability trade-offs affect this design?+
    Richer static contracts can prevent accidental misuse and clarify review, but they cannot enforce authorization or sanitize hostile values. Architects balance readable types, executable validation, policy enforcement, ownership, and operational observability.

    Practical Exercise

    Problem: Create two referenced packages where web depends on domain.

    Difficulty: Advanced

    Requirements

    • Compile under strict mode.
    • Keep untrusted input as unknown until validated.
    • Avoid any except as a documented last resort.
    • Show one accepted and one rejected type scenario.

    Expected behavior: A small TechLearningPro module that uses Project References and Build Systems to protect domain, application, and web packages at TechLearningPro and documents the runtime boundary.

    Hints

    • Start from composite, references, and tsc -b.
    • Watch for circular references or checking the whole repo as one program forever.
    • Inspect emitted JavaScript if runtime behavior is in doubt.

    The complete solution is intentionally withheld. First model the contract, compile under strict mode, and explain every assertion or escape hatch during review.

    Key Takeaways

    • Project References and Build Systems models domain, application, and web packages at TechLearningPro through composite, references, and tsc -b.
    • Types are erased; they do not validate runtime data.
    • Unknown external values require runtime validation.
    • The main hazard is circular references or checking the whole repo as one program forever.
    • The key trade-off is one project per publishable package plus a solution tsconfig.
    • Strict mode and negative type tests make the contract more reliable.
    • Small public surfaces improve diagnostics and maintainability.
    • Type sophistication is valuable only when it preserves a real invariant.
    • Security controls and performance claims require runtime evidence.
    • Compose the next lesson instead of reteaching this contract from scratch.

    Summary

    Project References and Build Systems gives TechLearningPro a precise way to model domain, application, and web packages at TechLearningPro through composite, references, and tsc -b. Used with strict checking, boundary validation, and deliberate ownership, it improves change safety without pretending that erased types enforce runtime policy.

    Next Lesson Preview

    Next, study Type-Safe Tests with Vitest or Jest. The next lesson extends this foundation with another production modeling technique.

    Ready to mark this lesson complete?Track your journey across the entire course.