adds react-flow package

README.md

@@ -4,7 +4,8 @@ Official GoDaddy JavaScript styleguide. It includes `eslint` packages for three
 
 - [`eslint-config-godaddy`]: Base configuration for _non-React_, ES6 JavaScript applications
 - [`eslint-config-godaddy-react`]: Configuration for ES6 React JavaScript applications
-- [`eslint-config-godaddy-es5`]: Configuration for React _and_ non-React ES5 JavaScript applications.
+- [`eslint-config-godaddy-es5`]: Configuration for React _and_ non-React ES5 JavaScript applications
+- [`eslint-config-godaddy-react-flow`]: Configuration for ES6 React JavaScript applications using Flow
 
 There are many useful features:
 
@@ -138,3 +139,4 @@ No problem. Reach out to us by [opening an issue]
 [`eslint-config-godaddy`]: /packages/eslint-config-godaddy
 [`eslint-config-godaddy-react`]: /packages/eslint-config-godaddy-react
 [`eslint-config-godaddy-es5`]: /packages/eslint-config-godaddy-es5
+[`eslint-config-godaddy-react-flow`]: /packages/eslint-config-godaddy-react-flow

package.json

@@ -4,14 +4,16 @@
   "description": "The approach to JavaScript at GoDaddy. We think it's pretty decent.",
   "scripts": {
     "lint": "eslint -c .eslintrc.js packages/**/*.js",
-    "postinstall": "run-p install:config install:config:es5 install:config:react",
+    "postinstall": "run-p install:config install:config:es5 install:config:react install:config:react-flow",
     "install:config": "cd packages/eslint-config-godaddy && npm install",
     "install:config:es5": "cd packages/eslint-config-godaddy-es5 && npm install",
     "install:config:react": "cd packages/eslint-config-godaddy-react && npm install",
-    "test": "run-p lint test:config test:config:es5 test:config:react",
+    "install:config:react-flow": "cd packages/eslint-config-godaddy-react-flow && npm install",
+    "test": "run-p lint test:config test:config:es5 test:config:react test:config:react-flow",
     "test:config": "cd packages/eslint-config-godaddy && npm test",
     "test:config:es5": "cd packages/eslint-config-godaddy-es5 && npm test",
-    "test:config:react": "cd packages/eslint-config-godaddy-react && npm test"
+    "test:config:react": "cd packages/eslint-config-godaddy-react && npm test",
+    "test:config:react-flow": "cd packages/eslint-config-godaddy-react-flow && npm test"
   },
   "repository": {
     "type": "git",
@@ -27,7 +29,8 @@
     "es6",
     "es2015",
     "react",
-    "jsx"
+    "jsx",
+    "flow"
   ],
   "license": "MIT",
   "author": "GoDaddy.com Operating Company, LLC",
@@ -41,7 +44,10 @@
     "godaddy-js-style-eslint": "./bin/eslint"
   },
   "devDependencies": {
+    "babel-eslint": "^7.2.1",
     "eslint": "^3.15.0",
+    "eslint-plugin-babel": "^4.0.1",
+    "eslint-plugin-flowtype": "^2.30.4",
     "eslint-find-rules": "^1.14.3",
     "eslint-plugin-json": "^1.2.0",
     "eslint-plugin-mocha": "^4.8.0",

packages/eslint-config-godaddy-react-flow/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "./index.js"
+}

packages/eslint-config-godaddy-react-flow/README.md

@@ -0,0 +1,55 @@
+# eslint-config-godaddy-react-flow
+
+Configuration for ES6 React JavaScript applications using Flow, officially used at GoDaddy. There are many useful features:
+
+- **Standard. No configuration.** – Stop worrying about style and focus on your work.
+- **Modern** – Uses modern linting tools like `eslint`.
+- **Auto-fix** – Auto-fix is enabled by-default through in `eslint`. Many rules will fix themselves!
+
+This styleguide is used by dozens of product teams at GoDaddy. Have a question or comment? [Open an issue!](https://github.com/godaddy/javascript/issues/new)
+
+## Installation
+
+``` sh
+# ES6 (including React rules)
+npm i eslint-config-godaddy-react-flow --save-dev
+```
+
+## Usage
+
+There are two ways to use this styleguide depending on your own tooling preference: directly using pre-included binaries or running `eslint` yourself with a custom `.eslintrc` config.
+
+##### 1. Use the pre-included binaries.
+
+These use _exactly_ the configuration defined in this  package (`eslint-config-godaddy-react-flow`) **with auto-fix enabled automatically.**
+
+``` js
+{
+  "scripts": {
+    "lint": "eslint-godaddy-react-flow files/ you/ want-to/ lint/"
+  }
+}
+```
+
+##### 2. Define your local `.eslintrc` and run `eslint` yourself:
+
+``` js
+module.exports = {
+  extends: 'godaddy-react-flow',
+  rules: {
+    //
+    // Put any rules you wish to override here.
+    //
+  }
+}
+```
+
+The `--fix` option in `eslint` is [**only** available as a CLI option](https://github.com/eslint/eslint/issues/8041). Auto-fix will *NOT be enabled* unless you run `eslint --fix` in your `package.json`.
+
+``` js
+{
+  "scripts": {
+    "lint": "eslint --fix files/ you/ want-to/ lint/"
+  }
+}
+```

packages/eslint-config-godaddy-react-flow/bin/eslint-godaddy-react-flow

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+require('eslint-config-godaddy/cli')(
+  require('path').join(__dirname, '..', 'index')
+);

packages/eslint-config-godaddy-react-flow/extends.js

@@ -0,0 +1,17 @@
+const path = require('path');
+
+/**
+ * Helper function that attempts to resolve the specify named `config`
+ * locally before attempting to resolve it from `node_modules`. This
+ * tricks TravisCI into resolving correctly.
+ *
+ * @param {string} config Named `eslint-config-*` module
+ * @returns {string} Full path resolved locally or from `node_modules`.
+ */
+module.exports = function resolveLocal(config) {
+  try {
+    return require.resolve(path.resolve(__dirname, '..', config));
+  } catch (ex) {
+    return require.resolve(config);
+  }
+};

packages/eslint-config-godaddy-react-flow/index.js

@@ -0,0 +1,25 @@
+module.exports = {
+  extends: [
+    require('./extends')('eslint-config-godaddy-react'),
+    'plugin:eslint-plugin-react/recommended'
+  ],
+  plugins: ['react', 'flowtype', 'babel'],
+  parser: 'babel-eslint',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+      experimentalObjectRestSpread: true
+    }
+  },
+  rules: {
+    'flowtype/define-flow-type': 2,
+    'flowtype/space-after-type-colon': [2, 'always'],
+    'flowtype/type-id-match': [2, '^([A-Z][A-Za-z0-9]*)$'],
+    'flowtype/use-flow-type': 2
+  },
+  settings: {
+    flowtype: {
+      onlyFilesWithFlowAnnotation: true
+    }
+  }
+};

packages/eslint-config-godaddy-react-flow/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "eslint-config-godaddy-react-flow",
+  "version": "1.1.0",
+  "description": "ESLint config for consistent style in ES6 React projects using Flow at GoDaddy.",
+  "scripts": {
+    "lint": "eslint .",
+    "pretest": "npm run --silent lint",
+    "test": "echo ok",
+    "unused": "eslint-find-rules --unused ./index.js || echo ''"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:godaddy/javascript.git"
+  },
+  "keywords": [
+    "godaddy",
+    "javascript",
+    "styleguide",
+    "style-guide",
+    "eslint",
+    "es6",
+    "react",
+    "flow"
+  ],
+  "bin": {
+    "eslint-godaddy-react-flow": "bin/eslint-godaddy-react-flow"
+  },
+  "dependencies": {
+    "eslint-config-godaddy-react": "^1.1.0"
+  },
+  "peerDependencies": {
+    "eslint": "^3.15.0",
+    "babel-eslint": "^7.2.1",
+    "eslint-find-rules": "^1.14.3",
+    "eslint-plugin-babel": "^4.0.1",
+    "eslint-plugin-flowtype": "^2.30.4",
+    "eslint-plugin-json": "^1.2.0",
+    "eslint-plugin-mocha": "^4.8.0",
+    "eslint-plugin-react": "^6.9.0"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^3.15.0",
+    "babel-eslint": "^7.2.1",
+    "eslint-find-rules": "^1.14.3",
+    "eslint-plugin-babel": "^4.0.1",
+    "eslint-plugin-flowtype": "^2.30.4",
+    "eslint-plugin-json": "^1.2.0",
+    "eslint-plugin-mocha": "^4.8.0",
+    "eslint-plugin-react": "^6.9.0"
+  }
+}

packages/eslint-config-godaddy-react/README.md

@@ -26,7 +26,7 @@ These use _exactly_ the configuration defined in this  package (`eslint-config-g
 ``` js
 {
   "scripts": {
-    "lint": eslint-godaddy-react files/ you/ want-to/ lint/"
+    "lint": "eslint-godaddy-react files/ you/ want-to/ lint/"
   }
 }
 ```