Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: enable specifying a root folder #540

Merged
merged 8 commits into from Nov 17, 2019
Merged

feat: enable specifying a root folder #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b64de7d
test: add test linking relative to root folder
Oct 1, 2019
b72026a
feat: enable specifying a root folder
Oct 1, 2019
cfcabad
chore: change fixture to be more truthful
Oct 1, 2019
1d1f73d
chore: update test name to retrigger travis
Oct 2, 2019
acc08e7
fix: remove double quotes and brackets
Oct 7, 2019
92a1173
fix: remove /app/
Oct 7, 2019
f447fc0
fix: remove leading slash
Oct 7, 2019
e739950
Update docs
gjtorikian Nov 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -297,6 +297,7 @@ The `HTMLProofer` constructor takes an optional hash of additional options:
| `internal_domains`| An array of Strings containing domains that will be treated as internal urls. | `[]` |
| `log_level` | Sets the logging level, as determined by [Yell](https://github.com/rudionrails/yell). One of `:debug`, `:info`, `:warn`, `:error`, or `:fatal`. | `:info`
| `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
| `root_dir` | The absolute path to the directory serving your html-files. Used when running html-proofer on a file, rather than a directory. | "" |
| `typhoeus_config` | A JSON-formatted string. Parsed using `JSON.parse` and mapped on top of the default configuration values so that they can be overridden. | `{}` |
| `url_ignore` | An array of Strings or RegExps containing URLs that are safe to ignore. It affects all HTML attributes. Note that non-HTTP(S) URIs are always ignored. | `[]` |
| `url_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms URLs that match `RegExp` into `String` via `gsub`. | `{}` |
Expand Down
1 change: 1 addition & 0 deletions bin/htmlproofer
View file
Open in desktop
Expand Up @@ -47,6 +47,7 @@ Mercenary.program(:htmlproofer) do |p|
p.option 'typhoeus_config', '--typhoeus-config CONFIG', String, 'JSON-formatted string of Typhoeus config. Will override the html-proofer defaults.'
p.option 'url_ignore', '--url-ignore link1,[link2,...]', Array, 'A comma-separated list of Strings or RegExps containing URLs that are safe to ignore. It affects all HTML attributes. Note that non-HTTP(S) URIs are always ignored'
p.option 'url_swap', '--url-swap re:string,[re:string,...]', Array, 'A comma-separated list containing key-value pairs of `RegExp => String`. It transforms URLs that match `RegExp` into `String` via `gsub`. The escape sequences `\\:` should be used to produce literal `:`s.'
p.option 'root_dir', '--root-folder PATH', String, 'The absolute path to the directory serving your html-files. Used when running html-proofer on a file, rather than a directory.'

p.action do |args, opts|
args = ['.'] if args.empty?
Expand Down
7 changes: 6 additions & 1 deletion lib/html-proofer/element.rb
View file
Open in desktop
Expand Up @@ -164,7 +164,12 @@ def file_path
end

if path =~ %r{^/} # path relative to root
base = File.directory?(@check.src) ? @check.src : File.dirname(@check.src)
if File.directory?(@check.src)
base = @check.src
else
root_dir = @check.options[:root_dir]
base = root_dir ? root_dir : File.dirname(@check.src)
end
elsif File.exist?(File.expand_path(path, @check.src)) || File.exist?(File.expand_path(path_dot_ext, @check.src)) # relative links, path is a file
base = File.dirname @check.path
elsif File.exist?(File.join(File.dirname(@check.path), path)) || File.exist?(File.join(File.dirname(@check.path), path_dot_ext)) # relative links in nested dir, path is a file
Expand Down
10 changes: 10 additions & 0 deletions spec/html-proofer/fixtures/links/working_root_link_internal.html
View file
Open in desktop
@@ -0,0 +1,10 @@
<html>

<body>
<p>
Blah blah blah.
<a href="/html/html5_tags.html">A real link!</a>
</p>
</body>

</html>
6 changes: 6 additions & 0 deletions spec/html-proofer/links_spec.rb
View file
Open in desktop
Expand Up @@ -79,6 +79,12 @@
expect(proofer.failed_tests.first).to match(%r{internally linking to .\/notreal.html, which does not exist})
end

it 'succeeds for working internal-root-links pointing to other folder' do
broken_root_link_internal_filepath = "#{FIXTURES_DIR}/links/working_root_link_internal.html"
proofer = run_proofer(broken_root_link_internal_filepath, :file, root_dir: 'spec/html-proofer/fixtures')
expect(proofer.failed_tests).to eq []
end

it 'fails for link with no href' do
missing_link_href_filepath = "#{FIXTURES_DIR}/links/missing_link_href.html"
proofer = run_proofer(missing_link_href_filepath, :file)
Expand Down