Add prettier, refactor message

Author: pgilad

.prettierrc

@@ -0,0 +1,9 @@
+arrowParens: avoid
+bracketSpacing: true
+jsxBracketSameLine: true
+printWidth: 120
+semi: true
+singleQuote: true
+tabWidth: 4
+trailingComma: es5
+useTabs: false

README.md

@@ -1,6 +1,7 @@
 # eslint-plugin-react-redux
+> Find issues with react-redux code usages
 
-Find issues with react-redux code usages
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 ## Installation
 

lib/index.js

@@ -2,17 +2,17 @@
  * @fileoverview Find issues with react-redux code usages
  * @author Gilad Peleg
  */
-"use strict";
+'use strict';
 
 //------------------------------------------------------------------------------
 // Requirements
 //------------------------------------------------------------------------------
 
-var requireIndex = require("requireindex");
+var requireIndex = require('requireindex');
 
 //------------------------------------------------------------------------------
 // Plugin Definition
 //------------------------------------------------------------------------------
 
 // import all rules in lib/rules
-module.exports.rules = requireIndex(__dirname + "/rules");
+module.exports.rules = requireIndex(__dirname + '/rules');

lib/rules/use-selectors-on-state.js

@@ -2,58 +2,65 @@
  * @fileoverview Enforce usage of selector functions on state in mapStateToProps
  * @author Gilad Peleg
  */
-"use strict";
+'use strict';
 
 const checkNode = (node, context) => {
     const parents = context.getAncestors(node);
     const isInsideMapStateToProps = parents.some(parent => {
-        if (parent.type !== "VariableDeclarator") {
+        if (parent.type !== 'VariableDeclarator') {
             return false;
         }
-        if (parent.id.type !== "Identifier") {
+        if (parent.id.type !== 'Identifier') {
             return false;
         }
-        return parent.id.name === "mapStateToProps";
+        return parent.id.name === 'mapStateToProps';
     });
     if (!isInsideMapStateToProps) {
-        return;
+        return false;
     }
 
     context.report({
-        message: "You should not access state directly in `mapStateToProps`. Use a selector function instead.",
-        node: node
+        node: node,
+        messageId: 'nonSelector',
+        data: {
+            usage: context.getSourceCode().getText(node),
+        },
     });
+
+    return true;
 };
 
 module.exports = {
     meta: {
         docs: {
-            description: "Enforce usage of selector functions on state in mapStateToProps",
-            category: "Possible Errors",
-            recommended: false
+            description: 'Enforce usage of selector functions on state in mapStateToProps',
+            category: 'Possible Errors',
+            recommended: false,
+            url: 'https://github.com/pgilad/eslint-plugin-react-redux/docs/rules/use-selectors-on-state.md',
         },
         fixable: null,
-        schema: [
-            // fill in your schema
-        ]
+        schema: [],
+        messages: {
+            nonSelector:
+                'You are directly accessing state by {{ usage }} in mapStateToProps. Use a selector function instead.',
+        },
     },
     create: function(context) {
         return {
             VariableDeclarator(node) {
-                if (node.id.type === "ObjectPattern") {
-                    if (node.init.type === "Identifier" && node.init.name === "state") {
+                if (node.id.type === 'ObjectPattern') {
+                    if (node.init.type === 'Identifier' && node.init.name === 'state') {
                         checkNode(node, context);
                     }
                 }
             },
             MemberExpression(node) {
-                if (node.object.type === "Identifier" && node.object.name === "state") {
-                    if (node.property.type === "Identifier" || node.property.type === "Literal") {
+                if (node.object.type === 'Identifier' && node.object.name === 'state') {
+                    if (node.property.type === 'Identifier' || node.property.type === 'Literal') {
                         checkNode(node, context);
-                        return;
                     }
                 }
-            }
+            },
         };
-    }
+    },
 };

package-lock.json

@@ -14,14 +14,16 @@
   "main": "lib/index.js",
   "repository": "pgilad/eslint-plugin-react-redux",
   "scripts": {
-    "test": "mocha tests --recursive"
+    "test": "mocha tests --recursive",
+    "prettier": "prettier --write '**/*.js'"
   },
   "dependencies": {
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
     "eslint": "^4.19.1",
-    "mocha": "^5.0.5"
+    "mocha": "^5.0.5",
+    "prettier": "^1.11.1"
   },
   "engines": {
     "node": ">=6.0.0"

package.json

@@ -2,35 +2,34 @@
  * @fileoverview Enforce usage of selector functions on state in mapStateToProps
  * @author Gilad Peleg
  */
-"use strict";
+'use strict';
 
-var rule = require("../../../lib/rules/use-selectors-on-state");
-var RuleTester = require("eslint").RuleTester;
+var rule = require('../../../lib/rules/use-selectors-on-state');
+var RuleTester = require('eslint').RuleTester;
 
 const parserOptions = {
     ecmaVersion: 6,
     sourceType: 'module',
     ecmaFeatures: {
         experimentalObjectRestSpread: true,
-        jsx: true
-    }
+        jsx: true,
+    },
 };
 
-const ruleMessage = 'You should not access state directly in `mapStateToProps`. Use a selector function instead.'
-
 var ruleTester = new RuleTester({ parserOptions });
-ruleTester.run("use-selectors-on-state", rule, {
-    valid: [{
-        code: `
+ruleTester.run('use-selectors-on-state', rule, {
+    valid: [
+        {
+            code: `
             const mapStateToProps = state => {
                 const account = getAccountsEntity(state);
 
                 return {
                     account,
                 };
             };
-        `
-    },
+        `,
+        },
         {
             code: `
                 const mapStateToProps = state => {
@@ -54,7 +53,7 @@ ruleTester.run("use-selectors-on-state", rule, {
                     };
                 };
             `,
-            errors: [ { message: ruleMessage, }]
+            errors: [{ messageId: 'nonSelector', data: { usage: 'state.appState' } }],
         },
         {
             code: `
@@ -66,7 +65,7 @@ ruleTester.run("use-selectors-on-state", rule, {
                     };
                 };
             `,
-            errors: [ { message: ruleMessage, }]
+            errors: [{ messageId: 'nonSelector', data: { usage: '{ w, s } = state' } }],
         },
         {
             code: `
@@ -78,7 +77,7 @@ ruleTester.run("use-selectors-on-state", rule, {
                     };
                 };
             `,
-            errors: [ { message: ruleMessage, }]
+            errors: [{ messageId: 'nonSelector', data: { usage: 'state.outer' } }],
         },
         {
             code: `
@@ -91,7 +90,10 @@ ruleTester.run("use-selectors-on-state", rule, {
                     };
                 };
             `,
-            errors: [ { message: ruleMessage, }, { message: ruleMessage, }]
+            errors: [
+                { messageId: 'nonSelector', data: { usage: "state['a']" } },
+                { messageId: 'nonSelector', data: { usage: 'state[d]' } },
+            ],
         },
         {
             code: `
@@ -103,7 +105,7 @@ ruleTester.run("use-selectors-on-state", rule, {
                     };
                 };
             `,
-            errors: [ { message: ruleMessage, }]
+            errors: [{ messageId: 'nonSelector', data: { usage: 'state.inner' } }],
         },
-    ]
+    ],
 });