Switch to flow (#27)

Author: lgeiger

.flowconfig

@@ -0,0 +1,7 @@
+[ignore]
+
+[include]
+
+[libs]
+
+[options]

package.json

@@ -6,9 +6,12 @@
   "scripts": {
     "prebuild": "mkdirp lib/ && npm run clean",
     "prepublish": "npm run build",
-    "test": "mocha --compilers js:babel-core/register 'test/**/*.js'",
+    "test": "npm run test:unit && npm run test:flow",
+    "test:flow": "flow",
+    "test:unit": "mocha --compilers js:babel-core/register 'test/**/*.js'",
     "test:watch": "npm run test -- --watch",
-    "build": "npm run build:es5",
+    "build": "npm run build:es5 && npm run build:flow",
+    "build:flow": "flow-copy-source -v -i '**/tests/**' src lib",
     "build:es5": "babel src --out-dir lib/ --source-maps",
     "clean": "rimraf lib/*"
   },
@@ -25,6 +28,9 @@
       "es2015",
       "stage-3",
       "react"
+    ],
+    "plugins": [
+      "transform-flow-strip-types"
     ]
   },
   "author": "Kyle Kelley <[email protected]>",
@@ -34,23 +40,24 @@
     "escape-carriage": "^1.0.1"
   },
   "peerDependencies": {
-    "prop-types": "^15.5.9",
     "react": "^15.0.0-0"
   },
   "devDependencies": {
     "babel-cli": "^6.8.0",
     "babel-core": "^6.8.0",
+    "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "babel-preset-es2015": "^6.6.0",
     "babel-preset-react": "^6.5.0",
     "babel-preset-stage-3": "^6.22.0",
     "chai": "^3.5.0",
     "enzyme": "^2.2.0",
+    "flow-bin": "^0.46.0",
+    "flow-copy-source": "^1.1.0",
     "mkdirp": "0.5.1",
     "mocha": "^3.2.0",
     "react": "^15.0.1",
     "react-addons-test-utils": "^15.0.1",
     "react-dom": "^15.0.1",
-    "rimraf": "^2.5.2",
-    "should": "^11.1.2"
+    "rimraf": "^2.5.2"
   }
 }

src/index.js

@@ -1,8 +1,30 @@
+/* @flow */
+
 const React = require('react');
-const PropTypes = require('prop-types');
 const Anser = require('anser');
 const escapeCarriageReturn = require('escape-carriage');
 
+type AnserJsonEntry = {
+  content: string,
+  fg: string,
+  bg: string,
+  fg_truecolor: string,
+  bg_truecolor: string,
+  clearLine: boolean,
+  was_processed: boolean,
+  isEmpty: () => boolean
+};
+
+type AnserJson = Array<AnserJsonEntry>;
+
+type AnsiBundle = {
+  content: string,
+  style: {
+    color?: string,
+    backgroundColor?: string
+  }
+};
+
 /**
  * ansiToJson
  * Convert ANSI strings into JSON output.
@@ -12,15 +34,15 @@ const escapeCarriageReturn = require('escape-carriage');
  * @param {String} input The input string.
  * @return {Array} The parsed input.
  */
-function ansiToJSON(input) {
+function ansiToJSON(input: string): AnserJson {
   input = escapeCarriageReturn(input);
   return Anser.ansiToJson(input, {
     json: true,
     remove_empty: true,
   });
 }
 
-function ansiJSONtoStyleBundle(ansiBundle) {
+function ansiJSONtoStyleBundle(ansiBundle: AnserJsonEntry): AnsiBundle {
   const style = {};
   if (ansiBundle.bg) {
     style.backgroundColor = `rgb(${ansiBundle.bg})`;
@@ -34,11 +56,11 @@ function ansiJSONtoStyleBundle(ansiBundle) {
   };
 }
 
-function ansiToInlineStyle(text) {
+function ansiToInlineStyle(text: string): Array<AnsiBundle> {
   return ansiToJSON(text).map(ansiJSONtoStyleBundle);
 }
 
-function linkifyBundle(bundle) {
+function linkifyBundle(bundle: AnsiBundle) {
   return {
     ...bundle,
     content: bundle.content.split(' ').reduce((result, word, index) => [
@@ -68,7 +90,7 @@ function inlineBundleToReact(bundle, key) {
   }, bundle.content);
 }
 
-function Ansi(props) {
+function Ansi(props: {children: string, className?: string}) {
   return React.createElement(
     'code',
     {className: props.className},
@@ -80,9 +102,4 @@ function Ansi(props) {
   );
 }
 
-Ansi.propTypes = {
-  children: PropTypes.string,
-  className: PropTypes.string
-};
-
 module.exports = Ansi;