plan-verify 0.0.0-stage → 0.1.0

package/examples/plan-to-problems/problems.md

@@ -0,0 +1,112 @@
+# Logical problems
+
+Spec: examples/plan-to-problems/generated.ears.md
+
+These are the logical problems in the requirements. For a contradiction, which requirement should win? This report does not choose.
+
+## 1. R1 and R2 cannot both hold.
+
+They clash when a member asks to take a copy home, not a member asks to renew a copy, not a member brings a copy back, the copy was in the building, the copy was out on loan, a fine was not owed, the loan was not overdue, and the loan length was 1.
+
+R1 line 16
+"While the copy is in the building, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+
+R2 line 17
+"While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+
+R1 requires that the loan was allowed.
+R2 requires that the loan was not allowed.
+
+Which requirement should win? To keep R1, remove R2. To keep R2, remove R1. This report does not choose.
+
+Candidate repairs follow. This report does not choose one.
+
+One repair is to drop R1 and keep R2 as written.
+"While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+
+One repair is to drop R2 and keep R1 as written.
+"While the copy is in the building, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+
+One repair is to add "and the copy is not out on loan" to the condition of R1. R2 stays as written.
+"While the copy is in the building, when a member asks to take a copy home and the copy is not out on loan, the Fall Desk shall allow the loan."
+
+One repair is to add "and the copy is not in the building" to the condition of R2. R1 stays as written.
+"While the copy is out on loan, when a member asks to take a copy home and the copy is not in the building, the Fall Desk shall not allow the loan."
+
+## 2. R2 and R3 cannot both hold.
+
+They clash when a member asks to take a copy home, not a member asks to renew a copy, not a member brings a copy back, the copy was not in the building, the copy was out on loan, a fine was not owed, the loan was not overdue, and the loan length was 1.
+
+R2 line 17
+"While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+
+R3 line 18
+"While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+
+R2 requires that the loan was not allowed.
+R3 requires that the loan was allowed.
+
+Which requirement should win? To keep R2, remove R3. To keep R3, remove R2. This report does not choose.
+
+Candidate repairs follow. This report does not choose one.
+
+One repair is to drop R2 and keep R3 as written.
+"While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+
+One repair is to drop R3 and keep R2 as written.
+"While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+
+## 3. R5 and R6 cannot both hold.
+
+They clash when not a member asks to take a copy home, a member asks to renew a copy, not a member brings a copy back, the copy was not in the building, the copy was not out on loan, a fine was owed, the loan was not overdue, and the loan length was 1.
+
+R5 line 20
+"While a fine is owed, when a member asks to renew a copy, the Fall Desk shall not allow the renewal."
+
+R6 line 21
+"While a fine is owed, when a member asks to renew a copy, the Fall Desk shall allow the renewal."
+
+R5 requires that the renewal was not allowed.
+R6 requires that the renewal was allowed.
+
+Which requirement should win? To keep R5, remove R6. To keep R6, remove R5. This report does not choose.
+
+Candidate repairs follow. This report does not choose one.
+
+One repair is to drop R5 and keep R6 as written.
+"While a fine is owed, when a member asks to renew a copy, the Fall Desk shall allow the renewal."
+
+One repair is to drop R6 and keep R5 as written.
+"While a fine is owed, when a member asks to renew a copy, the Fall Desk shall not allow the renewal."
+
+## 4. Nothing covers allow the loan (loan_allowed)
+
+Nothing says whether the loan was allowed when a member asks to take a copy home, a member asks to renew a copy, a member brings a copy back, the copy was not in the building, the copy was not out on loan, a fine was owed, the loan was overdue, and the loan length was 21. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response.
+
+## 5. Nothing covers allow the renewal (renewal_allowed)
+
+Nothing says whether the renewal was allowed when a member asks to take a copy home, not a member asks to renew a copy, a member brings a copy back, the copy was in the building, the copy was out on loan, a fine was owed, the loan was overdue, and the loan length was 21. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response.
+
+## 6. Nothing covers send a reminder (reminder_sent)
+
+Nothing says whether a reminder was sent when a member asks to take a copy home, a member asks to renew a copy, a member brings a copy back, the copy was in the building, the copy was out on loan, a fine was owed, the loan was not overdue, and the loan length was 21. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response.
+
+## 7. R9 can never trigger
+
+R9 line 24
+"When a member asks to take a copy home and the loan length is at least 40, the Fall Desk shall allow the loan."
+
+R9 can never trigger. Its condition is impossible for every allowed value.
+Suggested fix: rewrite the condition in R9 so a real situation can make it true, or remove the requirement. Do not invent a response.
+
+## 8. R11 adds nothing
+
+R11 line 26
+"When a member brings a copy back and the loan is overdue, the Fall Desk shall close the loan."
+
+R11 adds nothing. It only repeats R10 in a stricter situation. Whenever R10 holds, R11 holds too.
+
+R10 line 25
+"When a member brings a copy back, the Fall Desk shall close the loan."
+
+Ask whether R11 was meant to say something R10 does not already require. Do not delete it until the product manager agrees.

package/examples/status-placed.ears.md

@@ -0,0 +1,3 @@
+# Property: the status is placed.
+
+P1 The Order System shall mark the order placed.

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "plan-verify",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Catch contradictions in EARS requirements before anyone builds them. The same TypeScript runs on Node and compiles to a native binary with ScriptC.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=24"
+  },
+  "bin": {
+    "plan-verify": "./src/main.ts"
+  },
+  "scripts": {
+    "build": "scriptc build src/main.ts -o build/plan-verify",
+    "coverage": "scriptc coverage src/main.ts --fail-on=blockers",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "node --experimental-strip-types test/run-all.ts"
+  },
+  "devDependencies": {
+    "@types/node": "24.10.0",
+    "scriptc": "0.4.1",
+    "typescript": "5.9.3"
+  },
+  "allowScripts": {
+    "scriptc@0.4.1": true
+  }
+}

package/scripts/install-scriptc.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+# Install the pinned ScriptC compiler and check the version.
+# Method: npm exact devDependency (scriptc@0.4.1), which pulls the
+# platform package @scriptc/cli-<os>-<arch> at the same version and
+# runs scripts/install-native.mjs on postinstall.
+# Lockfile: package-lock.json (npm ci reproduces this tree).
+set -eu
+cd "$(dirname "$0")/.."
+npm install --save-dev --save-exact scriptc@0.4.1
+npm install-scripts approve scriptc@0.4.1 || true
+version="$(npx scriptc --version | tr -d '\r')"
+echo "scriptc ${version}"
+if [ "$version" != "0.4.1" ]; then
+  echo "expected scriptc 0.4.1" >&2
+  exit 1
+fi