Skip to content

Design-time lint: naming/PII rules, inline workbench hints, test --suite=lint #583

Closed

Description

@thomas-stegemann

Context

#189 shipped the design-time lint core across all three surfaces — CLI (bowire lint), Web-UI (workbench Lint rail + /api/lint), and MCP (bowire.lint) — with a typed rule engine, 5 built-in rules, .bowire/rules.json config (toggles + severity overrides), and a plugin SPI (IBowireLintRule discovered from loaded assemblies). This ticket carries the deferred enhancements.

Deferred from #189

  • Naming rules (methods-use-camel-case, messages-use-pascal-case, fields-no-suffix-id). Deferred because a fixed casing convention is protocol-sensitive and false-positive-prone (gRPC methods are PascalCase by convention). Needs a consistency-based design (flag mixed conventions within a service) or explicit opt-in per convention.
  • no-pii-in-error. Needs error-type identification, which BowireServiceInfo does not model yet (no distinct error type on a method).
  • Workbench inline hints — show rule violations inline on the affected method (like editor hints). The shipped UI is a Lint-rail panel listing findings; inline decoration on the Discover/method view is the follow-up.
  • bowire test --suite=lint — a lint entry point in the test runner. bowire lint --fail-on high already gates CI on findings; this is the unified-entry alias under bowire test.
  • breaking-change as a lint rule — already covered functionally by bowire diff --fail-on breaking (CLI) and the workbench service-compare (Side-by-side service version diff — schema + response comparison #182); a bowire lint --baseline fold-in would unify it under lint.

Related

Activity

  1. added this to the milestone on Aug 24, 2026
  2. thomas-stegemann commented on Sep 28, 2026

    @thomas-stegemann
    MemberAuthor

    Umgesetzt in sechs Commits; alle Punkte aus dem Ticket sind erledigt, einer davon bewusst schmaler als beschrieben.

    • bowire test --suite=lint — 8be43409, korrigiert in a71c0f1a. Nicht nur ein Alias: die Befunde gehen in die Berichtsausgänge des Test-Runners. JUnit mit einem Testfall je Regel (stabile Anzahl von Lauf zu Lauf), SARIF mit Stufe je Schweregrad und Service/Methode/Feld als logische Location, --annotations. --fail-on nimmt any/never und die Lint-Schweregrade; ohne Angabe gilt der Lint-Standard (berichten, bestehen), damit Lint beim ersten Lauf keine Pipeline bricht. Ein Schweregrad ohne --suite lint wird abgelehnt statt als any gelesen.
    • Namensregeln — a71c0f1a. Konsistenzbasiert, wie im Ticket als Ausweg genannt: BWR-LINT-MIXED-METHOD-NAMING und BWR-LINT-MIXED-FIELD-NAMING (Info) messen gegen die Mehrheit des eigenen Service, nicht gegen eine feste Schreibweise — gRPCs PascalCase und RESTs camelCase bestehen beide. Einwortnamen, Akronyme und synthetisierte REST-Namen zählen nicht mit, HTTP-Header und Cookies auch nicht. fields-no-suffix-id ist nicht dabei: ob ein Fremdschlüssel customer_id oder customer heißt, ist eine Stilfrage, keine Inkonsistenz — genau die Art Regel, die API design-time validation — typed rule engine over schemas #189 zurückgestellt hat.
    • no-pii-in-error — 2c8bc53f. BowireMethodInfo.ErrorTypes (ein init-Property, kein Konstruktorparameter), befüllt aus OpenAPI 3 und Swagger 2: jede 4xx/5xx/default-Antwort mit JSON-Schema. BWR-LINT-PII-IN-ERROR (Medium) nutzt denselben PII-Detektor wie PII-RESPONSE. gRPC und GraphQL deklarieren keine Fehlerformen — die Doku sagt deshalb, dass ein sauberes Ergebnis dort „nichts deklariert" heißt, nicht „nichts leckt".
    • Inline-Hinweise im Workbench — c4882bca. Lint läuft nach jeder Discovery im Hintergrund. Sidebar-Pille ab Low in der Farbe des schlimmsten Befunds, ein eingeklappter Streifen unter dem Methodenkopf mit allen Befunden, und Zeilen der Lint-Leiste öffnen ihre Methode — was die Doku seit API design-time validation — typed rule engine over schemas #189 versprochen hatte, ohne dass die Zeile einen Klick-Handler hatte.
    • Breaking Change als Lint-Regel — 6c3626aa. bowire lint --baseline (und --suite=lint --baseline) meldet BWR-LINT-BREAKING-CHANGE (High) mit derselben Klassifikation wie bowire diff --fail-on breaking, nicht einer zweiten. Eine Baseline ohne Services ist ein Fehler, keine leere Vergleichsbasis.

    Nebenbei gefunden und behoben

    6017df3b — ein vertippter Snapshot-Pfad ging als URL an die Discovery und kam als leere Oberfläche zurück: bowire lint C:/tippfehler.json --fail-on info meldete „No findings" mit Exit 0, bowire diff --base <fehlt> sah nichts als gebrochen. Ein CI-Schritt mit falschem Pfad blieb damit dauerhaft grün. Älter als dieses Ticket; gefunden, weil der Test für --baseline genau hier grün wurde, wo er rot sein musste.

    Doku: docs/features/lint.md — alle neuen Regeln, die Konsistenz-Idee, --baseline, --suite=lint, der Workbench-Teil, und in der Sichtbarkeitstabelle, welche Protokolle Fehlerfelder haben.

  3. modified the milestones: , v2.8 — Localisation, test pillar, MCP completion and the agent hub on Sep 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Projects

  • Status
    Done

Relationships

None yet

Development

No branches or pull requests

Issue actions