Fix array-within-word-array parsing #1604
Conversation
|
Hmmm, it looks like I'll work through the |
apiology
force-pushed
the
fix_word_array_in_array_parsing
branch
2 times, most recently
from
88e7395 to
f8e75b9
Compare
|
All right, added simplified regression test cases, found a different fix which seems more robust, and verified it passed tests as well as sord on my application. sord is useful for regression against a codebase here as it uses the output of yard's parse of e.g. constants and feeds the results into sorbet, which parses it again, complaining about syntax errors when yard doesn't give the correct source range. |
lib/yard/parser/ruby/ruby_parser.rb
Outdated
| sstart = other.source_range.begin | ||
| lstart = other.line_range.begin | ||
| node.source_range = Range.new(sstart, @ns_charno - 1) | ||
| node.line_range = Range.new(lstart, lineno) |
There was a problem hiding this comment.
Unless I'm missing something, this is dead code. Let me know if I'm wrong.
There was a problem hiding this comment.
This is not dead code per se. This is meant to future-proof the implementation for new node types which happens fairly often.
There was a problem hiding this comment.
Gotcha. Just seemed strange those two assignments were immediately overridden. I'll revert that, but definitely curious to hear what I'm misunderstanding there.
When yard saw a constant like: ```ruby FOO = [%w[bar baz]] ``` it cut off the array at the first closing bracket: ```ruby [%w[bar baz] ``` Fix by ensuring that these types of arrays, which don't have a starting :lbracket, don't pop off :lbracket state in @Map. Drop dead code and add a variety of related regression cases found in my application using sord after trying different fixes.
apiology
force-pushed
the
fix_word_array_in_array_parsing
branch
from
f8e75b9 to
a5dcc55
Compare
Description
When yard saw a constant like:
it cut off the array at the first closing bracket in the resulting documentation:
Fix by ensuring that these types of arrays, which don't have a
starting :lbracket, don't pop off :lbracket state in
@mapDrop dead code and add a variety of related regression cases found in
my application using sord after trying different fixes.
Completed Tasks
bundle exec rakelocally (if code is attached to PR).