Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
75 lines (55 sloc) 1.39 KB
---
id: babel-plugin-transform-flow-comments
title: @babel/plugin-transform-flow-comments
sidebar_label: transform-flow-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.

Flow Comments Blog Post

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 --save-dev @babel/plugin-transform-flow-comments

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["@babel/plugin-transform-flow-comments"]
}

Via CLI

babel --plugins @babel/plugin-transform-flow-comments script.js

Via Node API

require("@babel/core").transform("code", {
  plugins: ["@babel/plugin-transform-flow-comments"]
});
You can’t perform that action at this time.