feedBack/docs
Miguel_LZPF b45751164f
fix: address PR #332 review feedback
Addresses 12 of 13 review comments from Copilot and CodeRabbit on
PR #332. One comment (no-manifests in validate-plugins.yml) is
declined and answered inline; the rest are applied here.

Substantive fixes:

- .github/workflows/validate-plugins.yml — add --noconftest to the
  schema-tests step. tests/conftest.py imports structlog at module
  level, but the CI job only installs requirements-test.txt
  (pytest/httpx/jsonschema), so pytest collection would fail at
  conftest import. The schema tests don't use shared fixtures, so
  skipping conftest is safe and avoids dragging the full runtime
  requirements into a 2 KB validation job. (Copilot)

- schema/plugin.schema.json — tighten the server_files regex on both
  settings.server_files and diagnostics.server_files to match the
  runtime _validate_relpath rules in plugins/__init__.py. The
  previous regex only blocked absolute paths, drive letters,
  backslashes, and "..". The runtime also rejects "//", "./",
  "/./", and leading-dotfile segments. Schema-valid manifests are
  now also load-time-valid. Verified the regex against 12 cases:
  the 3 in-tree manifests still validate. (Copilot)

- .claude/skills/plugin-validate/SKILL.md — add a per-iteration
  plugin_ok flag so we no longer print "OK <path>" after an earlier
  FAIL in the same manifest. Schema-pass + id-mismatch previously
  produced both FAIL and OK lines for one plugin. (CodeRabbit)

- docs/websocket-protocol.md — clarify song_info.tuning array length
  is source-dependent (typically 6 guitar, 4 bass, but extended-range
  GP imports can be 7/8/5/6). Recommend highway.getStringCount() for
  the authoritative count. Line 30 already said this; the table row
  on line 12 was the stale half. (CodeRabbit)

Trivial fixes:

- .claude/rules/plugin-author.md — "wants included" -> "wants to
  include" in the settings.server_files rule. (CodeRabbit)

- Markdown MD040 — add `text` language tags to 7 bare-fence code
  blocks across AGENTS.md, docs/PLUGIN_AUTHORING.md,
  docs/testing-plugins.md, docs/plugin-logging.md, .claude/README.md,
  .claude/agents/slopsmith-reviewer.md, and
  .claude/skills/plugin-validate/SKILL.md (two fences). (CodeRabbit)

Declined:

- .github/workflows/validate-plugins.yml no-manifests -> exit 0
  (CodeRabbit suggested exit 1). Plugins in this repo are in-tree,
  not submodules (no .gitmodules, git submodule status empty), and
  the workflow has a path filter on plugins/**/plugin.json so it
  only runs when a manifest actually changes. Exit 0 is correct.
  Answered inline on the PR.

Verification:
  pytest tests/test_plugin_schema.py -v --noconftest    # 8 passed
  python -c "import json,glob,jsonschema; s=json.load(open('schema/plugin.schema.json')); [jsonschema.validate(json.load(open(p)), s) for p in sorted(glob.glob('plugins/*/plugin.json'))]"
  # ok — all 3 in-tree manifests validate against tightened schema
Signed-off-by: Miguel_LZPF <mgcdreamer@gmail.com>
2026-06-18 00:38:51 -07:00
..
benchmarks Clean release snapshot 2026-06-16 18:47:13 +02:00
diagnostics Clean release snapshot 2026-06-16 18:47:13 +02:00
skills Clean release snapshot 2026-06-16 18:47:13 +02:00
3dhighway-open-string-double-sustain.jpg Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-domains.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-recipes.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-review-preflight.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-roadmap.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-safety-matrix.md Clean release snapshot 2026-06-16 18:47:13 +02:00
diagnostics-bundle-spec.md Clean release snapshot 2026-06-16 18:47:13 +02:00
library.png Clean release snapshot 2026-06-16 18:47:13 +02:00
NOTE_FAILURE_PLAN.md Clean release snapshot 2026-06-16 18:47:13 +02:00
NOTE_FAILURE_SPEC.md Clean release snapshot 2026-06-16 18:47:13 +02:00
note-detect-tuning.md Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:04 +02:00
player-2d.jpg Clean release snapshot 2026-06-16 18:47:13 +02:00
player-3d.jpg Clean release snapshot 2026-06-16 18:47:13 +02:00
player-3d.webp Clean release snapshot 2026-06-16 18:47:13 +02:00
PLUGIN_AUTHORING.md fix: address PR #332 review feedback 2026-06-18 00:38:51 -07:00
plugin-audio-mixer.md docs: extract plugin contracts into modular docs and slim CLAUDE.md 2026-06-18 00:38:50 -07:00
plugin-capability-inventory.md Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-diagnostics.md docs: extract plugin contracts into modular docs and slim CLAUDE.md 2026-06-18 00:38:50 -07:00
plugin-keyboard-shortcuts.md docs: extract plugin contracts into modular docs and slim CLAUDE.md 2026-06-18 00:38:50 -07:00
plugin-logging.md fix: address PR #332 review feedback 2026-06-18 00:38:51 -07:00
plugin-manifest.md docs: extract plugin contracts into modular docs and slim CLAUDE.md 2026-06-18 00:38:50 -07:00
plugin-manifest.schema.json Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-sibling-imports.md docs: extract plugin contracts into modular docs and slim CLAUDE.md 2026-06-18 00:38:50 -07:00
plugin-styles.md Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-v3-ui.md Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-visualization-contracts.md docs: extract plugin contracts into modular docs and slim CLAUDE.md 2026-06-18 00:38:50 -07:00
sloppak-hand-editing.md Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:04 +02:00
sloppak-spec.md feat: add cross-tool orientation, CI schema validation, and Claude Code surfaces 2026-06-18 00:38:51 -07:00
testing-plugins.md fix: address PR #332 review feedback 2026-06-18 00:38:51 -07:00
websocket-protocol.md fix: address PR #332 review feedback 2026-06-18 00:38:51 -07:00