Skip to content

Style/RuboCop: Finalize YARD documentation and fix lints in Core/Modules dispatchers#21146

Open
Ganesh-abc wants to merge 2 commits intorapid7:masterfrom
Ganesh-abc:master
Open

Style/RuboCop: Finalize YARD documentation and fix lints in Core/Modules dispatchers#21146
Ganesh-abc wants to merge 2 commits intorapid7:masterfrom
Ganesh-abc:master

Conversation

@Ganesh-abc
Copy link

@Ganesh-abc Ganesh-abc commented Mar 19, 2026

This PR focuses on improving YARD documentation for command dispatcher components as part of issue #21142.
Working on these files also helps me better understand the dispatcher architecture for my GSoC proposal.

This PR achieves 100% RuboCop compliance and adds comprehensive YARD documentation for the Core and Modules command dispatchers.

Key Changes:

  • Added YARD-style documentation to methods in lib/msf/ui/console/command_dispatcher/core.rb and lib/msf/ui/console/command_dispatcher/modules.rb.
  • Fixed over 6,000 combined line offenses related to layout, indentation, and Ruby style guide standards.
  • This cleanup ensures a modern, readable foundation for the command layer, supporting my GSoC 2026 proposal for automated environment provisioning.

The "Verification" Section

Replace the checklist in the template with this:

  • Verify Ruby Syntax: Ran ruby -c lib/msf/ui/console/command_dispatcher/core.rb and modules.rb. Result: Syntax OK.
  • Verify Linting: Ran bundle exec rubocop lib/msf/ui/console/command_dispatcher/core.rb (and modules.rb). Result: 0 offenses.
  • Functional Test: Started msfconsole.
  • Functional Test: Ran help to ensure the Core dispatcher loads.
  • Functional Test: Ran search type:exploit to ensure the Modules dispatcher functions correctly.
  • Verify Documentation: Ran yard doc to ensure documentation renders without errors.

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

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants