Run a code review

A cited report of a legacy project's dead logic, unused tags, documentation gaps and migration blockers.

The code review reads one imported project through the common code model and reports, each finding cited with its plc:// source:

• dead logic: function blocks and functions nothing calls or instantiates, and code whose written tags nothing reads;
• unused tags: tags nothing reads or writes, written but never read, or read but never written. Field I/O, operator settings and tags used by the HMI, an alarm, an interlock or a sequence are never reported as unused;
• documentation gaps: I/O tags with no description or no entry in the site tag list, alarms with no entry and operator response in the alarm list, interlocks with no entry in the cause-and-effect matrix;
• migration readiness: per program unit, the constructs an automatic migration cannot convert (for example instruction list, vendor-specific languages, SFC bodies kept opaque).

Run it

python -m edge.code_review --vendor siemens --out build/code-review.md
python -m edge.code_review --plant machine-builders --out build/code-review.pdf
python -m edge.code_review --vendor rockwell --no-lists --out build/code-review.json   # without the site list checks

--plant picks the plant (the bench by default) and --vendor whose export to review (the plant's default otherwise). The report is Markdown, PDF or JSON by the file extension, or printed when --out is left out.

It is read-only: the code export and the site lists are read into memory, and nothing is written to a plant system or the platform store.