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.

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

Lint tool should report broken links and documentation should reflect this #10017

Open
TalbotG opened this issue Mar 13, 2018 · 3 comments
Open

Comments

@TalbotG
Copy link
Contributor

TalbotG commented Mar 13, 2018

http://web-platform-tests.org/writing-tests/lint-tool.html
does not indicate that the lint tool will report broken links. I strongly
believe lint tool should report broken links and the documentation
should be updated to indicate this, to make this explicit.

@foolip
Copy link
Member

foolip commented Mar 14, 2018

@TalbotG, do you mean a definition of broken that's similar to https://validator.w3.org/checklink, or what kinds of problems do you want to catch?

@TalbotG
Copy link
Contributor Author

TalbotG commented Mar 14, 2018

Philip,

I meant a broken link to an image <img src="..."> or to a script <script src="..."> or to replaced content. https://validator.w3.org/checklink will check linkage to image and script btw. So, yes, a definition of broken that's similar to https://validator.w3.org/checklink ; an unfetchable resource , 404 .

This #10017 issue is a followup-to a comment made by D. Baron in issue #9912. Apparently, and if I understand all this correctly, the lint tool will report broken links in the tests submitted into web-platform-tests repository but not in tests to-be-created by the build system to create a test suite.

In the Lint tool documentation, section Fixing lint errors
http://web-platform-tests.org/writing-tests/lint-tool.html#fixing-lint-errors
there is no mention of reporting broken links (to image or to script).

@gsnedders
Copy link
Member

In general, we don't check links exist (primarily because this is relatively expensive, and impossible in general, and we care somewhat about the performance of the lint); it's relied on reviewers to catch it (and likely vendors noticing that the link is broken if it fails as a result).

That said, we do check that support files in css/ are within a support directory (though obviously there's plenty of paths that are accepted by the lint to such files that break with the build system, such as ../support/foo.png), and this is what was caught by the lint in #9912.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants