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

Set the timeout value from the commandline. #435

Closed
NicolasWebDev opened this issue May 29, 2017 · 9 comments
Closed

Set the timeout value from the commandline. #435

NicolasWebDev opened this issue May 29, 2017 · 9 comments

Comments

@NicolasWebDev
Copy link

htmlproofer is really good, but right now using it for a jekyll-based blog is somewhat burdensome, because it times out quite frequently on valid websites, because the timeout value is set too low by default.

External link https://www.goodreads.com failed: got a time out (response code 0)

I have it in a git pre-commit hook, and to make it pass, I have to repeat it 3 or 4 times.

So it would be nice to be able to have a CLI option, to set the timeout value.

@fulldecent
Copy link
Collaborator

Thank you for sharing. At this time, addition CLI configurations are out of scope for this project.

Please see the wiki for advanced configuration options. This is easy to do. If it is not perfectly easy to do and dead-simply to figure out then let's update the wiki.

https://github.com/gjtorikian/html-proofer/wiki

However, if you are proposing to change the default value that would be in-scope and we would appreciate a PR for that and some benchmarking and discussion.

@NicolasWebDev
Copy link
Author

@fulldecent, would you mind sharing why it is out of scope?

Indeed I know that it can be done using html-proofer as a library, I am myself used to Ruby, but it would be really practical for people not fluent in Ruby, or working on projects where ruby dependencies would like to be avoided. In these cases the CLI is really good and practical.

I understand that you do not have a lot of time right now to work on the project, but I thought that it would be nice to put that on some kind of wishlist, that's why I opened the issue.

@fulldecent
Copy link
Collaborator

Please see the project scope documented here: https://github.com/gjtorikian/html-proofer#project-scope

More discussion on the motivation for setting it are here: #422

The main issue is that there will always be more issues opened for new command line options, whereas Ruby configuration solves this problem permanently and exhaustively. Personally I hate using Ruby as /just one more language/ in a non-Ruby project. The solution is copy-pasteable recipes in our Wiki file. And then also creating a project scope at the top of the readme to make it clear and avoid hard feelings.

Lastly, and more specifically to you, I am going off of the author's comment that adding external link checking to this project was perhaps a mistake. The motivates the policy that the feature is ok to have, and configuring it from Ruby is ok, but adding command lines options is not wanted.

@NicolasWebDev
Copy link
Author

Thanks for the clarification, even though it still seems a shame to me to prevent non-ruby users to have access to this nice tool.

@fulldecent
Copy link
Collaborator

Please do check out the wiki and let us know if it is helpful.

Personally I am also definitely NOT a Ruby person. Wiki copy-paste is how I survive.

@gjtorikian
Copy link
Owner

It's on the roadmap but with one maintainer (me) I haven't had a chance yet to go through and implement it.

@NicolasWebDev
Copy link
Author

Hi @gjtorikian, if it is on the roadmap, don't you think it would be better to keep it open? If you would like to sort it in the issues, you can put a tag on it like 'wishlist' or 'later'.

I do understand you are the unique maintainer, but there is no rush in solving that. I can personally use the ruby, like @fulldecent advised me.

@gjtorikian
Copy link
Owner

I didn't close it, and wouldn't have if I had gotten to the issue first.

On the other hand, #408 and #379 are duplicates of this issue, which I would've probably closed this for that reason. 😅

@NicolasWebDev
Copy link
Author

Yep, you are right, I did not know it involved Typheous, that's why I did not know they were related.

Thanks for the hard work.

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

No branches or pull requests

3 participants