Skip to content

Add docs, Makefile, tests, CI, and feature plan#1

Open
sa-wright wants to merge 2 commits into
masterfrom
docs/readme-for-dummies
Open

Add docs, Makefile, tests, CI, and feature plan#1
sa-wright wants to merge 2 commits into
masterfrom
docs/readme-for-dummies

Conversation

@sa-wright
Copy link
Copy Markdown
Collaborator

@sa-wright sa-wright commented Feb 25, 2026

Summary

Iterates on documentation, adds a Makefile, introduces tests and CI, and adds a feature plan in case you're bored.

Documentation

  • README: Prerequisites, quick start, language basics, shell/SSH/parallel-for examples with snippets, builtin reference (core, string/number methods, net), REPL, and project layout.
  • Makefile: build, release, test, run SCRIPT=, repl, install, check (clippy + fmt), fmt, clean, help.
  • docs/feature-plan.md: Prioritized feature plan (file I/O, argv/env, JSON, shell/SSH upgrades, REPL, etc.) and suggested implementation order.

Tests

  • Lib split: lib.rs exposes run_script() and run_script_capture(); main.rs delegates to the lib.
  • Unit tests: Lexer (scan_), parser (parse_), runtime/value (is_truthy, as_string, parse_duration, array/tuple).
  • E2E tests: tests/e2e.rs — log, arithmetic, sort, find, functions, interpolated strings, parse/runtime error handling.
  • Parser test updated for log 42Stmt::Invoke (not Expr).

CI

  • GitHub Actions: Jobs for cargo test, cargo clippy, cargo fmt --all -- --check on push/PR to main/master.
  • Runs in ubuntu:22.04; installs curl, build-essential, rustup (no composite actions or cache for act compatibility).
  • Cargo commands source $HOME/.cargo/env. Clippy runs without -D warnings so CI passes while lints are addressed over time.
  • Use act --container-architecture linux/amd64 for local CI runs.

Other

  • .gitignore: .DS_Store, .idea/, .vscode/.
  • Format: cargo fmt applied across the codebase.

…es are leeted. Added small feature plan, mostly around things I'd use personally with the help of asking Claude. No code exposed to Claude.
@sa-wright sa-wright changed the title docs: improve README, add Makefile and docs/feature-plan Add docs, Makefile, tests, CI, and feature plan Feb 25, 2026
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.

2 participants