Skip to content

πŸ“ docs: clarify release example contract#18

Merged
zrr1999 merged 1 commit into
mainfrom
docs/release-example-contract
May 4, 2026
Merged

πŸ“ docs: clarify release example contract#18
zrr1999 merged 1 commit into
mainfrom
docs/release-example-contract

Conversation

@zrr1999
Copy link
Copy Markdown
Member

@zrr1999 zrr1999 commented May 1, 2026

Summary

  • Convert examples/hello.sp into a pure standalone example that does not rely on platform imports.
  • Update README example contract from format/check/build to format/check/run for examples.
  • Clarify direct imported platform API calls versus lower-level effect-handler syntax.
  • Align CI with the documented examples contract by checking/running examples without native-building the project-mode foreign-function app.

Validation

  • spore format --check examples/hello.sp && spore check examples/hello.sp && spore run examples/hello.sp
  • cd examples/hello-app && spore format --check src/main.sp && spore check src/main.sp && spore run src/main.sp
  • spore format --check && find src/basic_cli -name "*.sp" -type f | sort | xargs -n 1 spore check && spore check examples/hello.sp && spore check examples/hello-app/src/main.sp && find src/basic_cli -name "*.sp" -type f | sort | xargs -n 1 spore build
  • uvx --from spore-lang==0.0.3 spore format --check plus CI-equivalent Spore check/build/run commands for platform modules and examples
  • uvx --from spore-lang==0.0.3 spore test
  • cargo fmt --check && cargo clippy --all-targets --all-features -- -D warnings && cargo test --all-targets --all-features

Notes

  • Local spore is 0.0.2 and spore test fails with module basic_cli.stdout not found; CI-equivalent spore-lang==0.0.3 reports note: no spec clauses found and exits successfully.
  • Native spore build remains covered for src/basic_cli platform API files; project-mode examples/hello-app is checked and run until backend support for foreign/platform lowering lands.

@zrr1999 zrr1999 changed the title docs: clarify release example contract πŸ“ docs: clarify release example contract May 1, 2026
@zrr1999 zrr1999 merged commit 9645feb into main May 4, 2026
5 of 7 checks passed
@zrr1999 zrr1999 deleted the docs/release-example-contract branch May 4, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant