Module: HTMLProofer

Defined in:
lib/html-proofer.rb,
lib/html-proofer/log.rb,
lib/html-proofer/cache.rb,
lib/html-proofer/check.rb,
lib/html-proofer/issue.rb,
lib/html-proofer/utils.rb,
lib/html-proofer/runner.rb,
lib/html-proofer/element.rb,
lib/html-proofer/version.rb,
lib/html-proofer/middleware.rb,
lib/html-proofer/configuration.rb,
lib/html-proofer/url_validator.rb

Defined Under Namespace

Modules: Configuration, Utils Classes: Cache, Check, Element, Issue, Log, Middleware, Runner, SortedIssues, UrlValidator

Constant Summary collapse

VERSION = 
'3.19.3'

Class Method Summary collapse

Class Method Details

.check_directories(directories, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


39
40
41
42
43
44
45
46
47
 
# File 'lib/html-proofer.rb', line 39

def self.check_directories(directories, options = {})
  raise ArgumentError unless directories.is_a?(Array)

  options[:type] = :directory
  directories.each do |directory|
    raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
  end
  HTMLProofer::Runner.new(directories, options)
end

.check_directory(directory, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
 
# File 'lib/html-proofer.rb', line 31

def self.check_directory(directory, options = {})
  raise ArgumentError unless directory.is_a?(String)
  raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)

  options[:type] = :directory
  HTMLProofer::Runner.new([directory], options)
end

.check_file(file, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


23
24
25
26
27
28
29
 
# File 'lib/html-proofer.rb', line 23

def self.check_file(file, options = {})
  raise ArgumentError unless file.is_a?(String)
  raise ArgumentError, "#{file} does not exist" unless File.exist?(file)

  options[:type] = :file
  HTMLProofer::Runner.new(file, options)
end

.check_links(links, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


49
50
51
52
53
54
 
# File 'lib/html-proofer.rb', line 49

def self.check_links(links, options = {})
  raise ArgumentError unless links.is_a?(Array)

  options[:type] = :links
  HTMLProofer::Runner.new(links, options)
end