Refactor move docs (#8108)
* feat: [skip] generate readme script * docs: [skip ci] update READMEs * docs: [skip ci] fix code block type * chore: [skip ci] move generator script
This commit is contained in:
@@ -1,71 +1,19 @@
|
||||
# @babel/plugin-transform-flow-comments
|
||||
|
||||
> Turn flow type annotations into 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.
|
||||
See our website [@babel/plugin-transform-flow-comments](https://new.babeljs.io/docs/en/next/babel-plugin-transform-flow-comments.html) for more information.
|
||||
|
||||
[Flow Comments Blog Post](http://flowtype.org/blog/2015/02/20/Flow-Comments.html)
|
||||
## Install
|
||||
|
||||
## Example
|
||||
|
||||
**In**
|
||||
|
||||
```javascript
|
||||
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**
|
||||
|
||||
```javascript
|
||||
"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
|
||||
Using npm:
|
||||
|
||||
```sh
|
||||
npm install --save-dev @babel/plugin-transform-flow-comments
|
||||
npm install --save @babel/plugin-transform-flow-comments
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Via `.babelrc` (Recommended)
|
||||
|
||||
**.babelrc**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": ["@babel/plugin-transform-flow-comments"]
|
||||
}
|
||||
```
|
||||
|
||||
### Via CLI
|
||||
or using yarn:
|
||||
|
||||
```sh
|
||||
babel --plugins @babel/plugin-transform-flow-comments script.js
|
||||
```
|
||||
|
||||
### Via Node API
|
||||
|
||||
```javascript
|
||||
require("@babel/core").transform("code", {
|
||||
plugins: ["@babel/plugin-transform-flow-comments"]
|
||||
});
|
||||
yarn add --save @babel/plugin-transform-flow-comments
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user