feat: add support for defineMessage (#9)

Author: henrymunro

Diff for: .gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 node_modules
 coverage
+.vscode

Diff for: docs/rules/id-missing.md

@@ -31,6 +31,10 @@ formatMessage({ id: 'missing_example' })
 defineMessages({ msg: { id:'missing_example' }})
 ```
 
+```js
+defineMessage({ id:'missing_example' })
+```
+
 Examples of **correct** code for this rule:
 
 ```js
@@ -57,6 +61,14 @@ defineMessages({ msg: { id: 'in_example' }})
 defineMessages({ msg: { id: `in_${someKey}_label` }})
 ```
 
+```js
+defineMessage({ id: 'in_example' })
+```
+
+```js
+defineMessage({ id: `in_${someKey}_label` })
+```
+
 ### Options
 
 ```

Diff for: docs/rules/id-prefix.md

@@ -23,6 +23,10 @@ formatMessage({ id:'missing_example' })
 defineMessages({ msg: { id: 'missing_example' }})
 ```
 
+```js
+defineMessage({ id:'missing_example' })
+```
+
 Examples of **correct** code for this rule:
 
 ```js
@@ -61,6 +65,18 @@ defineMessages({ msg: { id: `in_${someKey}_label` }})
 defineMessages({ msg: { id: 'out_example' }})
 ```
 
+```js
+defineMessage({ id: 'in_example' })
+```
+
+```js
+defineMessage({ id: `in_${someKey}_label` })
+```
+
+```js
+defineMessage({ id: 'out_example' })
+```
+
 ### Options
 
 ```

Diff for: docs/rules/no-default.md

@@ -18,6 +18,10 @@ formatMessage({ id: 'missing_example', defaultMessage: 'Redundant message text'
 defineMessages({ msg: { id: 'missing_example', defaultMessage: 'Redundant message text' }})
 ```
 
+```js
+defineMessage({ id: 'missing_example', defaultMessage: 'Redundant message text' })
+```
+
 Examples of **correct** code for this rule:
 
 ```js
@@ -32,6 +36,10 @@ formatMessage({ id: 'in_example' })
 defineMessages({ msg: { id: 'in_example' }})
 ```
 
+```js
+defineMessage({ id: 'in_example' })
+```
+
 ### Options
 
 ```

Diff for: lib/rules/id-missing.js

@@ -3,7 +3,8 @@ const { getIntlIds } = require('../util/translations');
 const {
   findFormatMessageAttrNode,
   findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage
 } = require('../util/findNodes');
 
 // ------------------------------------------------------------------------------
@@ -91,7 +92,7 @@ module.exports = {
         if (attrNode) return processAttrNode(attrNode);
       },
       Property: function (node) {
-        const attrNode = findAttrNodeInDefineMessages(node, 'id');
+        const attrNode = findAttrNodeInDefineMessages(node, 'id') || findAttrNodeInDefineMessage(node, 'id');
         if (attrNode) return processAttrNode(attrNode);
       }
     };

Diff for: lib/rules/id-prefix.js

@@ -2,7 +2,8 @@ const { templateLiteralDisplayStr } = require('../util/templateLiterals');
 const {
   findFormatMessageAttrNode,
   findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage
 } = require('../util/findNodes');
 
 // ------------------------------------------------------------------------------
@@ -87,7 +88,7 @@ module.exports = {
         if (attrNode) return processAttrNode(attrNode);
       },
       Property: function (node) {
-        const attrNode = findAttrNodeInDefineMessages(node, 'id');
+        const attrNode = findAttrNodeInDefineMessages(node, 'id') || findAttrNodeInDefineMessage(node, 'id');
         if (attrNode) return processAttrNode(attrNode);
       }
     };

Diff for: lib/rules/no-default.js

@@ -1,7 +1,8 @@
 const {
   findFormatMessageAttrNode,
   findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage
 } = require('../util/findNodes');
 
 
@@ -48,7 +49,10 @@ module.exports = {
         if (attrNode) return processAttrNode(attrNode);
       },
       Property: function (node) {
-        const attrNode = findAttrNodeInDefineMessages(node, 'defaultMessage');
+        const attrNode =
+          findAttrNodeInDefineMessages(node, 'defaultMessage') ||
+          findAttrNodeInDefineMessage(node, 'defaultMessage');
+
         if (attrNode) return processAttrNode(attrNode);
       }
     };

Diff for: lib/util/findNodes.js

@@ -54,8 +54,28 @@ function findAttrNodeInDefineMessages(node, attrName) {
   }
 }
 
+/**
+ * Finds an attribute in defineMessages using attribute name.
+ *
+ * @param {Object} node - parent defineMessages node
+ * @param {string} attrName - attribute name.
+ * @returns {Object} node - returns node if it finds the attribute.
+ */
+function findAttrNodeInDefineMessage(node, attrName) {
+  if (node.type === 'Property'
+    && node.key.name === attrName
+    && node.parent
+    && node.parent.parent
+    && node.parent.parent.type === 'CallExpression'
+    && node.parent.parent.callee.name === 'defineMessage'
+  ) {
+    return node;
+  }
+}
+
 module.exports = {
   findFormatMessageAttrNode,
   findFormattedMessageAttrNode,
-  findAttrNodeInDefineMessages
+  findAttrNodeInDefineMessages,
+  findAttrNodeInDefineMessage
 };

Diff for: tests/lib/rules/id-missing.spec.js

@@ -56,6 +56,22 @@ ruleTester.run('id-missing', rule, {
       code: 'formatMessage({ id: `in_b_${bogus}` })',
       settings
     },
+    {
+      code: "defineMessage({ id: 'in_a_example' })",
+      settings
+    },
+    {
+      code: "defineMessage({ id: 'in_b_example' })",
+      settings
+    },
+    {
+      code: 'defineMessage({ id: `in_a_${bogus}` })',
+      settings
+    },
+    {
+      code: 'defineMessage({ id: `in_b_${bogus}` })',
+      settings
+    },
     {
       code: "defineMessages({ msg1: { id: `in_a_${bogus}` }, msg2: { id: 'in_b_example' }})",
       settings
@@ -110,6 +126,21 @@ ruleTester.run('id-missing', rule, {
       settings,
       errors: ['Missing id pattern: in_b_*_missing']
     },
+    {
+      code: "defineMessage({ id: 'in_a_missing_example' })",
+      settings,
+      errors: ['Missing id: in_a_missing_example']
+    },
+    {
+      code: "defineMessage({ id: 'bad_missing_example' })",
+      settings,
+      errors: ['Missing id: bad_missing_example']
+    },
+    {
+      code: 'defineMessage({ id: `in_b_${bogus}_missing` })',
+      settings,
+      errors: ['Missing id pattern: in_b_*_missing']
+    },
     {
       code: "defineMessages({ msg1: { id: `in_a_${bogus}_missing` }, msg2: { id: 'bad_missing_example' }})",
       settings,

Diff for: tests/lib/rules/id-prefix.spec.js

@@ -65,6 +65,18 @@ ruleTester.run('id-prefix', rule, {
     {
       code: "defineMessages({ msg1: { id:`in_a_${bogus}` }, msg2: { id: 'in_b_example' }})",
       options
+    },
+    {
+      code: 'defineMessage({ id:`in_a_${bogus}` })',
+      options
+    },
+    {
+      code: 'defineMessage({ id:`in_a_ignored_${bogus}` })',
+      options
+    },
+    {
+      code: "defineMessage({ id: 'in_b_example' })",
+      options
     }
   ],
 
@@ -93,6 +105,16 @@ ruleTester.run('id-prefix', rule, {
       code: "defineMessages({ msg1: { id: `bad_${bogus}_missing`}, msg2: { id: 'bad_missing_example' }})",
       options,
       errors: ['Invalid id prefix: bad_*_missing', 'Invalid id prefix: bad_missing_example']
+    },
+    {
+      code: 'defineMessage({ id: `bad_${bogus}_missing`})',
+      options,
+      errors: ['Invalid id prefix: bad_*_missing']
+    },
+    {
+      code: "defineMessage({ id: 'bad_missing_example' })",
+      options,
+      errors: ['Invalid id prefix: bad_missing_example']
     }
   ]
 });

Diff for: tests/lib/rules/no-default.spec.js

@@ -20,6 +20,9 @@ ruleTester.run('no-default', rule, {
     },
     {
       code: "defineMessages({ msg1: { id:'in_example' }, msg2: { id:'in_example' }})"
+    },
+    {
+      code: "defineMessage({ id:'in_example' })"
     }
   ],
 
@@ -35,6 +38,10 @@ ruleTester.run('no-default', rule, {
     {
       code: "defineMessages({ msg1: { id: 'in_ex', defaultMessage: 'example'}, msg2: { id: 'in_ex', defaultMessage: 'example' }})",
       errors: ['Do not use defaultMessage', 'Do not use defaultMessage']
+    },
+    {
+      code: "defineMessage({ id: 'in_ex', defaultMessage: 'example' })",
+      errors: ['Do not use defaultMessage']
     }
   ]
 });