feat(doctor): check the machine, not just the package

Every member had a doctor that knew about its own part and nothing about
what it was running on. Most reports that begin "it does not work here"
are about the machine, so the doctor now looks at that first.

Nine checks, identical in all nineteen repositories and written to be
correct on Windows, macOS and Linux without branching on which:

Which command runs Python, because the instructions used to say python3
and that is frequently absent on Windows, where the name is python or the
launcher is py. A reporter told to run a command that does not exist
reports the wrong problem.

Whether this terminal can print what the report contains, because the
point of a doctor is that its output gets pasted, and a legacy code page
turns that paste into a traceback.

Whether the checkout was rewritten to carriage returns on the way in.
Every digest over a text file disagrees while core.autocrlf is set and
none of it is the repository's fault.

How much of the 260 character Windows path budget is left. Reported on
every system, because the tree is shared, and measured from the
repository root so the number means something. Generated directories are
named and do not fail the check: pnpm nests deeply, that is real on
Windows and it is not this layout.

Then the ordinary ones: what this machine is, the default encoding, the
filesystem's case behaviour, free space, and whether git is here.

A check that throws is caught and reported as what it threw. A doctor
that dies while examining is worse than no doctor, and each of the nine
was driven against a machine that fails it before being kept.

Every issue template now requires that output and gives the command for
all three systems. Seven templates asked for nothing at all, and one
named the wrong package, so anybody following it reached a module that
does not exist.

Author: gufranco

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -12,7 +12,22 @@ body:
     id: doctor
     attributes:
       label: What the doctor says
-      description: Run `python3 -m mos65xx.doctor` and paste all of it. Sixteen parts share this package and they answer differently, so which one it was decides the answer.
+      description: |
+        Run this from the repository and paste every line, including the ones
+        that did not pass. Those are the ones worth reading, so do not trim it.
+
+        macOS and Linux:
+
+            python3 -m mos65xx.doctor
+
+        Windows, whichever of these resolves:
+
+            python -m mos65xx.doctor
+            py -3 -m mos65xx.doctor
+
+        It reports the machine as well as the package, so most answers are in
+        there already. If it will not run at all, say so here and paste whatever
+        it printed instead.
       render: text
     validations:
       required: true

README.md

@@ -4,7 +4,7 @@ Interpreters for the 65xx family, from the 6502 to the 65816, driveable from a c
 
 [![CI](https://github.com/gufranco/mos65xx-python/actions/workflows/ci.yml/badge.svg)](https://github.com/gufranco/mos65xx-python/actions/workflows/ci.yml)
 
-**16** parts, **17,900,000** state cases and **17,870,080** cycle-exact cases, **0** unexplained failures, **1,256** tests, **100%** statement and branch coverage, no dependencies
+**16** parts, **17,900,000** state cases and **17,870,080** cycle-exact cases, **0** unexplained failures, **1,298** tests, **100%** statement and branch coverage, no dependencies
 
 ```python
 from mos65xx import Cpu, SparseMemory

mos65xx/doctor.py

@@ -51,6 +51,8 @@ def _version(where: Path | None = None) -> str:
 
 ROOT = Path(__file__).resolve().parent.parent
 
+from mos65xx import environment  # noqa: E402
+
 VERSION = _version()
 
 
@@ -262,6 +264,10 @@ def report(found: Sequence[Finding]) -> list[str]:
     """The lines a person pastes into an issue."""
     unwell = [one for one in found if not one.ok]
     lines = [f"mos65xx {VERSION} on {platform.python_version()}, {platform.system()}", ""]
+    lines.append("  the machine")
+    lines.extend(environment.lines(ROOT))
+    lines.append("")
+    lines.append("  this package")
     lines.extend(one.report for one in found)
     lines.append("")
     if unwell: