Package org.machanism.machai.gw.reviewer

package org.machanism.machai.gw.reviewer

File-format-aware components that locate embedded @guidance directives in project files and convert them into normalized prompt fragments for Ghostwriter.

The central extension point is the Reviewer service-provider interface (SPI). Each Reviewer implementation targets one or more file types, understands the comment/string literal conventions for that format, and produces a formatted fragment suitable for downstream processing.

How reviewers are used

• Read a supported file (typically UTF-8) and detect whether it contains an @guidance directive.
• Compute a project-relative path via ProjectLayout.getRelativePath(java.io.File, java.io.File) to provide stable context independent of the local filesystem layout.
• Format the final fragment using templates loaded from the document-prompts resource bundle.

Provided reviewers

• JavaReviewer – Java source (including package-info.java)
• MarkdownReviewer – Markdown
• HtmlReviewer – HTML/XML
• TypeScriptReviewer – TypeScript
• PythonReviewer – Python
• PumlReviewer – PlantUML
• TextReviewer – Plain @guidance.txt files

See Also:

• Reviewer

Class	Description
HtmlReviewer	Reviewer implementation for HTML and XML files (.html, .htm, .xml).
JavaReviewer	Reviewer implementation for Java source files (.java).
MarkdownReviewer	Reviewer implementation for Markdown files (.md).
PumlReviewer	Reviewer implementation for PlantUML files (.puml).
PythonReviewer	Reviewer implementation for Python source files (.py).
Reviewer	Service-provider interface (SPI) for components that scan project files and extract @guidance instructions for downstream processing.
TextReviewer	Reviewer implementation for generic guidance text files.
TypeScriptReviewer	Reviewer implementation for TypeScript source files (.ts).