kcl-lib

Crates.iokcl-lib
lib.rskcl-lib
version0.1.67
sourcesrc
created_at2023-08-29 01:25:56.828004
updated_at2024-06-25 17:37:28.282539
descriptionKittyCAD Language implementation and tools
homepage
repositoryhttps://github.com/KittyCAD/modeling-app
max_upload_size
id957507
size13,558,833
crate-owners (github:kittycad:crate-owners)

documentation

README

KCL

Our language for defining geometry and working with our Geometry Engine efficiently. Short for KittyCAD Language, named after our Design API.

Contributing a standard library function

We've built a lot of tooling to make contributing to KCL easier. If you are interested in contributing a new standard library function to KCL, here is the rough process:

  1. Open just the wasm-lib folder in your editor of choice. VS Code, for example, struggles to run rust-analyzer on the entire modeling-app directory because it's such a turducken of TS and Rust code.
  2. Find the definition for similar standard library functions in ./kcl/src/std and place your new one near it or in the same category file.
  3. Add your new code. A new standard library function consists of:
  4. A pub async of the actual standard library function in Rust
  5. A doc comment block containing at least one example using your new standard library function (the Rust compiler will error if you don't provide an example our teammates are dope)
  6. A stdlib macro providing the name that will need to be written by KCL users to use the function (this is usually a camelCase version of your Rust implementation, which is named with snake_case)
  7. An inner function that is published only to the crate
  8. Add your new standard library function to the long list of CORE_FNS in mod.rs
  9. Get a production Zoo dev token and run export KITTYCAD_API_TOKEN=your-token-here in a terminal
  10. Run TWENTY_TWENTY=overwrite cargo nextest run --workspace --no-fail-fast to take snapshot tests of your example code running in the engine
  11. Run EXPECTORATE=overwrite cargo test --all generate_stdlib -- --nocapture to generate new Markdown documentation for your function that will be used to generate docs on our website.
  12. Create a PR in GitHub.
Commit count: 1643

cargo fmt