Merge pull request #3157 from hzoo/port-flow-comments

move babel-plugin-flow-comments from babel-plugins repo and convert to use babel 6

packages/babel-plugin-flow-comments/.npmignore

@@ -0,0 +1,4 @@
+node_modules
+*.log
+src
+test

packages/babel-plugin-flow-comments/README.md

@@ -0,0 +1,71 @@
+# 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**
+
+```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
+
+```sh
+$ npm install babel-plugin-flow-comments
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+```json
+{
+  "plugins": ["flow-comments"]
+}
+```
+
+### Via CLI
+
+```sh
+$ babel --plugins flow-comments script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+  plugins: ["flow-comments"]
+});
+```

packages/babel-plugin-flow-comments/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "babel-plugin-flow-comments",
+  "version": "1.0.9",
+  "description": "Turn flow type annotations into comments",
+  "repository": "https://github.com/babel/babel/tree/master/packages/babel-plugin-flow-comments",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "keywords": [
+    "babel-plugin"
+  ],
+  "dependencies": {
+    "babel-runtime": "^5.0.0",
+    "babel-plugin-syntax-flow": "^6.3.13"
+  },
+  "devDependencies": {
+    "babel-helper-plugin-test-runner": "^6.3.13"
+  }
+}

packages/babel-plugin-flow-comments/src/index.js

@@ -0,0 +1,59 @@
+export default function ({ types: t }) {
+  function wrapInFlowComment(path, parent) {
+    path.addComment("trailing", generateComment(path, parent));
+    path.replaceWith(t.noop());
+  }
+
+  function generateComment(path, parent) {
+    let comment = path.getSource().replace(/\*-\//g, "*-ESCAPED/").replace(/\*\//g, "*-/");
+    if (parent && parent.optional) comment = "?" + comment;
+    if (comment[0] !== ":") comment = ":: " + comment;
+    return comment;
+  }
+
+  return {
+    inherits: require("babel-plugin-syntax-flow"),
+
+    visitor: {
+      TypeCastExpression(path) {
+        let { node } = path;
+        path.get("expression").addComment("trailing", generateComment(path.get("typeAnnotation")));
+        path.replaceWith(t.parenthesizedExpression(node.expression));
+      },
+
+      // support function a(b?) {}
+      Identifier(path) {
+        let { node } = path;
+        if (!node.optional || node.typeAnnotation) {
+          return;
+        }
+        path.addComment("trailing", ":: ?");
+      },
+
+      // strip optional property from function params - facebook/fbjs#17
+      Function: {
+        exit({ node }) {
+          node.params.forEach(param => param.optional = false);
+        }
+      },
+
+      // support `export type a = {}` - #8 Error: You passed path.replaceWith() a falsy node
+      "ExportNamedDeclaration|Flow"(path) {
+        let { node, parent } = path;
+        if (t.isExportNamedDeclaration(node) && !t.isFlow(node.declaration)) {
+          return;
+        }
+        wrapInFlowComment(path, parent);
+      },
+
+      // support `import type A` and `import typeof A` #10
+      ImportDeclaration(path) {
+        let { node, parent } = path;
+        if (t.isImportDeclaration(node) && node.importKind !== "type" && node.importKind !== "typeof") {
+          return;
+        }
+        wrapInFlowComment(path, parent);
+      }
+    }
+  };
+}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/export-type-alias/actual.js

@@ -0,0 +1,8 @@
+export type GraphQLFormattedError = number;
+export type GraphQLFormattedError = {
+  message: string,
+  locations?: Array<{
+    line: number,
+    column: number
+  }>
+};

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/export-type-alias/expected.js

@@ -0,0 +1,8 @@
+/*:: export type GraphQLFormattedError = number;*/
+/*:: export type GraphQLFormattedError = {
+  message: string,
+  locations?: Array<{
+    line: number,
+    column: number
+  }>
+};*/

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/import-type-alias/actual.js

@@ -0,0 +1,3 @@
+import lib from 'library';
+import type A, { B, C } from './types';
+import typeof D, { E, F } from './types';

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/import-type-alias/expected.js

@@ -0,0 +1,3 @@
+import lib from 'library';
+/*:: import type A, { B, C } from './types';*/
+/*:: import typeof D, { E, F } from './types';*/

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/optional-parameters/actual.js

@@ -0,0 +1 @@
+function multiply(num?: number) {}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/optional-parameters/expected.js

@@ -0,0 +1 @@
+function multiply(num /*:: ?: number*/) {}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/optional-type/actual.js

@@ -0,0 +1,2 @@
+function foo(bar?) {}
+function foo2(bar?: string) {}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/optional-type/expected.js

@@ -0,0 +1,2 @@
+function foo(bar /*:: ?*/) {}
+function foo2(bar /*:: ?: string*/) {}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/options.json

@@ -0,0 +1,3 @@
+{
+  "plugins": ["flow-comments"]
+}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type-alias-with-comment/actual.js

@@ -0,0 +1,6 @@
+type T = /*test*/ number;
+type T2 = /* *-/ */ number;
+type CustomType = {
+/** This is some documentation. */
+name: string;
+};

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type-alias-with-comment/expected.js

@@ -0,0 +1,6 @@
+/*:: type T = /*test*-/ number;*/
+/*:: type T2 = /* *-ESCAPED/ *-/ number;*/
+/*:: type CustomType = {
+/** This is some documentation. *-/
+name: string;
+};*/

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type-alias/actual.js

@@ -0,0 +1,5 @@
+function a() {}
+type A = number;
+type B = {
+  name: string;
+};

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type-alias/expected.js

@@ -0,0 +1,5 @@
+function a() {}
+/*:: type A = number;*/
+/*:: type B = {
+  name: string;
+};*/

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type-cast/actual.js

@@ -0,0 +1,2 @@
+var a = (y: any);
+var a = ((y: foo): any);

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type-cast/expected.js

@@ -0,0 +1,2 @@
+var a = (y /*: any*/);
+var a = ((y /*: foo*/) /*: any*/);

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type/actual.js

@@ -0,0 +1 @@
+function foo(x: number): string {}

packages/babel-plugin-flow-comments/test/fixtures/flow-comments/type/expected.js

@@ -0,0 +1 @@
+function foo(x /*: number*/) /*: string*/ {}

packages/babel-plugin-flow-comments/test/index.js

@@ -0,0 +1 @@
+require("babel-helper-plugin-test-runner")(__dirname);