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

@@ -15,16 +15,22 @@ body:
     attributes:
       label: What the doctor says
       description: |
-        Run `python3 -m snesdsp.doctor` from the repository and paste all of it,
-        including any line that did not pass. Do not trim it: the lines that
-        failed are the ones worth reading.
-      render: text
-      placeholder: |
-        snesdsp 2.1.0 on 3.13.0, Linux
+        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 snesdsp.doctor
 
-          ok    python: 3.13.0 on Linux x86_64
-             !  dsp2: no image for dsp2
-                 put a copy you own in ...
+        Windows, whichever of these resolves:
+
+            python -m snesdsp.doctor
+            py -3 -m snesdsp.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
 

.github/ISSUE_TEMPLATE/wrong_answer.yml

@@ -14,7 +14,22 @@ body:
     id: doctor
     attributes:
       label: What the doctor says
-      description: Run `python3 -m snesdsp.doctor` and paste all of it.
+      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 snesdsp.doctor
+
+        Windows, whichever of these resolves:
+
+            python -m snesdsp.doctor
+            py -3 -m snesdsp.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 @@ The NEC uPD77C25 as Nintendo shipped it, running the microcode you supply rather
 
 [![CI](https://github.com/gufranco/snes-dsp-python/actions/workflows/ci.yml/badge.svg)](https://github.com/gufranco/snes-dsp-python/actions/workflows/ci.yml)
 
-**6** parts across **5** microcodes, **0** commands described by hand, **112** exchanges read out of **36** real cartridges compared, **0** failures, **878** tests, **100%** statement and branch coverage, no dependencies
+**6** parts across **5** microcodes, **0** commands described by hand, **112** exchanges read out of **36** real cartridges compared, **0** failures, **920** tests, **100%** statement and branch coverage, no dependencies
 
 ```python
 from snesdsp import Chip

pyproject.toml

@@ -68,6 +68,10 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
+# The environment checks are the same shape and exist for the same reason: they
+# report what a machine is, so a check that throws has to become a line in the
+# report rather than end the run, and its output is the product.
+"snesdsp/environment.py" = ["BLE001", "T201"]
 # A test file sits beside the module it covers and is named after it, so its
 # module name carries a dot that N999 rejects. The layout is deliberate: a
 # module and its tests are read together.

snesdsp/doctor.py

@@ -33,6 +33,8 @@
 
 ROOT = Path(__file__).resolve().parent.parent
 
+from snesdsp import environment  # noqa: E402
+
 if str(ROOT) not in sys.path:
     sys.path.insert(0, str(ROOT))
 
@@ -313,6 +315,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"snesdsp {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: