docs: add README.org for repl, tangle, org-eval, verify-repl tools

This commit is contained in:
2026-05-13 12:58:07 -04:00
parent a2a7b4ca08
commit b234ef2439
4 changed files with 90 additions and 0 deletions

View File

@@ -0,0 +1,30 @@
#+TITLE: verify-repl
Compliance checker for literate programming discipline. Scans .org files
for violations of the REPL-first and one-per-block rules.
== Usage
#+begin_src shell
verify-repl org/
verify-repl projects/passepartout/org/
#+end_src
== Checks performed
1. **REPL-first** — every ~(defun|defmacro|defvar|defstruct|defmethod|defclass)~
block must have ~;; REPL-VERIFIED: <timestamp>~ on the line above
~#+begin_src lisp~. Any definition block without this comment is a violation.
2. **One-per-block** — each ~#+begin_src lisp~ block must contain exactly one
top-level form. Multiple defuns in the same block are a violation.
3. **Prose-before-code** — each code block must be preceded by an Org headline
(the prose explanation). Blocks without a preceding headline are a violation.
== Exempt files
Some core infrastructure files are blacklisted (package definitions, setup),
defined in the script's ~BLACKLIST~ array. Extend as needed.
== Dependencies
Bash, grep.