rdoc_link_checker 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d49154c855b923e70e92faf6e9206627a1e1793d3f93e9a6bf24c137c203f5
-  data.tar.gz: c93421e52ad4f531ba57ab1cfd47e4996016621ec7f281b30a50ca4c76136c23
+  metadata.gz: eb872be04882f5f7d1766531b096683198244ac46f1997e896e65e7f79cb3f47
+  data.tar.gz: 47768288623da2a9bf3610c4404ef5bdf704098a6572daeecae5400ab7e81987
 SHA512:
-  metadata.gz: f7e745ab474bec8a54e49ffc259a3f91a58231166f8c723c352e2235dba33fe1ef2db56b9f918d784b0f0caca6a145aacad5b669cd3c49b3d90fd6179684d2ff
-  data.tar.gz: da062b580efb28b8fce02ab8b30f58270b4e08aabeab86a8441b7de68cd172a5fe13aa59274d6da2219e35cfd1bc0817308237f71d570db144a0a5ccb892e3f7
+  metadata.gz: 743c976e0ad98d6f624d3d7856504944ce82c0455a94fe693bf4b508eb9dada4b1c3f8d1d19211a8d9dbff96c6ff25e708ed1193afd8bc0cf036ca3eff614cc4
+  data.tar.gz: 7f670d5f69e16259d1f6eeb555f38a2631eb6e8b53be91ab5a5d7a78f33e5fff40533c4438fe6024c465ddd894f876759097a099020c5860cd9843285bfdf0a2

data/bin/rdoc_link_checker

@@ -4,11 +4,11 @@ require 'getoptlong'
 require_relative '../lib/rdoc_link_checker'
 
 options = GetoptLong.new(
-  ['--html_dirpath', '-d', GetoptLong::REQUIRED_ARGUMENT],
-  ['--onsite_only', '-l', GetoptLong::NO_ARGUMENT],
-  ['--no_toc',      '-n', GetoptLong::NO_ARGUMENT],
-  ['--version',     '-v', GetoptLong::NO_ARGUMENT],
-  ['--help',        '-h', GetoptLong::NO_ARGUMENT]
+  ['--config', GetoptLong::REQUIRED_ARGUMENT],
+  ['--onsite_only', GetoptLong::NO_ARGUMENT],
+  ['--no_toc',      GetoptLong::NO_ARGUMENT],
+  ['--version',     GetoptLong::NO_ARGUMENT],
+  ['--help',        GetoptLong::NO_ARGUMENT]
 )
 
 def help
@@ -16,6 +16,10 @@ def help
   dirname = File.dirname(File.dirname(path))
   filepath = File.join(dirname, 'doc', 'help.txt')
   puts File.read(filepath)
+  filepath = File.join(dirname, 'config', 'ruby.json')
+  File.readlines(filepath).each do |line|
+    puts "    #{line}"
+  end
   exit
 end
 
@@ -24,10 +28,16 @@ def version
   exit
 end
 
+config_filepath = nil
 onsite_only = false
 no_toc = false
 options.each do |option, argument|
   case option
+  when '--config'
+    config_filepath = argument
+    onsite_only = false
+    no_toc = false
+    break
   when '--onsite_only'
     onsite_only = true
   when '--no_toc'
@@ -53,6 +63,7 @@ raise ArgumentError.new(message) if message
 html_dirpath = ARGV[0]
 RDocLinkChecker.new(
   html_dirpath,
+  config_filepath: config_filepath,
   onsite_only: onsite_only,
   no_toc: no_toc
 ).check

data/config/ruby.json

@@ -0,0 +1,10 @@
+{
+  "options": {
+    "onsite_only": false,
+    "no_toc": true
+  },
+  "source_file_omits": [
+    "^LEGAL",
+    "^NEWS"
+  ]
+}

data/doc/help.txt

@@ -7,10 +7,34 @@ of RDoc-generated HTML files, such as those generated by command
   rdoc --visibility=private --op html . # Note the trailing dot.
 
 Options:
-  --onsite_only   Check link targets only on pages in the file tree at <html_dirpath>,
-                  and not those on other local pages or those on the web.
-  --no_toc        Do not check links on the TOC page (table_of_contents.html).
-  --version       Print the version and exit.
-  --help          Print this help and exit.
+  --config filepath   Read configuration from file.  See below.
+  --onsite_only       Check link targets only on pages in the file tree at <html_dirpath>,
+                      and not those on other local pages or those on the web.
+  --no_toc            Do not check links on the TOC page (table_of_contents.html).
+  --version           Print the version and exit.
+  --help              Print this help and exit.
 
 The output is file <html_dirpath>/Report.htm, which reports broken links.
+
+The configuration file must be a JSON object
+(see https://docs.ruby-lang.org/en/master/JSON.html)
+consisting of name/value pairs;
+the names may include:
+
+- "options": a JSON object consisting of option-name/value pairs;
+  the option-names may include:
+
+  - "onsite_only": the value must be true or false (not quoted),
+    which sets the onsite_only value.
+  - "no_toc": the value must be true or false (not quoted),
+    which sets the no_toc value.
+
+- "source_file_omits": a JSON array consisting of double-quoted strings,
+  each of which will be used to create a Regexp object;
+  a source filepath that matches any of those regexps will not be checked
+  for bad links.
+
+  Example:
+
+
+

data/lib/rdoc_link_checker/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-class RDocLinkChecker
-  VERSION = "0.6.0"
-end
+# frozen_string_literal: true
+
+class RDocLinkChecker
+  VERSION = "0.7.0"
+end