YARD-Lint is a command-line linter for documentation written with YARD. It checks documentation alongside Ruby source code so that missing information, malformed tags, invalid types and inconsistencies can be detected as part of the normal development process.
The tool goes beyond simple formatting checks. It can compare documentation with method definitions, validate configuration before processing a project and support incremental adoption on codebases where fixing every existing warning immediately would be impractical.
This is free and open source software.
Key Features
- Checks documentation coverage for classes, modules, methods, parameters and return values.
- Validates YARD type declarations, including malformed syntax, invalid definitions and suspicious constant names.
- Checks tag ordering, placement, unknown tags and other common documentation mistakes.
- Validates code contained in example blocks and can optionally apply RuboCop or Standard Ruby style checks to examples.
- Reports source files that YARD cannot parse instead of silently skipping them.
- Supports changed-file, staged-file and branch-diff modes for use in pre-commit and continuous integration workflows.
- Can generate a baseline todo configuration, allowing existing projects to introduce documentation linting incrementally.
- Calculates documentation coverage statistics and can enforce a minimum coverage threshold.
- Validates its own configuration and provides suggestions for misspelled settings, parameters and tags.
- Can explain individual validators from the command line, including their purpose, severity, configuration and examples.
- Accepts source through standard input for editor and language-server integrations and provides output suitable for editor quickfix lists.
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 |
| Standard Ruby | Provides an opinionated, unconfigurable ruleset |
| HAML-Lint | Ruby-based linter for HAML templates |
| Slim-Lint | Configurable tool for analyzing Slim templates |
| ERB Lint | Lint your ERB or HTML files |
| YARD-Lint | For Ruby and Ruby on Rails projects that lint YARD documentation |
| oxicop | Fast Ruby linter |
Read our verdict in the software roundup.
 LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README. |
Please read our Comment Policy before commenting.