YARD-Lint is a command-line tool for Ruby and Ruby on Rails projects that lint YARD documentation.
It checks API comments for consistency, correctness, and completeness so developers can spot stale or malformed documentation alongside normal code quality checks. It’s designed for everyday development workflows as well as automated use in pre-commit hooks and CI pipelines.
This is free and open source software.
Key Features
- Checks YARD documentation for undocumented classes, modules, methods, parameters, and return values.
- Validates type declarations and catches malformed type syntax and invalid type definitions.
- Verifies tag usage, including ordering, placement, unknown tags, and common documentation mistakes.
- Can lint code examples in
@exampletags, with optional style validation using tools such as RuboCop or StandardRB. - Supports diff-based workflows, including changed, staged, and branch comparison modes for CI/CD and pre-commit use.
- Generates and updates configuration files, including baseline todo files for incremental adoption on existing codebases.
- Provides documentation coverage statistics and lets teams enforce minimum coverage thresholds.
Website: github.com/mensfeld/yard-lint
Support:
Developer: Maciej Mensfeld
License: MIT License
YARD-Lint is written in Ruby. Learn Ruby with our recommended free books and free tutorials.
Related Software
| Ruby Linters | |
|---|---|
| RuboCop | Ruby static code analyzer and formatter |
| Reek | Examines Ruby classes, modules, and methods |
| Brakeman | Static analysis tool |
| ERB Lint | Lint your ERB or HTML files |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |