0.0
Repository is archived
No release in over 3 years
Low commit activity in last 3 years
A danger plugin for validating documentation generated with jazzy
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 0.8.15
~> 2.14
~> 3.1.5
>= 0
~> 12.3.0
~> 3.4
~> 0.52.1
~> 0.9.12

Runtime

~> 2.1.0
 Project Readme

Warning This repository is no longer maintained.


danger-jazzy

Build Status Coveralls Gem

Also available for Swift - check out DangerJazzy 🎉

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