Skip to content

Conversation

@bendichter
Copy link
Contributor

Add support for multiple report output formats based on file extension:

  • .md files use Markdown format with #/##/### headings
  • .html/.htm files use styled HTML with color-coded importance levels
  • All other extensions default to RST format

Introduce MessageFormatter base class with RstFormatter, MarkdownFormatter, and HtmlFormatter implementations for programmatic use.

Update CLI and library documentation with usage examples.

Closes #153

Add support for multiple report output formats based on file extension:
- .md files use Markdown format with #/##/### headings
- .html/.htm files use styled HTML with color-coded importance levels
- All other extensions default to RST format

Introduce MessageFormatter base class with RstFormatter, MarkdownFormatter,
and HtmlFormatter implementations for programmatic use.

Update CLI and library documentation with usage examples.

Closes #153
@codecov-commenter
Copy link

Codecov Report

❌ Patch coverage is 80.51948% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.73%. Comparing base (59ef74b) to head (ee7adec).

Files with missing lines Patch % Lines
src/nwbinspector/_formatting.py 88.57% 8 Missing ⚠️
src/nwbinspector/_nwbinspector_cli.py 0.00% 7 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##              dev     #655      +/-   ##
==========================================
+ Coverage   77.41%   81.73%   +4.31%     
==========================================
  Files          47       47              
  Lines        1656     1708      +52     
==========================================
+ Hits         1282     1396     +114     
+ Misses        374      312      -62     
Files with missing lines Coverage Δ
src/nwbinspector/_nwbinspector_cli.py 0.00% <0.00%> (ø)
src/nwbinspector/_formatting.py 82.63% <88.57%> (+12.28%) ⬆️

... and 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: specifiable output format

3 participants