Adds prettier functionality and supercedes any ESLint conficts

benjaminhoffman · benjaminhoffman · commit aa96b52cac8f · 2019-05-01T15:00:02.000-07:00
diff --git a/.eslintrc b/.eslintrc
@@ -5,7 +5,7 @@
         "es6": true,
         "jest": true
     },
-    "extends": ["airbnb-base", "plugin:react/recommended"],
+    "extends": ["airbnb-base", "plugin:react/recommended", "prettier"],
     "globals": {
         "Atomics": "readonly",
         "SharedArrayBuffer": "readonly"
@@ -18,9 +18,9 @@
         "ecmaVersion": 2018,
         "sourceType": "module"
     },
-    "plugins": ["react"],
+    "plugins": ["react", "prettier"],
     "rules": {
-        "indent": ["error", 4],
+        "prettier/prettier": "error",
         "no-unused-vars": [
             "error",
             {
@@ -30,7 +30,6 @@
         ],
         "no-plusplus": "off",
         "no-underscore-dangle": "off",
-        "react/self-closing-comp": "off",
         "no-restricted-syntax": ["off", "BinaryExpression[operator='in']"]
     }
 }
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,11 @@
+{
+    "printWidth": 100,
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "jsxBracketSameLine": false,
+    "proseWrap": "always"
+}
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,20 +1,29 @@
-
 ## Version History
 
+**5.0.1**
+
+-   Adds eslint and prettier
+
 **5.0.0**
-Adds support for Mailchimp Groups.  See README.md for more details on how to implement.
+
+-   Adds support for Mailchimp Groups. See README.md for more details on how to implement.
 
 **4.0.0**
-Gatsby v2 is now default.  See README.md for upgrade details.
+
+-   Gatsby v2 is now default. See README.md for upgrade details.
 
 **3.0.0**
-- uses `gatsby-node` and [Webpack DefinePlugin](https://webpack.js.org/plugins/define-plugin/) to extract your Mailchimp API key during _compile time only_, set it to global, then use it to make the http request.  Previously, we were importing your entire `gatsby-config` file
+
+-   uses `gatsby-node` and [Webpack DefinePlugin](https://webpack.js.org/plugins/define-plugin/) to
+    extract your Mailchimp API key during _compile time only_, set it to global, then use it to make
+    the http request. Previously, we were importing your entire `gatsby-config` file
 
 **2.0.0**
-- return a promise, not string, from an error'd http request
 
+-   return a promise, not string, from an error'd http request
 
 ## To do
-- ensure MC endpoint is valid
-- create basic MC field form (name, email, submit button)
-- spec
+
+-   ensure MC endpoint is valid
+-   create basic MC field form (name, email, submit button)
+-   spec
diff --git a/gatsby-node.js b/gatsby-node.js
@@ -10,9 +10,13 @@ var onCreateWebpackConfig = function onCreateWebpackConfig(_ref, _ref2) {
 
     var isString = typeof endpoint === 'string';
     if (!isString) {
-        throw 'Mailchimp endpoint required and must be of type string. See repo README for more info.';
+        throw new Error(
+            'Mailchimp endpoint required and must be of type string. See repo README for more info.',
+        );
     } else if (endpoint.length < 40) {
-        throw 'gatsby-plugin-mailchimp: donʼt forget to add your MC endpoint to your gatsby-config file. See README for more info.';
+        throw new Error(
+            ' gatsby-plugin-mailchimp: donʼt forget to add your MC endpoint to your gatsby-config file. See README for more info.',
+        );
     }
 
     actions.setWebpackConfig({
diff --git a/index.js b/index.js
@@ -20,12 +20,12 @@ function _interopRequireDefault(obj) {
  * options, along with any MC list fields as query params
  */
 
+// `param` object avoids CORS issues
+// timeout to 3.5s so user isn't waiting forever
+// usually occurs w/ privacy plugins enabled
+// 3.5s is a bit longer than the time it would take on a Slow 3G connection
 var subscribeEmailToMailchimp = function subscribeEmailToMailchimp(url) {
     return new Promise(function(resolve, reject) {
-        // `param` object avoids CORS issues
-        // timeout to 3.5s so user isn't waiting forever
-        // usually occurs w/ privacy plugins enabled
-        // 3.5s is a bit longer than the time it would take on a Slow 3G connection
         return (0, _jsonp2.default)(url, { param: 'c', timeout: 3500 }, function(err, data) {
             if (err) reject(err);
             if (data) resolve(data);
@@ -43,12 +43,12 @@ var subscribeEmailToMailchimp = function subscribeEmailToMailchimp(url) {
 var convertListFields = function convertListFields(fields) {
     var queryParams = '';
     for (var field in fields) {
-        // If this is a list group, not user field,
-        // then keep lowercase, as per MC reqs
-        // Read more: https://github.com/benjaminhoffman/gatsby-plugin-mailchimp/blob/master/README.md#groups
-        // NOTE: we use `substring` instead of `startsWith` or `includes` bc of compatability (esp IE)
-        var fieldTransformed = field.substring(0, 6) ? field : field.toUpperCase();
-        queryParams = queryParams.concat('&' + fieldTransformed + '=' + fields[field]);
+        if (Object.prototype.hasOwnProperty.call(fields, field)) {
+            // If this is a list group, not user field then keep lowercase, as per MC reqs
+            // https://github.com/benjaminhoffman/gatsby-plugin-mailchimp/blob/master/README.md#groups
+            var fieldTransformed = field.substring(0, 6) ? field : field.toUpperCase();
+            queryParams = queryParams.concat('&' + fieldTransformed + '=' + fields[field]);
+        }
     }
     return queryParams;
 };
@@ -72,7 +72,8 @@ var addToMailchimp = function addToMailchimp(email, fields) {
     // generate Mailchimp endpoint for jsonp request
     // note, we change `/post` to `/post-json`
     // otherwise, Mailchomp returns an error
-    var endpoint = window.__GATSBY_PLUGIN_MAILCHIMP_ADDRESS__.replace(/\/post/g, '/post-json');
+    // eslint-disable-next-line no-undef
+    var endpoint = __GATSBY_PLUGIN_MAILCHIMP_ADDRESS__.replace(/\/post/g, '/post-json');
 
     var queryParams = '&EMAIL=' + emailEncoded + convertListFields(fields);
     var url = '' + endpoint + queryParams;
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "gatsby-plugin-mailchimp",
     "author": "Benjamin Hoffman <6520022+benjaminhoffman@users.noreply.github.com>",
-    "version": "5.0.0",
+    "version": "5.0.1",
     "description": "A simple, lightweight Gatsby plugin to subscribe email addresses to your Mailchimp list",
     "main": "index.js",
     "license": "MIT",
@@ -37,10 +37,13 @@
         "babel-preset-env": "^1.7.0",
         "eslint": "^5.16.0",
         "eslint-config-airbnb-base": "^13.1.0",
+        "eslint-config-prettier": "^4.2.0",
         "eslint-plugin-import": "^2.17.2",
+        "eslint-plugin-prettier": "^3.0.1",
         "eslint-plugin-react": "^7.12.4",
         "husky": "^2.1.0",
         "lint-staged": "^8.1.5",
+        "prettier": "^1.17.0",
         "webpack": "^4.29.6"
     },
     "husky": {
@@ -51,6 +54,7 @@
     "lint-staged": {
         "*.js": [
             "eslint --fix",
+            "prettier --write",
             "git add"
         ]
     }
diff --git a/src/index.js b/src/index.js
@@ -11,10 +11,13 @@ import { validate } from 'email-validator';
 // timeout to 3.5s so user isn't waiting forever
 // usually occurs w/ privacy plugins enabled
 // 3.5s is a bit longer than the time it would take on a Slow 3G connection
-const subscribeEmailToMailchimp = url => new Promise((resolve, reject) => jsonp(url, { param: 'c', timeout: 3500 }, (err, data) => {
-    if (err) reject(err);
-    if (data) resolve(data);
-}));
+const subscribeEmailToMailchimp = url =>
+    new Promise((resolve, reject) =>
+        jsonp(url, { param: 'c', timeout: 3500 }, (err, data) => {
+            if (err) reject(err);
+            if (data) resolve(data);
+        }),
+    );
 
 /*
  * build a query string of MC list fields
@@ -23,7 +26,7 @@ const subscribeEmailToMailchimp = url => new Promise((resolve, reject) => jsonp(
  * GROUPS: keep as lowercase (ex: MC uses group field names as `group[21269]`)
  */
 
-const convertListFields = (fields) => {
+const convertListFields = fields => {
     let queryParams = '';
     for (const field in fields) {
         if (Object.prototype.hasOwnProperty.call(fields, field)) {
diff --git a/yarn.lock b/yarn.lock
@@ -1751,6 +1751,13 @@ eslint-config-airbnb-base@^13.1.0:
     object.assign "^4.1.0"
     object.entries "^1.0.4"
 
+eslint-config-prettier@^4.2.0:
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-4.2.0.tgz#70b946b629cd0e3e98233fd9ecde4cb9778de96c"
+  integrity sha512-y0uWc/FRfrHhpPZCYflWC8aE0KRJRY04rdZVfl8cL3sEZmOYyaBdhdlQPjKZBnuRMyLVK+JUZr7HaZFClQiH4w==
+  dependencies:
+    get-stdin "^6.0.0"
+
 eslint-import-resolver-node@^0.3.2:
   version "0.3.2"
   resolved "https://registry.yarnpkg.com/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.2.tgz#58f15fb839b8d0576ca980413476aab2472db66a"
@@ -1784,6 +1791,13 @@ eslint-plugin-import@^2.17.2:
     read-pkg-up "^2.0.0"
     resolve "^1.10.0"
 
+eslint-plugin-prettier@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-3.0.1.tgz#19d521e3981f69dd6d14f64aec8c6a6ac6eb0b0d"
+  integrity sha512-/PMttrarPAY78PLvV3xfWibMOdMDl57hmlQ2XqFeA37wd+CJ7WSxV7txqjVPHi/AAFKd2lX0ZqfsOc/i5yFCSQ==
+  dependencies:
+    prettier-linter-helpers "^1.0.0"
+
 eslint-plugin-react@^7.12.4:
   version "7.12.4"
   resolved "https://registry.yarnpkg.com/eslint-plugin-react/-/eslint-plugin-react-7.12.4.tgz#b1ecf26479d61aee650da612e425c53a99f48c8c"
@@ -2017,6 +2031,11 @@ fast-deep-equal@^2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz#7b05218ddf9667bf7f370bf7fdb2cb15fdd0aa49"
 
+fast-diff@^1.1.2:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.2.0.tgz#73ee11982d86caaf7959828d519cfe927fac5f03"
+  integrity sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w==
+
 fast-json-stable-stringify@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz#d5142c0caee6b1189f87d3a76111064f86c8bbf2"
@@ -2253,6 +2272,11 @@ get-own-enumerable-property-symbols@^3.0.0:
   resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.0.tgz#b877b49a5c16aefac3655f2ed2ea5b684df8d203"
   integrity sha512-CIJYJC4GGF06TakLg8z4GQKvDsx9EMspVxOYih7LerEL/WosUnFIww45CGfxfeKHqlg3twgUrYRT1O3WQqjGCg==
 
+get-stdin@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-6.0.0.tgz#9e09bf712b360ab9225e812048f71fde9c89657b"
+  integrity sha512-jp4tHawyV7+fkkSKyvjuLZswblUtz+SQKzSWnBbii16BuZksJlU1wuBYXY75r+duh/llF1ur6oNwi+2ZzjKZ7g==
+
 get-stdin@^7.0.0:
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-7.0.0.tgz#8d5de98f15171a125c5e516643c7a6d0ea8a96f6"
@@ -3838,6 +3862,18 @@ preserve@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"
 
+prettier-linter-helpers@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz#d23d41fe1375646de2d0104d3454a3008802cf7b"
+  integrity sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==
+  dependencies:
+    fast-diff "^1.1.2"
+
+prettier@^1.17.0:
+  version "1.17.0"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.17.0.tgz#53b303676eed22cc14a9f0cec09b477b3026c008"
+  integrity sha512-sXe5lSt2WQlCbydGETgfm1YBShgOX4HxQkFPvbxkcwgDvGDeqVau8h+12+lmSVlP3rHPz0oavfddSZg/q+Szjw==
+
 private@^0.1.6, private@^0.1.7:
   version "0.1.8"
   resolved "https://registry.yarnpkg.com/private/-/private-0.1.8.tgz#2381edb3689f7a53d653190060fcf822d2f368ff"
