Chore: Extract config comment parsing #11091
Merged
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
nzakas
added
core
|
Hmm, looks like the build is breaking only in Node 11 due to a completely unrelated problem. MockFS |
platinumazure
approved these changes
Nov 17, 2018
not-an-aardvark
suggested changes
Nov 17, 2018
kaicataldo
reviewed
Nov 19, 2018
lib/util/config-comment-parser.js
Outdated
| constructor() { | ||
| debug("Created ConfigCommentParser"); | ||
|
|
||
| // empty for now |
There was a problem hiding this comment.
Are we planning to put more in here? Seems like it's pretty clear to me this is only used for debugging purposes at the moment.
There was a problem hiding this comment.
I was thinking at some point I'd add a strict option to remove some of the fallback behavior we have. Right now it's just a placeholder though. I can remove it if it's vexing.
|
@platinumazure what commented tests are you referring to? |
nzakas
force-pushed
the
config-comments
branch
from
e6da160
to
2fea543
Compare
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:
Extracted config comment parsing into a separate utility.
What changes did you make? (Give an overview)
While digging around in
Linter, I realized that the config comment parsing could be completely separated out, allowing us to better test config comment parsing. I just extracted the existing helper functions fromlinter.jsand put them into a class. I also wrote up some basic tests based on the comments inside the code to verify everything works. At some point I'd like to go back and clean up the methods a bit to make them less tied to what's going on inside oflinter.js, but for now this helps makelinter.jssmaller and gives us a place to test for further changes in comment parsing.I'd really like to make
linter.jssmaller as it's over 1,000 lines right now and a bit hard to follow.Is there anything you'd like reviewers to focus on?
Does this approach make sense?