Display tsserver tags from docstrings in GetDoc and extra_menu_info

[bstaletic]

Fixes #1675

---

This change is 

[puremourning]

Out of curiosity, What other tags are there?

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: 1 of 2 LGTMs obtained (waiting on @bstaletic)

---

ycmd/completers/typescript/typescript_completer.py line 915 at r1 (raw file):

    extra_info = []
    for tag in info.get( 'tags', [] ):

Worth pulling this block into a func? Seems to be duplicated.

[bstaletic]

Fixed flake8 errors.

There's a ton of tags:
https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

I'm open for a more general solution if we can think of one.

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @puremourning)

[bstaletic]

Taking a look at the tags, this pull request is incomplete. We miss arg as an alternative to param and return as the alternative to returns and probably a lot more.

Maybe we should take all tags and display them as tag_name: tag_text? Maybe without :?

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @bstaletic and @puremourning)

---

ycmd/completers/typescript/typescript_completer.py line 915 at r1 (raw file):

Previously, puremourning (Ben Jackson) wrote…

Worth pulling this block into a func? Seems to be duplicated.

Will do, but let's first decide how we want to handle other tags.

[codecov]

Codecov Report

Merging #1716 (cba73cb) into master (47baf60) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1716   +/-   ##
=======================================
  Coverage   95.45%   95.46%           
=======================================
  Files          83       83           
  Lines        8141     8155   +14     
  Branches      163      163           
=======================================
+ Hits         7771     7785   +14     
  Misses        320      320           
  Partials       50       50           

[bstaletic]

Rebased. Ready for another round of review.

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @puremourning)

---

ycmd/completers/typescript/typescript_completer.py line 915 at r1 (raw file):

Previously, bstaletic (Boris Staletic) wrote…

Will do, but let's first decide how we want to handle other tags.

Done.

[bstaletic]

Fixed the javascriptreact test.

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @puremourning)

[puremourning]

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @bstaletic)

---

ycmd/completers/typescript/typescript_completer.py line 1133 at r3 (raw file):

      extra_info.append( 'returns ' + tag_text )
    elif tag_text:
      extra_info.append( tag_text )

worth including the name? what do these look like?

[bstaletic]

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @puremourning)

---

ycmd/completers/typescript/typescript_completer.py line 1133 at r3 (raw file):

Previously, puremourning (Ben Jackson) wrote…

worth including the name? what do these look like?

It's the name of the tag, so in case of @arg a - thing the name is arg and a - thing is the text.

At least for arguments it felt redundant. I honestly don't know about the rest...

Here's the list of all officially defined tags:

https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

[bstaletic]

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @puremourning)

---

ycmd/completers/typescript/typescript_completer.py line 1133 at r3 (raw file):

Previously, bstaletic (Boris Staletic) wrote…

It's the name of the tag, so in case of @arg a - thing the name is arg and a - thing is the text.

At least for arguments it felt redundant. I honestly don't know about the rest...

Here's the list of all officially defined tags:

https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

Included the tag name as well.

[puremourning]

Reviewed 1 of 2 files at r2, 3 of 3 files at r4, all commit messages.
Reviewable status: 1 of 2 LGTMs obtained (waiting on @bstaletic)

[puremourning]

Reviewable status: 1 of 2 LGTMs obtained (waiting on @bstaletic)

---

ycmd/tests/typescript/subcommands_test.py line 629 at r4 (raw file):

              'function single_argument_with_doc(a: string): string\n\n'
              'A function with a single argument\n\n'
              'a - The argument\n'

Wait why no ‘param:’ ?

[bstaletic]

Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @puremourning)

---

ycmd/tests/typescript/subcommands_test.py line 629 at r4 (raw file):

Previously, puremourning (Ben Jackson) wrote…

Wait why no ‘param:’ ?

Fixed.

[puremourning]

Reviewed 1 of 1 files at r5, 1 of 1 files at r6, all commit messages.
Reviewable status: 1 of 2 LGTMs obtained (waiting on @bstaletic)

[mergify]

Thanks for sending a PR!