Support parsing of Flow annotations

[agigleux]

Migrated from: https://jira.sonarsource.com/browse/SONARJS-828
Flow: https://flow.org/

[sattaman]

+1

[ummahusla]

+1

[trietphamnm]

+1

[himynameisjon]

+1

[r085741]

+1

[bendersej]

+1

[memelet]

Can sonarjs be used with flow at all? We have a bunch of project that employ flow. Do people configure sonar to use js output from flow maybe?

[inverno]

@memelet what you propose could work and with source maps it might even be vaguely useful, but do consider that the reason we are not yet supporting flow annotation is not related to parsing them without failing, it's related to the information content they provide : if you are using flow and we run analysis on your sources (or output) without understanding the information provided by flow we might raise a lot of issues that are not relevant.
In short : you might try that, but please don't be upset if the analyzer raises obviously wrong issues.

[kesor]

@inverno at the moment the scanner cannot parse files annotated with flow. Any files that have flow annotations cause an ERROR: Unable to parse file and are being ignored.

[cszczotka]

hi,
Do you have plan to implement support for flow syntax in sonarqube javascript plugin ? Maybe you have same a workaround how to scan javascript code where is used flow ?
Regards,
Czeslaw

[pawelk]

@cszczotka I have added flow-remove-types to my project and pointed Sonarqube to scan the non-annotated JS. It's far from ideal and meant to be temporary, but at least the code gets scanned.

[vilchik-elena]

Flow features:

• typed variable declaration
• function declarations (declaration, expression, arrow, method): types for parameters, type for return, optional parameters, type for rest parameter
• optional type
• literal type
• function type, with generics
• object type, optional properties in object type, exact object type, indexer property for object type (aka map object)
• array types
• parenthesis in type (e.g. let arr2: (?number)[] = [1, 2];)
• tuple types
• typed properties in class declaration
• type alias statement, with opaque, with supertype
• import statements
• export statements
• declare type statement
• interface type (properties, method, modifiers + and -)
• generics: function declarations, class declarations, interface declarations, type aliases, function type. Parameterized generics. Super type for generic parameter (link).
• union types
• disjoint Unions
• intersection types
• typeof operator
• type-casting
• Utility Types ($Keys, $Diff etc)

[vilchik-elena]

Some Links

• parser from babel https://github.com/babel/babylon/blob/master/src/plugins/flow.js
• Flow online (from babel)

[vilchik-elena]

There is still some syntax not supported. See this issue #771

[mkruneva]

Hi, I am still having issues with flow syntax ? Is there a workaround or any updates?

Thank you

[vilchik-elena]

@mkruneva comment on #771 with examples