init: repo skeleton — cargo crate, AGENTS.md, gitignore, licenses
- Cargo.toml: alkgen 0.1.0, deps alktype 0.3.0 + handlebars 6.4 + serde_json (preserve_order) + thiserror; empty lib - AGENTS.md: family-style conventions (wasm-clean, strict templates, template-is-code, generated-code hygiene) + reference map - verified: cargo check/clippy/fmt, wasm32-unknown-unknown release build
This commit is contained in:
glm-5.3-flash committed
1 parent
a73f197786
commit
3178621adb
7 files changed
+411
No files matched your search
@@ -0,0 +1,4 @@
|
||||
/target
|
||||
Cargo.lock
|
||||
node_modules/
|
||||
.worktrees/
|
||||
@@ -0,0 +1,154 @@
|
||||
# AGENTS.md
|
||||
|
||||
Operating instructions for opencode agents working in this repo. opencode
|
||||
auto-loads this file as instructions, overriding the built-in defaults for
|
||||
this project. Custom agents in `.opencode/agents/` inherit these rules
|
||||
unless their own prompts say otherwise.
|
||||
|
||||
## Git Workflow
|
||||
|
||||
**Commit and push when reasonable.** When a change is complete and
|
||||
verified (build + lint + tests pass), commit and push to `origin/main`
|
||||
without asking. This overrides the built-in default of "only commit when
|
||||
explicitly asked."
|
||||
|
||||
The workflow:
|
||||
|
||||
1. Make the change
|
||||
2. Verify: `cargo test`, `cargo clippy --all-targets -- -D warnings`,
|
||||
`cargo fmt --check`, `cargo doc --no-deps` if docs changed,
|
||||
`cargo build --target wasm32-unknown-unknown --release` if
|
||||
dependency/wasm-relevant code changed
|
||||
3. Inspect `git status` and `git diff` before staging — stage only the
|
||||
intended files, never secrets
|
||||
4. Write a concise commit message matching the repo style (see `git log
|
||||
--oneline -10`). For multi-point changes, use a summary line plus a
|
||||
body with bullet points and a verification block.
|
||||
5. `git push origin main`
|
||||
6. Report the commit hash and the verification summary
|
||||
|
||||
Exceptions — **do not** commit or push without asking:
|
||||
|
||||
- The change is exploratory / speculative (you're not sure the user wants
|
||||
it kept)
|
||||
- The user is actively reviewing the diff and may ask for changes
|
||||
- The change touches semver-relevant public API (this crate is headed to
|
||||
crates.io; once published, renames/removals/signature changes on public
|
||||
items are breaking — additive changes are fine)
|
||||
- You'd be force-pushing, amending a published commit, creating an empty
|
||||
commit, or skipping hooks
|
||||
|
||||
Never commit secrets, keys, or credentials. If a commit fails or hooks
|
||||
reject it, fix the issue and create a new commit — do not amend the
|
||||
failed one.
|
||||
|
||||
Git identity is preconfigured (`glm-5.2 <glm-5.2@alk.dev>`). Do not
|
||||
change `git config`, skip hooks, or use `git commit -i`.
|
||||
|
||||
## Project Conventions (Rust / template codegen crate)
|
||||
|
||||
This is a template-based codegen engine: handlebars-rust templates
|
||||
rendered over alktype BAST documents to produce code artifacts (binary
|
||||
readers/writers/validators, protocol handlers). Conventions apply to all
|
||||
work in `src/` and `tests/`.
|
||||
|
||||
1. **No comments in code** unless the user explicitly asks. This is a
|
||||
project-wide convention. Doc comments (`///`, `//!`) are fine and
|
||||
expected on public API. Inline `//` comments only when the user asks
|
||||
or when a non-obvious safety/correctness constraint would otherwise
|
||||
be missed.
|
||||
|
||||
2. **Error handling** — `thiserror` for library error types. No panics
|
||||
in library code. No `unwrap()` or `expect()` outside tests — if you
|
||||
reach for `unwrap`, the error path wasn't specified, stop and decide
|
||||
what should actually happen. Template registration/render failures
|
||||
are data, not crashes: a malformed template or BAST input must
|
||||
produce a typed error, never a panic (generated code feeds alkcall,
|
||||
which accepts BAST from arbitrary peers).
|
||||
|
||||
3. **No `async`** — template rendering and codegen are synchronous,
|
||||
CPU-bound operations. No tokio, no async/await in the core. (If a
|
||||
future file-watch/rebuild service is wanted, that is an assembly-
|
||||
layer concern, not a lib concern.)
|
||||
|
||||
4. **WASM-clean** — the crate must compile to `wasm32-unknown-unknown`.
|
||||
No filesystem access in library code (handlebars `dir_source`
|
||||
feature is off-limits in lib code; templates come from strings or
|
||||
`include_str!`). No threads, no `std::time`, no platform deps. If
|
||||
you reach for a new dependency, first verify it is wasm-compatible
|
||||
and worth the cost.
|
||||
|
||||
5. **`serde_json` `preserve_order` is load-bearing** — alktype relies on
|
||||
it (field order in schema JSON determines packed byte order). Do not
|
||||
disable it and do not sort schema keys in contexts built for
|
||||
templates unless the template explicitly requires a sort.
|
||||
|
||||
6. **Strict template mode** — `Handlebars::set_strict_mode(true)` for
|
||||
any registry the lib renders with. A missing variable in a codegen
|
||||
template must be a render error, not silently-empty output (silent
|
||||
gaps become compile bugs in the *consumer's* build, far from the
|
||||
cause). alkminer-v1's `ShaderBuilder` is the precedent.
|
||||
|
||||
7. **Templates are code** — templates live as `const &str` (inline) or
|
||||
`include_str!` files, versioned in-repo, with render tests pinning
|
||||
their output. Changing a template changes generated code; treat
|
||||
template edits with the same care as source edits (tests must pin
|
||||
golden output before merging).
|
||||
|
||||
8. **Generated-code hygiene** — generated artifacts start with a
|
||||
"Auto-generated by alkgen. DO NOT EDIT." banner (typebox-rs
|
||||
precedent). Rendering must be deterministic: same BAST + same
|
||||
templates + same options → byte-identical output (no HashMap
|
||||
iteration order leaking into generated code).
|
||||
|
||||
9. **Naming** — Rust standard: `snake_case` for functions/variables/
|
||||
modules, `PascalCase` for types/traits, `SCREAMING_SNAKE_CASE` for
|
||||
constants. Template registry names: lowercase kebab or snake, one
|
||||
name per template kind.
|
||||
|
||||
10. **Module structure** — one module per file under `src/`, re-exported
|
||||
from `src/lib.rs`. Public API surface is the `lib.rs` re-exports.
|
||||
|
||||
11. **No `unsafe`** — zero unsafe blocks. If a perf argument appears,
|
||||
the answer lives in the template/data-model layer, not in unsafe.
|
||||
|
||||
## Verification Commands
|
||||
|
||||
Run these before committing. All must pass.
|
||||
|
||||
```bash
|
||||
cargo test # full suite
|
||||
cargo clippy --all-targets -- -D warnings
|
||||
cargo fmt --check
|
||||
cargo doc --no-deps # if docs changed
|
||||
cargo build --target wasm32-unknown-unknown --release # if deps/wasm-relevant code changed
|
||||
cargo publish --dry-run --allow-dirty # before a release
|
||||
```
|
||||
|
||||
## Architecture Context
|
||||
|
||||
- `docs/sdd_process.md` — the SDD workflow (phases, roles, task format).
|
||||
Phase 0 (research/POC) runs before architecture; small changes may
|
||||
skip the ceremony per the doc's "reasonable exceptions" clause.
|
||||
- `docs/research/phase-0.md` — the current phase-0 findings + OQ list.
|
||||
Read it before proposing design changes; extend it when research
|
||||
answers questions.
|
||||
- `docs/architecture/` — will exist after Phase 1; the authoritative
|
||||
spec once present (ADRs numbered, OQs tracked in open-questions.md).
|
||||
- `tasks/` — task graph after decomposition.
|
||||
|
||||
## Reference Material (outside this repo)
|
||||
|
||||
- `/workspace/@alkdev/alktype` — the BAST engine (crates.io 0.3.0);
|
||||
docs/architecture/ there is the schema/layout/validation spec.
|
||||
- `/workspace/@alkimiadev/typebox-rs/src/codegen` — older handlebars
|
||||
codegen precedent (simple context structs + inline templates).
|
||||
- `/workspace/@alkminer/reference/alkminer-v1/src/compute/kernel.rs` —
|
||||
handlebars-as-JIT precedent (strict registry, partials, render-then-
|
||||
compile with cache).
|
||||
- `/workspace/@alkdev/alkhttp/src/adapters` — `from_openapi` /
|
||||
`from_jsonschema` handler shapes the call-protocol codegen mirrors.
|
||||
- `/workspace/@alkdev/alkcall` — channels consumer; generated
|
||||
readers/writers/validators serve its channels.
|
||||
- `/workspace/handlebars-rust` — vendored handlebars checkout (head;
|
||||
crates.io 6.4.4 is the pinned stable).
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
[package]
|
||||
name = "alkgen"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.85"
|
||||
license = "MIT OR Apache-2.0"
|
||||
description = "Template-based codegen engine: handlebars-rust templates over alktype BAST documents, producing readers, writers, validators, and protocol handlers."
|
||||
repository = "https://git.alk.dev/alkdev/alkgen"
|
||||
readme = "README.md"
|
||||
keywords = ["codegen", "handlebars", "templates", "bast", "alktype"]
|
||||
categories = ["development-tools", "template-engine"]
|
||||
exclude = [".opencode/", "AGENTS.md", "docs/reviews/", "docs/research/", "docs/sdd_process.md"]
|
||||
|
||||
[lib]
|
||||
name = "alkgen"
|
||||
|
||||
[features]
|
||||
default = []
|
||||
|
||||
[dependencies]
|
||||
alktype = "0.3.0"
|
||||
handlebars = "6.4"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = { version = "1", features = ["preserve_order"] }
|
||||
thiserror = "2"
|
||||
|
||||
[dev-dependencies]
|
||||
+192
@@ -0,0 +1,192 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name), or refer to, the Work.
|
||||
(Note: Derivative Works shall not include works that remain separable from,
|
||||
or merely link (or bind by name) to the interfaces of, the Work and
|
||||
Derivative Works thereof.)
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to the Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by the Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
Copyright 2025-2026 Alk Development
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025-2026 Alk Development
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,12 @@
|
||||
# alkgen
|
||||
|
||||
Template-based codegen engine for the alk* stack: [handlebars-rust]
|
||||
templates rendered over [alktype] BAST (Binary Abstract Syntax Tree)
|
||||
documents, producing code artifacts — binary readers, writers, and
|
||||
validators for alkcall channels, and call-protocol handlers in the
|
||||
shape of alkhttp's `from_openapi` / `from_jsonschema` adapters.
|
||||
|
||||
Status: Phase 0 (exploration). See `docs/research/phase-0.md`.
|
||||
|
||||
[handlebars-rust]: https://github.com/sunng87/handlebars-rust
|
||||
[alktype]: https://crates.io/crates/alktype
|
||||
@@ -0,0 +1 @@
|
||||
//! alkgen — template-based codegen engine over alktype BAST documents.
|
||||
Reference in new issue
Block a user