docs: add baseline references and workspace tasks

This commit is contained in:
Edison Jwa
2026-05-23 06:52:24 +09:00
parent 7d5d8c2c90
commit 3200312b0d
5 changed files with 8017 additions and 36 deletions
+20 -36
View File
@@ -2,9 +2,7 @@
#
# Conforms to docs/governance/repository-bootstrap-plan.md v0.1.0 §3,
# which requires a `justfile` with stubs for format / lint / test /
# verify-docs / security-scan. The repository is documentation- and
# PoC-first; until the product Flutter/Rust workspace exists, most
# targets are placeholders.
# verify-docs / security-scan.
#
# Install just: https://github.com/casey/just
@@ -25,16 +23,10 @@ verify-docs:
# Format every codebase in the repo that has a formatter wired up.
format:
@echo "[format] Rust PoCs"
@for d in poc/*/; do \
if [ -f "$$d/Cargo.toml" ]; then \
(cd "$$d" && cargo fmt --all) || exit 1; \
fi; \
done
@if [ -d poc/flutter_rust_bridge_hello ]; then \
echo "[format] Flutter PoC"; \
(cd poc/flutter_rust_bridge_hello && dart format lib test integration_test rust/src) || exit 1; \
fi
@echo "[format] Rust workspace"
cargo fmt --package chanora_audio --package chanora_bridge --package chanora_core --package chanora_diagnostics --package chanora_protocol --package chanora_state --package chanora_storage
@echo "[format] Flutter app"
cd apps/chanora_flutter && dart format lib test
# ---------------------------------------------------------------------------
# Lint
@@ -42,38 +34,30 @@ format:
# Run linters on every codebase that has them wired up.
lint:
@echo "[lint] Rust PoCs"
@for d in poc/*/; do \
if [ -f "$$d/Cargo.toml" ]; then \
(cd "$$d" && cargo clippy --all-targets -- -D warnings) || exit 1; \
fi; \
done
@if [ -d poc/flutter_rust_bridge_hello ]; then \
echo "[lint] Flutter PoC"; \
(cd poc/flutter_rust_bridge_hello && flutter analyze) || exit 1; \
fi
@echo "[lint] Rust workspace"
cargo clippy --workspace --all-targets --all-features -- -W clippy::all
@echo "[lint] Flutter app"
cd apps/chanora_flutter && flutter analyze
# ---------------------------------------------------------------------------
# Test
# ---------------------------------------------------------------------------
# Run all PoC test suites that have one.
# Run local test suites. Live/network tests remain explicitly ignored.
test:
@echo "[test] tsclientlib-connect-spike: build only (live-server smoke must be run manually)"
@(cd poc/tsclientlib-connect-spike && cargo build --release)
@echo "[test] flutter_rust_bridge_hello: headless verification"
@(cd poc/flutter_rust_bridge_hello && \
flutter build linux --debug && \
LD_LIBRARY_PATH="$$PWD/build/linux/x64/debug/bundle/lib:$$LD_LIBRARY_PATH" \
flutter test test/poc_verification_test.dart)
@echo "[test] Rust workspace"
cargo test --workspace --all-targets --all-features
@echo "[test] Flutter app"
cd apps/chanora_flutter && flutter test
# ---------------------------------------------------------------------------
# Security scan
# ---------------------------------------------------------------------------
# Placeholder — real security scanning will be wired up when the product
# workspace exists. See docs/security/dependency-and-supply-chain-report.md
# and docs/governance/repository-bootstrap-plan.md §5.
# Run the local dependency audit when cargo-audit is installed.
security-scan:
@echo "[security-scan] placeholder — no product workspace yet."
@echo "[security-scan] documentation gates live under docs/security/"
@if command -v cargo-audit >/dev/null 2>&1; then \
cargo audit; \
else \
echo "[security-scan] cargo-audit not installed; run: cargo install cargo-audit"; \
fi