babel-plugin-flow-comments

    6.3.19 • Public • Published

    babel-plugin-flow-comments

    Turn flow type annotations into comments.

    You should be able to use this plugin instead of babel-plugin-flow-strip-types to preserve the /* @flow */ directive and still use flow.

    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;
    };
    export type GraphQLFormattedError = number;
    import type A, { B, C } from './types';
    import typeof D, { E, F } from './types';

    Out

    "use strict";
     
    function foo(bar /*:: ?*/) {}
    function foo2(bar /*:: ?: string*/) {}
    function foo(x /*: number*/) /*: string*/ {}
    /*:: type B = {
      name: string;
    };*/
    /*:: export type GraphQLFormattedError = number;*/
    /*:: import type A, { B, C } from './types';*/
    /*:: import typeof D, { E, F } from './types';*/

    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"]
    });

    Keywords

    Install

    npm i babel-plugin-flow-comments

    DownloadsWeekly Downloads

    125

    Version

    6.3.19

    License

    MIT

    Last publish

    Collaborators

    • hzoo
    • loganfsmyth
    • danez
    • existentialism
    • sebmck