Merge pull request #3 from IoraHealth/zel-find-object-literals-with-dot-keys

check for object keys with dots in them

Author: zelaznik

docs/rules/object-keynames-with-dots.md

@@ -0,0 +1,30 @@
+# Check if an object literal has any keynames containing a dot. (object-keynames-with-dots)
+
+This rule was written after a bug surfaced in Ember 3.8 where the "each-in" function got screwed up if an object literal contained a key with a string literal that has a dot, such as `{"x.y": 3}`.  This is a very simple check to identify any instances of such notation.
+
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+
+const OPTIONS = {
+  "hello.world": "foo bar"
+};
+
+```
+
+Examples of **correct** code for this rule:
+
+```js
+
+const OPTIONS = {
+  "hello": {
+    "world": "foo bar"
+  }
+};
+
+```

lib/rules/object-keynames-with-dots.js

@@ -0,0 +1,46 @@
+/**
+ * @fileoverview Check if an object literal has any keynames containing a dot.
+ * @author Steve Zelaznik
+ */
+'use strict';
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+const looksLike = require("../helpers/looks-like.js");
+
+module.exports = {
+  meta: {
+    docs: {
+      description:
+        'Check if an object literal has any keynames containing a dot.',
+      recommended: false
+    },
+    fixable: null, // or "code" or "whitespace"
+    schema: [
+      // fill in your schema
+    ]
+  },
+
+  create: function(context) {
+    return {
+      Property(node) {
+        const isMatch = looksLike(node, {
+          key: {
+            type: 'Literal',
+            value(v) {
+              return (typeof v === 'string') && v.indexOf('.') > -1
+            }
+          }
+        });
+
+        if (!isMatch) {
+          return;
+        }
+
+        context.report(node, 'Cannot use a string key name with a "." in it');
+      }
+    };
+  }
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-chirp-test-rules",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "description": "A set of custom lint rules for apps created by Iora Health",
   "keywords": [
     "eslint",

tests/lib/rules/object-keynames-with-dots.js

@@ -0,0 +1,37 @@
+/**
+ * @fileoverview Check if an object literal has any keynames containing a dot.
+ * @author Steve Zelaznik
+ */
+'use strict';
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var rule = require('../../../lib/rules/object-keynames-with-dots'),
+  RuleTester = require('eslint').RuleTester;
+
+RuleTester.setDefaultConfig({
+  parserOptions: {
+    ecmaVersion: 2017,
+    sourceType: 'module'
+  }
+});
+
+var ruleTester = new RuleTester();
+ruleTester.run('object-keynames-with-dots', rule, {
+  valid: [
+    "const data = {x: 3, y: 4, z: 5}"
+  ],
+
+  invalid: [
+    {
+      code: 'const data = {"x.y": 3}',
+      errors: [
+        {
+          message: 'Cannot use a string key name with a "." in it'
+        }
+      ]
+    }
+  ]
+});