Problem

Users were unable to determine which SPS (SciELO Publishing Schema) version was being used for validation when running stylechecker. This information was only available when using --loglevel INFO, which also produced verbose debug output. This led to confusion about:

• Which schema version was actually being validated
• Whether --extrasch @sps-1.10 was needed to validate against the latest version
• The difference between automatic schema detection and additional schema validation

Closes #[issue_number]

Solution

Added a sps_version field to the validation summary output. The SPS version is automatically detected from the XML file's specific-use attribute and is now included in all validation results.

Changes

• Modified packtools/stylechecker.py to include sps_version in the summary dictionary
• Updated .gitignore to exclude *.annotated.xml files

Example Output

Before:

{
  "_xml": "file.xml",
  "assets": [],
  "dtd_errors": [],
  "is_valid": true,
  "style_errors": {}
}

After:

{
  "_xml": "file.xml",
  "assets": [],
  "dtd_errors": [],
  "is_valid": true,
  "sps_version": "sps-1.9",
  "style_errors": {}
}

Benefits

• Clear visibility: Users can immediately see which SPS schema version is being validated
• No breaking changes: Adds a new field without modifying existing output structure
• Works everywhere: Available in both formatted and raw JSON output modes
• Clarifies behavior: Makes it clear that the schema is auto-detected from the XML, and --extrasch is for additional validations

Usage

# The output now shows which SPS version is being validated
stylechecker file.xml

# Example output snippet:
# "sps_version": "sps-1.9"

# The --extrasch option adds ADDITIONAL validations beyond the auto-detected one
stylechecker --extrasch @sps-1.10 file.xml
# This validates against BOTH sps-1.9 (from XML) AND sps-1.10 (additional)

Testing

• All existing tests pass (84 tests)
• Verified with multiple XML files using different SPS versions (sps-1.8, sps-1.9)
• Tested with all output modes (formatted, raw JSON, annotated)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.