Packages

oaspec

0.31.0
0.68.0 0.67.0 0.66.0 0.65.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.1 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.3 0.6.1 0.6.0 0.5.0 0.4.0 0.3.0 0.1.3

Generate Gleam code from OpenAPI 3.x specifications

HexDocs

Current section

Files

Jump to
Readme
70 Versions
8 Dependencies
2 Dependants
Files
Activity
oaspec src oaspec internal codegen context.gleam
Raw

src/oaspec/internal/codegen/context.gleam 

import oaspec/config.{type Config}

import oaspec/internal/openapi/spec.{type OpenApiSpec, type Resolved}



/// The version of oaspec used for generated code headers.

pub const version = "0.31.0"



/// Context for code generation, carrying all needed state.

/// Only accepts a resolved spec — codegen must not operate on unresolved ASTs.

///

/// Opaque: external callers construct via `new/2` and read fields via

/// the accessors `spec/1` / `config/1`. This keeps the internal shape

/// free to evolve (e.g. add derived caches) without rippling into every

/// pattern match across the codebase.

pub opaque type Context {

  Context(spec: OpenApiSpec(Resolved), config: Config)

}



/// Create a new generation context from a resolved spec.

pub fn new(spec: OpenApiSpec(Resolved), config: Config) -> Context {

  Context(spec:, config:)

}



/// The resolved OpenAPI spec this context wraps.

pub fn spec(ctx: Context) -> OpenApiSpec(Resolved) {

  ctx.spec

}



/// The generation config this context wraps.

pub fn config(ctx: Context) -> Config {

  ctx.config

}



/// Target for a generated file, indicating where it should be written.

pub type FileTarget {

  SharedTarget

  ServerTarget

  ClientTarget

}



/// How the writer should treat a `GeneratedFile` that already exists on

/// disk. Most generated files are sealed (`Overwrite`) — the user is

/// expected not to touch them and the generator clobbers any local

/// changes on every run. `SkipIfExists` is for files the generator

/// emits ONCE as a starting point, then leaves alone so the user can

/// own the contents (Issue #247: `handlers.gleam` panic stubs).

pub type WriteMode {

  Overwrite

  SkipIfExists

}



/// A generated file with its path, content, output target, and write

/// mode. `write_mode` defaults to `Overwrite` for every file the

/// generator owns end-to-end.

pub type GeneratedFile {

  GeneratedFile(

    path: String,

    content: String,

    target: FileTarget,

    write_mode: WriteMode,

  )

}