danger-jazzy

This is a danger plugin to check for undocumented symbols via Jazzy.

Fail on undocumented symbols in modified files.

jazzy.check

Fail on undocumented symbols in all files.

jazzy.check fail: :all

Warn about undocumented symbols in modified files.

jazzy.check warn: :modified

Write custom handling for undocumented symbols in modified files.

jazzy.undocumented.each do |item|
    message "You forgot to document this", file:item.file, line:item.line
end

Write a custom handling for undocumented symbols in all files.

jazzy.undocumented(:all).each do |item|
    message "You forgot to document this", file:item.file, line:item.line
end

Attributes

path - Path to the docs folder, defaults to 'docs/'.

ignore - List of files to ignore, defaults to [].

message - Message to display, defaults to Undocumented symbol %<symbol>s in *%<file>s*.

inline_message - Message to display inline, defaults to Undocumented symbol %<symbol>s.

Methods

check - Checks files for modified symbols.

Takes a hash with the following keys:

• fail
• warn

Available scopes:

• modified
• all

undocumented - Returns a list of undocumented symbols in the current diff.

Available scopes:

• modified
• all