shelldoc 0.91: go test ./...

Today marks the release of shelldoc version 0.91, the second release candidate on the road to 1.0. This release focuses on code quality and test coverage. shelldoc version now reports the correct version even when installed via go install.

What’s new in 0.91?

This release emphasizes stability and maintainability:

• Expanded test coverage across all major components including CLI commands, tokenizer, and JUnit XML output generation
• Improved API documentation with godoc comments added to all exported functions
• Code quality improvements fixing non-idiomatic boolean comparisons and other style issues
• Removed experimental regex matching which was incomplete and not ready for production use

Why focus on tests and code quality?

Comprehensive test coverage boosts confidence that future changes won’t introduce regressions. Once shelldoc reaches 1.0, development will change to an on-demand release model: Every bug fix will trigger a patch release. Every new feature will trigger a minor release. Mirko’s whims will decide when a major release is made (possibly never). Clean, idiomatic code simply makes the project more maintainable and welcoming to contributors.

The incomplete regex matching was removed because it’s unclear whether it’s needed. If you are sad to see it go, feel free to submit a feature request by creating a GitHub issue. Or a pull request, of course.

Installation

Install shelldoc with Go:

go install github.com/mirkoboehm/shelldoc/cmd/shelldoc@v0.91.0

Road to 1.0

Version 0.91 is the second of three planned release candidates. The final release candidate is expected in early March, with the stable 1.0 release to follow shortly after.

If you maintain documentation with shell command examples, I encourage you to try shelldoc in your CI pipeline. Feedback and contributions are welcome at the GitHub repository.

shelldoc is free and open source software, licensed under GPL v3 for the command-line tools and LGPL v3 for the reusable library components.