Render documentation and relationships in the snapshot tests #97
Conversation
|
|
||
| const lsiftyped = lsif.lib.codeintel.lsiftyped | ||
|
|
||
| export function formatSnapshot( |
There was a problem hiding this comment.
I took the liberty to extract this functionality into a separate file so that it's easier to reuse between projects.
There was a problem hiding this comment.
I think it's fine to copy-paste this logic for now while the format is still evolving. The actual formatting logic is fairly simple to port between languages
| @@ -141,16 +141,17 @@ export class FileIndexer { | |||
| sym: ts.Symbol, | |||
| symbol: LsifSymbol | |||
| ): void { | |||
| const documentation = [ | |||
There was a problem hiding this comment.
The diff in the snapshots was difficult to understand with this bugfix so I included it in the PR
| // documentation ```ts\nProps\n``` | ||
| // documentation Takes loading prop, input component as child |
There was a problem hiding this comment.
Is repeating the documentation on multiple lines intentional? TJ's PR uses a separate character from the second line.
There was a problem hiding this comment.
The documentation part is repeated for separate documentation elements. The formatting of multiline docstrings is different, here newlines are rendered as an escaped \n character
| const isDefinition = | ||
| (occurrence.symbol_roles & lsiftyped.SymbolRole.Definition) > 0 |
There was a problem hiding this comment.
Maybe !! or !== 0 would be more idiomatic here rather than > 0?
There was a problem hiding this comment.
I'm not sure what's most idiomatic, this is how I would have written it in Java :/
Previously, the snapshot tests only displayed occurrence roles and symbols. Now, the additionally display the
SymbolInformation.{documentation,relationships}fields for definition occurrences.Test plan
See updated snapshot tests.