♻️ refactor: align basic-cli with effect terminology#13
Merged
Conversation
- Revised terminology from "capabilities" to "effects" throughout documentation. - Updated `spore.toml` to replace `handles` with `handled-effects`. - Adjusted comments in source files to align with the new effect tracking model. - Cleaned up example application and CI workflow for consistency with new terminology.
- Replaced manual commands with direct `spore` CLI invocations for formatting, checking, building, running, and testing Spore files. - Simplified the workflow by removing legacy compatibility checks and consolidating commands for clarity and efficiency.
zrr1999
force-pushed
the
refactor/effect-terminology-cutover-rebased
branch
from
c671ba5 to
abdbb39
Compare
- Replaced legacy checkout steps with a direct setup action for the Spore CLI. - Updated the installation command to use the new `uv tool install` method. - Simplified the test execution step by removing unnecessary directory checks.
- Added actionlint as a repository in prek.toml for static checks. - Removed the standalone actionlint job from the CI workflow to streamline the process.
There was a problem hiding this comment.
Pull request overview
This PR aligns the basic-cli platform package with Spore’s updated “effects” terminology by updating manifests, docs, and module comments, while also adjusting CI and a few syntax details to stay compatible with the current compiler/tooling.
Changes:
- Rename manifest keys and documentation language from capability-era terms to effect/handled-effects terminology (and drop obsolete
Computedeclarations). - Update platform contract/host shims and example code to match current formatting/syntax expectations.
- Simplify CI Spore validation by installing the Spore CLI via
uv, and move actionlint intoprekhooks.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/platform_contract.sp |
Contract function formatting/syntax update and adapter call terminator change. |
src/host.sp |
Keep legacy adapter shim in sync with updated call syntax. |
src/basic_cli/stdout.sp |
Doc terminology updated to “effect-gated”. |
src/basic_cli/file.sp |
Doc terminology updated to “effect-gated”. |
src/basic_cli/cmd.sp |
Doc terminology updated to “effect tracking”. |
spore.toml |
Replace handles/[capabilities] with handled-effects and remove Compute. |
prek.toml |
Add actionlint as a prek-managed hook. |
examples/hello-app/src/main.sp |
Example comment/style refresh and statement terminator update. |
examples/hello-app/spore.toml |
Remove obsolete [capabilities] allow = ["Compute"]. |
README.md |
Terminology/link updates and removal of obsolete manifest snippet section. |
.github/workflows/ci-tests.yml |
Install Spore CLI via uv and simplify Spore format/check/build/run/test steps. |
.github/workflows/ci-static-checks.yml |
Remove standalone actionlint job (now covered via prek). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Upgraded the Spore CLI installation from version 0.0.2 to 0.0.3 in the CI workflow to ensure compatibility with the latest features and fixes.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
spore-pre-commitas the published hook source for Spore formattingsrc/basic_cli/**/*.spand top-levelexamples/*.spthat work with the released CLI todayspore-checkout of prek for now becausespore-lang==0.0.2still rejects the currentspore.tomlschema ([platform].handles)Validation
uvx --from prek prek run --all-filesNotes