cratestack-parser

Parser and semantic checker for .cstack schema files.

Overview

cratestack-parser turns .cstack source text into a cratestack_core::Schema AST and runs semantic validation. The include_schema! proc-macro calls this crate at compile time; the LSP and CLI call it at runtime.

Installation

[dependencies]
cratestack-parser = "0.2.2"

Usage

Parse from a string

use cratestack_parser::parse_schema;

let source = r#"
auth Principal {
  id String
  role String?
}

model Post {
  id String @id
  title String
  published Boolean @default(false)
  authorId String

  @@allow("read", auth() != null)
}
"#;

let schema = parse_schema(source)?;

Parse from a file

use cratestack_parser::parse_schema_file;

let schema = parse_schema_file("schema.cstack")?;

Named source for diagnostics

use cratestack_parser::parse_schema_named;

let schema = parse_schema_named("my-app/schema.cstack", source)?;

Errors

SchemaError carries a source span and a line number plus an ariadne-rendered report:

use cratestack_parser::{SchemaError, parse_schema};

match parse_schema(source) {
    Ok(schema) => { /* ... */ }
    Err(error) => {
        eprintln!("{}", error.message());
        eprintln!("line {}", error.line());
        let span = error.span();
        eprintln!("bytes {}..{}", span.start, span.end);
        eprintln!("{}", error.render("schema.cstack", source));
    }
}

Supported Constructs

Construct	Description
`datasource`	Database config (`provider = "postgresql"` or `"sqlite"`)
`auth`	Single auth block declaring principal fields
`mixin`	Reusable field set, applied via `@use(...)` on a model
`model`	Entity with fields, relations, and policy attributes
`type`	Named record type (`@custom` fields supported)
`enum`	Untyped identifier variants
`procedure`	`procedure` / `mutation procedure` with typed args/return
`mcp`	Parsed as a config block

See the root README for the canonical capability matrix.

Field and Model Attributes

See Field Attributes for the full list. Common attributes:

@id, @unique, @relation(...), @default(...)
@readonly, @server_only, @pii, @sensitive
@version (optimistic locking)
@length, @range, @email, @regex, @uri, @iso4217 (validators)
@@allow(action, expr), @@deny(action, expr)
@@audit, @@soft_delete
@@emit(created, updated, deleted)

License

MIT

cratestack-parser 0.2.3