Helper functions searchable documentation

[ilia-kebets-sonarsource]

https://sonarsource.github.io/SonarJS/typedoc/

[sonarsource-next]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[ilia-kebets-sonarsource]

TODOs:

• it might be nice to display the full signature in the search result, especially when the found term is a parameter, to make it easier to understand what was found
• I'd suggest to separate the different types of search result ('Types', vs 'Function', vs 'Class') if possible:
  Example: looking for 'isStringLiteral' I type 'literal' or 'string' in the search bar. The first result is the type 'StringLiteral'. It'd be nice to
  either clearly indicate it's a 'type' result (with the C, T, F, V icons on the side), or separate the types/variables/functions result with a clear separation bar or something. Maybe even put types at the end?
• minor UI remark -> if I'm in a element of the "Mocha" module (such as inside the 'isTestCase' function description), I clearly see on the right menu the vertical bar on the module hierarchy being highlighted, i.e. the "|" of " | SonarJS linter helper functions" and " | Mocha". If I'm in the description of an element from "SonarJS linter helper functions" (such as inside the 'flattenArgs' function description), there's no vertical bar highlight "|" next to the right "SonarJS linter helper functions" menu element.
• In some descriptions there are links to the defined types (example, in 'Mocha.extractTestCase' the 'TestCase' type is clickable to directly go on the page), and in others there aren't (example 'Express.attemptFindAppInjection' the 'RuleContext' is not clickable)

[sonarsource-next]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[yassin-kammoun-sonarsource]

Tremendous work!