@reventlessdev/reventless-ppx 1.0.0-alpha.86 → 1.0.0-alpha.88

package/README.md

@@ -27,6 +27,21 @@ binary** installed as an optional dependency
 with no prebuilt binary (e.g. macOS x64, Linux arm64, Windows via WSL2), it is
 built from source with the OCaml toolchain (`opam` + `dune`).
 
+### The source reader
+
+The same package ships `reventless-ppx-read`, which prints one ReScript file's
+declarations as JSON, each with its span (byte offsets into the file) and source
+text: types with their cases, fields and attributes; top-level `let`s with a
+function's parameters and defaults; and the tests of a GWT file with their
+scenario-id markers and step values. It is for tools that edit source in place.
+
+```bash
+npx reventless-ppx-read [--bsc <path-to-bsc>] src/PlaceOrder.res
+```
+
+The file is parsed by the workspace's own ReScript compiler (found under
+`node_modules/@rescript`, or given with `--bsc`); nothing is built.
+
 ## Where it fits
 
 This is build tooling shared across the framework and its example apps, not a

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@reventlessdev/reventless-ppx",
-  "version": "1.0.0-alpha.86",
+  "version": "1.0.0-alpha.88",
   "description": "ReScript PPX to eliminate boilerplate from Reventless application code",
   "license": "Apache-2.0",
   "files": [
-    "bin"
+    "bin",
+    "read"
   ],
   "bin": {
-    "reventless-ppx": "bin"
+    "reventless-ppx": "bin",
+    "reventless-ppx-read": "read"
   },
   "scripts": {
     "build:ppx": "cd src && opam exec -- dune build",
@@ -16,8 +18,8 @@
     "test": "./test/run.sh"
   },
   "optionalDependencies": {
-    "@reventlessdev/reventless-ppx-darwin-arm64": "^1.0.0-alpha.85",
-    "@reventlessdev/reventless-ppx-linux-x64": "^1.0.0-alpha.85"
+    "@reventlessdev/reventless-ppx-darwin-arm64": "^1.0.0-alpha.87",
+    "@reventlessdev/reventless-ppx-linux-x64": "^1.0.0-alpha.87"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"

package/read

@@ -0,0 +1,41 @@
+#!/bin/sh
+# Resolve and exec reventless-ppx-read, the source reader, for the current platform.
+#
+#   reventless-ppx-read [--bsc <path-to-bsc>] <file.res>
+#
+# Prints the file's declarations with their spans as JSON
+# (docs/plans/source-reader-with-spans.md). The binary ships beside ppx.exe in the
+# per-platform package, and is found the way `bin` finds ppx.exe: sibling,
+# nested, or hoisted to an ancestor node_modules, then a local dune build.
+DIR="$(cd "$(dirname "$0")" && pwd)"
+
+case "$(uname -s)-$(uname -m)" in
+  Linux-x86_64)   PKG="linux-x64" ;;
+  Linux-aarch64)  PKG="linux-arm64" ;;
+  Darwin-x86_64)  PKG="darwin-x64" ;;
+  Darwin-arm64)   PKG="darwin-arm64" ;;
+  *) echo "reventless-ppx-read: unsupported platform $(uname -s)-$(uname -m)" >&2; exit 1 ;;
+esac
+
+# `-f`, then restore +x: installing from a tarball can drop the mode (see `bin`).
+for CAND in \
+  "$DIR/../reventless-ppx-$PKG/read.exe" \
+  "$DIR/node_modules/@reventlessdev/reventless-ppx-$PKG/read.exe"; do
+  if [ -f "$CAND" ]; then chmod u+x "$CAND" 2>/dev/null; exec "$CAND" "$@"; fi
+done
+
+ANCESTOR="$DIR"
+while [ "$ANCESTOR" != "/" ] && [ -n "$ANCESTOR" ]; do
+  ANCESTOR="$(dirname "$ANCESTOR")"
+  CAND="$ANCESTOR/node_modules/@reventlessdev/reventless-ppx-$PKG/read.exe"
+  if [ -f "$CAND" ]; then chmod u+x "$CAND" 2>/dev/null; exec "$CAND" "$@"; fi
+done
+
+# PPX development: the dune build in this package.
+CAND="$DIR/src/_build/default/read/read.exe"
+if [ -f "$CAND" ]; then exec "$CAND" "$@"; fi
+
+echo "reventless-ppx-read: no binary found for $(uname -s)-$(uname -m)." >&2
+echo "  Expected read.exe in @reventlessdev/reventless-ppx-$PKG," >&2
+echo "  or a local build at $DIR/src/_build/default/read/read.exe." >&2
+exit 1