mirror of https://github.com/smithy-lang/smithy-rs
27486aa6e4 | ||
---|---|---|
.github/workflows | ||
aws | ||
codegen | ||
codegen-test | ||
design | ||
gradle | ||
rust-runtime | ||
.gitignore | ||
.pre-commit-config.yaml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
NOTICE | ||
README.md | ||
build.gradle.kts | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
settings.gradle.kts | ||
test.sh |
README.md
Smithy Rust
Smithy code generators for Rust
The nightly SDK build can be found under Actions -> CI (take latest run) -> Artifacts
All internal and external interfaces are considered unstable and subject to change without notice.
Setup
./gradlew
will setup gradle for you- Running tests requires a working Rust installation. See Rust docs for installation instructions on your platform. Minimum supported Rust version is the latest released Rust version, although older versions may work.
Run tests
./test.sh
This will run all the unit tests, codegen example models & Dynamo DB, validate that the generated code compiles, and run any tests targeting the generated code.
Development
For development, pre-commit hooks may be useful. Setup:
brew install pre-commit # (or appropriate for your platform: https://pre-commit.com/)
pre-commit install
Project Layout
aws
: AWS specific codegen & Rust code (signing, endpoints, customizations, etc.)codegen
: Whitelabel Smithy code generationcodegen-test
: Smithy protocol test generation & integration tests for Smithy whitelabel code