Modularize the gem #296
Merged
Modularize the gem #296
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main goal of this PR is to continue to break up the HTMLProofer components into smaller subclasses. This PR introduces a new API to use the gem. Rather than call
HTMLProofer.new, users will need to call a method specific to their need. These are now:HTMLProofer.check_file-- used when running on just one fileHTMLProofer.check_directories-- used to run Proofer on one or more directoriesHTMLProofer.check_links-- used to run Proofer on an array of linksIt felt like the old
HTMLProofer.new(...).runpattern was overloaded to do too many things, and was a little too magical. It also prevented the ability to run across multiple directories, since passing an array automatically meant it was an array of links.I'm curious to hear thoughts from @penibelst on this direction (or from anyone, really). As it's a breaking change, it's slated for 3.0.