mapStateToProps names

Author: DianaSuvorova

docs/rules/mapStateToProps-prefer-parameters-names.md

@@ -0,0 +1,25 @@
+#  Enforces that all mapStateToProps parameters have specific names. (react-redux/mapStateToProps-prefer-named-parameters)
+
+[react-redux mapStateToProps](https://github.com/reactjs/react-redux/blob/master/docs/api.md#connectmapstatetoprops-mapdispatchtoprops-mergeprops-options) function has 2 optional arguments:
+* state
+* ownProps
+
+This rule enforces that all of the provided parameters should follow the above naming conventions.
+
+## Rule details
+
+The following pattern is considered warnings:
+
+```js
+mapStateToProps(anyOtherName)
+```
+
+The following patterns are considered correct:
+
+```js
+mapStateToProps(state, ownProps)
+```
+
+```js
+mapStateToProps(state)
+```

index.js

@@ -1,12 +1,14 @@
 const rules = {
   'connect-prefer-named-parameters': require('./lib/rules/connect-prefer-named-parameters'),
+  'mapStateToProps-prefer-parameters-names': require('./lib/rules/mapStateToProps-prefer-parameters-names'),
 };
 
 module.exports = {
   rules,
   configs: {
     recommended: {
       'react-redux/connect-prefer-named-parameters': 2,
+      'react-redux/mapStateToProps-prefer-parameters-names': 2,
     },
     all: {
       rules,

lib/rules/connect-prefer-named-parameters.js

@@ -21,7 +21,10 @@ module.exports = function (context) {
         node.arguments.forEach((argument, i) => {
           if (argument.raw && argument.raw !== 'null') {
             report(context, node, i);
-          } else if (!argument.raw && (!argument.name || argument.name !== argumentNames[i])) {
+          } else if (
+            !argument.raw
+            && argumentNames[i]
+            && (!argument.name || argument.name !== argumentNames[i])) {
             report(context, node, i);
           }
         });

lib/rules/mapStateToProps-prefer-parameters-names.js

@@ -0,0 +1,30 @@
+const argumentNames = [
+  'state',
+  'ownProps',
+];
+
+const report = function (context, node, i) {
+  context.report({
+    message: `mapStateToProps function parameter #${i} should be named ${argumentNames[i]}`,
+    node,
+  });
+};
+
+module.exports = function (context) {
+  return {
+    CallExpression(node) {
+      if (node.callee.name === 'mapStateToProps') {
+        node.arguments.forEach((argument, i) => {
+          if (argument.raw && argument.raw !== 'null') {
+            report(context, node, i);
+          } else if (
+            !argument.raw
+            && argumentNames[i]
+            && (!argument.name || argument.name !== argumentNames[i])) {
+            report(context, node, i);
+          }
+        });
+      }
+    },
+  };
+};

package.json

@@ -13,9 +13,13 @@
   "scripts": {
     "lint": "eslint ./",
     "test": "npm run lint && mocha tests --recursive",
-    "test-single": "mocha tests/lib/rules/connect-prefer-named-parameters",
-    "debug-test": "mocha --debug-brk --inspect tests/lib/rules/connect-prefer-named-parameters"
+    "test-single": "mocha tests/lib/rules/mapStateToProps-prefer-parameters-names",
+    "debug-test": "mocha --debug-brk --inspect tests/lib/rules/mapStateToProps-prefer-parameters-names"
   },
+  "repository": {
+  "type": "git",
+  "url": "https://github.com/diana.suvorova/eslint-plugin-react-redux"
+},
   "devDependencies": {
     "babel-eslint": "^8.1.0",
     "eslint": "^4.14.0",

tests/lib/rules/mapStateToProps-prefer-parameters-names.js

@@ -15,11 +15,25 @@ const ruleTester = new RuleTester({ parserOptions });
 
 ruleTester.run('mapStateToProps-prefer-parameters-names', rule, {
   valid: [
-    'mapStateToProps(state, ownProps)(Component)',
-    'mapStateToProps(state)(Component)',
-  ],
-  invalid: [
-    'mapStateToProps(anyOtherName)(Component)',
-    'mapStateToProps(anyOtherName, anyOtherName)(Component)',
+    'mapStateToProps(state, ownProps)',
+    'mapStateToProps(state)',
+    'mapStateToProps(state, ownProps, moreArgs)',
   ],
+  invalid: [{
+    code: 'mapStateToProps(anyOtherName)',
+    errors: [
+      {
+        message: 'mapStateToProps function parameter #0 should be named state',
+      },
+    ],
+  }, {
+    code: 'mapStateToProps(anyOtherName, anyOtherName)',
+    errors: [
+      {
+        message: 'mapStateToProps function parameter #0 should be named state',
+      }, {
+        message: 'mapStateToProps function parameter #1 should be named ownProps',
+      },
+    ],
+  }],
 });