# wp-lang
[](https://codecov.io/gh/wp-labs/wp-lang)
## Overview
`wp-lang` is the standalone WPL language crate from the Warp Parse stack. It contains the WPL AST, parser, runtime evaluator, built-in value parsers, preprocessing hooks, and generation utilities needed to parse and execute WPL rules.
The crate sits above `wp-primitives`: `wp-primitives` handles syntax-agnostic parsing helpers, while `wp-lang` owns language semantics, WPL-specific AST types, builtins, and runtime behavior.
## What It Provides
- WPL AST types such as `WplRule`, `WplExpress`, `WplField`, and `WplPackage`
- Source parsers for rules, packages, annotations, fields, separators, and functions
- Runtime evaluation through `WplEvaluator`
- Built-in parsing and transformation pipeline units
- Value parsers for common formats such as JSON, KV, arrays, time, IP, and protocol text
- Precompile helpers for turning parsed rules into executable units
## Quick Start
```toml
[dependencies]
wp-lang = "0.1"
```
```rust
use wp_primitives::Parser;
use wpl::wpl_express;
let mut code = "(digit:id, chars:name)";
let expr = wpl_express.parse_next(&mut code).unwrap();
assert!(expr.statement.first_group().is_some());
```
## Public API Notes
- The package name is `wp-lang`
- The Rust library name stays `wpl`
This keeps downstream imports concise while exposing a publishable package name.
## Design Boundary
- `wp-primitives`: syntax-agnostic parsing primitives
- `wp-lang`: WPL syntax, AST, builtins, runtime evaluation, and generation
- Typed data semantics continue to rely on the published `wp-model-core`, `wp-parse-api`, and related crates
## Development
Run:
- `cargo check`
- `cargo test`
- `cargo fmt --all`
- `cargo clippy --all-targets --all-features -- -D warnings`
Benchmarks live under `benches/` and use Criterion.
## Quick Parse Validation
For quick syntax validation while editing WPL source, or to try one sample payload against a rule, use the bundled `wpl-check` tool:
```bash
cargo run --bin wpl-check -- syntax path/to/demo.wpl
printf '%s\n' 'rule demo { (digit:id, chars:name) }' | cargo run --bin wpl-check -- syntax --rule --print -
cargo run --bin wpl-check -- sample --rule examples/wpl-check/csv_demo/rule.wpl examples/wpl-check/csv_demo/sample.txt
cargo run --bin wpl-check -- sample --package --rule-name csv_user examples/wpl-check/package_demo
```
Use `syntax` for source-only checks and `sample` to run one payload through a rule or expression. `sample` now treats a sample data file as the normal input form; `--data` is only for quick inline checks. By default, `wpl-check` looks for `rule.wpl` and `sample.txt`, and if you pass a directory it resolves those files inside the directory. If `sample` receives a package with multiple rules and no `--rule-name`, it reports the available rule names directly. Successful validation exits with code `0`; syntax or data parse failures exit non-zero.
Reusable sample WPL and payload files extracted from tests live under `examples/wpl-check/`.
## Codex Skill
The repository-managed source for the `wpl-rule-check` Codex skill lives under `tools/skills/wpl-rule-check/`.
Install or refresh the local skill with:
```bash
bash scripts/install-codex-skill.sh wpl-rule-check
```
This copies the skill into `~/.codex/skills/wpl-rule-check/`, which is the local runtime location used by Codex. Manage changes, review, and release history from the repository copy; treat `~/.codex/skills/` as an installed artifact.
## License
Distributed under the Apache License 2.0. See [`LICENSE`](LICENSE).