Review a plan
Report what is true of a .arch plan and what is wrong with it, from the compiler's own facts.
If archlang is not on the path, write npx -y @chanmeng666/archlang in its place.
Never run a bare arch: on Linux, macOS and Git Bash that name is the coreutils command.
This skill is a workflow, not a language reference. Run archlang spec for the language,
archlang context --section errors for the diagnostic catalog, and archlang <cmd> --help for flags.
The checks are drafting heuristics. They do not establish that a plan meets a building code, and
your report must not say that it does.
Steps
- Does it compile?
archlang validate plan.arch --json. Errors come first in the report; a plan
with errors has no facts to review until they are fixed.
- Read the facts.
archlang describe plan.arch --json gives rooms with areas and uses, what each
door and window connects, the access graph and the totals. On a large plan narrow it:
archlang describe plan.arch --select rooms,access,totals --json. area_m2 is measured on wall
centrelines, so it counts the wall bands that stand on the room; net_area_m2 subtracts them.
Say which one you quote.
- Run the default lint.
archlang lint plan.arch --json. Each warning has a code, a place in the
source and a fix in prose. archlang explain <CODE> --json explains a code you do not know.
- Run the accessibility profile when the user asks about access, or when the brief mentions
a wheelchair, step-free access or ageing in place:
archlang lint plan.arch --profile accessibility-advisory --json.
- Check against the brief, if there is one. Write the brief's checkable requirements as an
intent file: room count only if the brief lists the rooms, an area band only where the brief
gives a number. The format is the JSON Schema at https://archlang.uk/intent.schema.json,
explained at https://archlang.uk/intent; a malformed file is refused with exit
3 and the
path of the bad field. Then run
archlang validate plan.arch --intent intent.json --feedback --json. A failed gating assertion
exits 2 and comes with a correction prompt for each violation.
archlang score plan.arch --brief intent.json --json gives the same comparison as a number that
never fails.
- Ask for candidate fixes. For an unreachable room, a building with no entrance, a bathroom
reached only through a bedroom, or a bedroom with no window,
archlang suggest plan.arch --json
returns door and window statements with a reason for each. Put them in the report as options.
Do not apply them.
- Look at it, if that helps.
archlang preview plan.arch --ascii prints a text plan;
archlang preview plan.arch -o plan.png renders an image. archlang compile plan.arch --overlay circulation -o walk.svg
draws the walking routes and their narrow points.
Report to the user
Order the findings so the user can act on them:
- Errors: the plan does not compile, with each diagnostic.
- Brief: each requirement the plan misses, with the measured value beside the asked value.
- Soundness: each lint warning, grouped by room, with the fix the diagnostic proposes.
- What you did not check, for example "no brief was given, so nothing was compared to one".
State which lint profile produced each warning. Do not call a warning-free plan compliant, safe
or approved: say that the checks you ran raised nothing.
When something goes wrong
--code and --severity on archlang lint and archlang validate only filter what is shown. ok and
the exit code still count every diagnostic, so a filtered result is not a clean one.
- Exit code
3 is a wrong flag: run archlang <cmd> --help.
1---2name: archlang-review-plan3description: Use when the user wants an existing ArchLang .arch floor plan checked rather than changed, e.g. "review this plan", "does this layout meet the brief?", "is every room reachable?", "check it for accessibility", "why does lint complain?". Reads the plan's facts, runs the lint profiles and the intent gate through the archlang CLI, and reports findings with suggested fixes. It edits nothing unless asked.4license: MIT5compatibility: Needs a shell with Node 18+ and the archlang CLI (npx -y @chanmeng666/archlang, or npm i -g @chanmeng666/archlang for a global archlang).6metadata:7 source: https://skillmd.com/skills/chanmeng666/archlang-review-plan8---910# Review a plan1112Report what is true of a `.arch` plan and what is wrong with it, from the compiler's own facts.13If `archlang` is not on the path, write `npx -y @chanmeng666/archlang` in its place.14Never run a bare `arch`: on Linux, macOS and Git Bash that name is the coreutils command.1516This skill is a workflow, not a language reference. Run `archlang spec` for the language,17`archlang context --section errors` for the diagnostic catalog, and `archlang <cmd> --help` for flags.1819The checks are drafting heuristics. They do not establish that a plan meets a building code, and20your report must not say that it does.2122## Steps23241. **Does it compile?** `archlang validate plan.arch --json`. Errors come first in the report; a plan25 with errors has no facts to review until they are fixed.262. **Read the facts.** `archlang describe plan.arch --json` gives rooms with areas and uses, what each27 door and window connects, the access graph and the totals. On a large plan narrow it:28 `archlang describe plan.arch --select rooms,access,totals --json`. `area_m2` is measured on wall29 centrelines, so it counts the wall bands that stand on the room; `net_area_m2` subtracts them.30 Say which one you quote.313. **Run the default lint.** `archlang lint plan.arch --json`. Each warning has a code, a place in the32 source and a `fix` in prose. `archlang explain <CODE> --json` explains a code you do not know.334. **Run the accessibility profile when the user asks about access,** or when the brief mentions34 a wheelchair, step-free access or ageing in place:35 `archlang lint plan.arch --profile accessibility-advisory --json`.365. **Check against the brief, if there is one.** Write the brief's checkable requirements as an37 intent file: room count only if the brief lists the rooms, an area band only where the brief38 gives a number. The format is the JSON Schema at <https://archlang.uk/intent.schema.json>,39 explained at <https://archlang.uk/intent>; a malformed file is refused with exit `3` and the40 path of the bad field. Then run41 `archlang validate plan.arch --intent intent.json --feedback --json`. A failed gating assertion42 exits `2` and comes with a correction prompt for each violation.43 `archlang score plan.arch --brief intent.json --json` gives the same comparison as a number that44 never fails.456. **Ask for candidate fixes.** For an unreachable room, a building with no entrance, a bathroom46 reached only through a bedroom, or a bedroom with no window, `archlang suggest plan.arch --json`47 returns door and window statements with a reason for each. Put them in the report as options.48 Do not apply them.497. **Look at it, if that helps.** `archlang preview plan.arch --ascii` prints a text plan;50 `archlang preview plan.arch -o plan.png` renders an image. `archlang compile plan.arch --overlay circulation -o walk.svg`51 draws the walking routes and their narrow points.5253## Report to the user5455Order the findings so the user can act on them:56571. Errors: the plan does not compile, with each diagnostic.582. Brief: each requirement the plan misses, with the measured value beside the asked value.593. Soundness: each lint warning, grouped by room, with the fix the diagnostic proposes.604. What you did not check, for example "no brief was given, so nothing was compared to one".6162State which lint profile produced each warning. Do not call a warning-free plan compliant, safe63or approved: say that the checks you ran raised nothing.6465## When something goes wrong6667- `--code` and `--severity` on `archlang lint` and `archlang validate` only filter what is shown. `ok` and68 the exit code still count every diagnostic, so a filtered result is not a clean one.69- Exit code `3` is a wrong flag: run `archlang <cmd> --help`.