A Ruby code analysis tool and documentation generator.
As part of my effort to build better project documentation, I needed a better code analysis tool. While less featured than some of the more mature alternatives, this library focuses on the needs of documentation generation, including speed, cross-referencing and (eventually) multi-language support.
Please see the project documentation for more details.
-
Getting Started - This guide explains how to use
decodefor source code analysis. -
Code Coverage - This guide explains how to compute documentation code coverage.
-
Extract Symbols - This example demonstrates how to extract symbols using the index. An instance of
Decode::Indexis used for loading symbols from source code files. These symbols are available as a flat list and as a trie structure. You can look up specific symbols using a reference usingDecode::Index#lookup.
Please see the project releases for all releases.
- Add support for
@constant [Type] Description.tags. - Add support for instance variable type inference from
@attributetags. - Add support for method visibility in RBS output.
- Fix handling of
&blockarguments in call nodes.
- Fix handling of definitions nested within
if/unless/elsif/elseblocks.
We welcome contributions to this project.
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create new Pull Request.
In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.