jareware/flotate

A portmanteau of flow and annotate, allows using the Flow type checker with standard JavaScript syntax, through inline annotation comments.

flotate's Issues

"Fancy annotation" parsing for ES6 methods

One might expect the "fancy annotations" (as in here) to work also on ES6 methods, such as:

var o = {
    /* : (x: string, y: number): boolean */
    foo(x, y) {
        return x.length * y === 5;
    }
};

but they currently don't, due to the comment block being assigned to the AST slightly differently.

See #4 for a related fix.

Import external types

Does flotate support imported Flow types?
import type Type from './Type.js';

Out-of-line comments do not work with function expressions

Maybe this is an auto-close if this is due to upstream Flow behavior, but function expressions do not seem to be supported with non-inline block comments. That's unfortunate because those are what CoffeeScript generates.

/* @flow */

/*: (n: number): string */
function named(n) { return 's'; }

/*: (n: number): string */
var aboveline = function(n) { return 's'; };

var aftervar /*: (n: number) => string */ = function(n) { return 's'; };

var beforeline = /*: (n: number): string */ function(n) { return 's'; };

var inline = function(n /*: number*/) /*: string*/ { return 's'; };

named('type error');
inline('type error');
aboveline('no type error');
aftervar('no type error');
beforeline('no type error');

Why not JSDoc?

Any reason why you didn't go with standard JSDoc annotation style for this project?

--json flag for Vim's Syntastic

This is a great idea, thanks for creating it!

I'd love to use it with vim's syntastic plugin, but it relies on the --json flag that flow provides.

Opening this issue to get said flag on the radar.

More examples?

• What is the annotation for a function that takes zero parameters and returns a boolean or undefined or null or an object?

(Edit: not inline annotation, but above the function.)