gaearon / babel-plugin-flow-comments

Turn flow type annotations into comments.

babel-plugin-flow-comments

Turn flow type annotations into comments.

http://flowtype.org/blog/2015/02/20/Flow-Comments.html

Example

In

function foo(bar?) {}
function foo2(bar?: string) {}
function foo(x: number): string {}
type B = {
  name: string;
};

Out

"use strict";

function foo(bar /*:: ?*/) {}
function foo2(bar /*:: ?: string*/) {}
function foo(x /*: number*/) /*: string*/ {}
/*:: type B = {
  name: string;
};*/

Installation

$ npm install babel-plugin-flow-comments

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["flow-comments"]
}

Via CLI

$ babel --plugins flow-comments script.js

Via Node API

require("babel-core").transform("code", {
  plugins: ["flow-comments"]
});