feat(eslint-plugin-formatjs): Add literal option to enforce-description & enforce-default-message

Author: Long Ho

packages/eslint-plugin-formatjs/README.md

@@ -123,13 +123,26 @@ const messages = defineMessages({
 });
 ```
 
+#### Options
+
+```json
+{
+  "plugins": ["formatjs"],
+  "rules": {
+    "formatjs/enforce-description": ["error", "literal"]
+  }
+}
+```
+
+Setting `literal` forces `description` to always be a string literal instead of function calls or variables. This is helpful for extraction tools that expects `description` to always be a literal
+
 ### `enforce-default-message`
 
 This enforces `defaultMessage` in the message descriptor.
 
 #### Why
 
-- Can be usefull in case we want to extract messages for translations from source code. This way can make sure people won't forget about defaultMessage
+- Can be useful in case we want to extract messages for translations from source code. This way can make sure people won't forget about defaultMessage
 
 ```tsx
 import {defineMessages} from 'react-intl';
@@ -147,6 +160,19 @@ const messages = defineMessages({
 });
 ```
 
+#### Options
+
+```json
+{
+  "plugins": ["formatjs"],
+  "rules": {
+    "formatjs/enforce-default-message": ["error", "literal"]
+  }
+}
+```
+
+Setting `literal` forces `defaultMessage` to always be a string literal instead of function calls or variables. This is helpful for extraction tools that expects `defaultMessage` to always be a literal
+
 ### `enforce-placeholders`
 
 Makes sure all values are passed in if message has placeholders (number/date/time/plural/select/selectordinal). This requires values to be passed in as literal object (not a variable).

packages/eslint-plugin-formatjs/src/rules/enforce-default-message.ts

@@ -9,17 +9,28 @@ function checkNode(
   importedMacroVars: Scope.Variable[]
 ) {
   const msgs = extractMessages(node as TSESTree.Node, importedMacroVars);
+  const {
+    options: [type],
+  } = context;
   for (const [
     {
       message: {defaultMessage},
       messageNode,
     },
   ] of msgs) {
-    if (!defaultMessage && !messageNode) {
-      context.report({
-        node,
-        message: '`defaultMessage` has to be specified in message descriptor',
-      });
+    if (!defaultMessage) {
+      if (type === 'literal' && messageNode) {
+        context.report({
+          node,
+          message:
+            '`defaultMessage` must be a string literal (not function call or variable)',
+        });
+      } else if (!messageNode) {
+        context.report({
+          node,
+          message: '`defaultMessage` has to be specified in message descriptor',
+        });
+      }
     }
   }
 }
@@ -35,6 +46,11 @@ const rule: Rule.RuleModule = {
         'https://github.com/formatjs/formatjs/tree/master/packages/eslint-plugin-formatjs#enforce-default-message',
     },
     fixable: 'code',
+    schema: [
+      {
+        enum: ['literal', 'anything'],
+      },
+    ],
   },
   create(context) {
     let importedMacroVars: Scope.Variable[] = [];

packages/eslint-plugin-formatjs/src/rules/enforce-description.ts

@@ -9,17 +9,28 @@ function checkNode(
   importedMacroVars: Scope.Variable[]
 ) {
   const msgs = extractMessages(node as TSESTree.Node, importedMacroVars);
+  const {
+    options: [type],
+  } = context;
   for (const [
     {
       message: {description},
       descriptionNode,
     },
   ] of msgs) {
-    if (!description && !descriptionNode) {
-      context.report({
-        node,
-        message: '`description` has to be specified in message descriptor',
-      });
+    if (!description) {
+      if (type === 'literal' && descriptionNode) {
+        context.report({
+          node,
+          message:
+            '`description` has to be a string literal (not function call or variable)',
+        });
+      } else if (!descriptionNode) {
+        context.report({
+          node,
+          message: '`description` has to be specified in message descriptor',
+        });
+      }
     }
   }
 }
@@ -35,6 +46,11 @@ export default {
         'https://github.com/formatjs/formatjs/tree/master/packages/eslint-plugin-formatjs#enforce-description',
     },
     fixable: 'code',
+    schema: [
+      {
+        enum: ['literal', 'anything'],
+      },
+    ],
   },
   create(context) {
     let importedMacroVars: Scope.Variable[] = [];

packages/eslint-plugin-formatjs/tests/enforce-default-message.test.ts

@@ -31,6 +31,20 @@ _({
         },
       ],
     },
+    {
+      code: `
+            import {_} from '@formatjs/macro'
+            _({
+                defaultMessage: foo
+            })`,
+      errors: [
+        {
+          message:
+            '`defaultMessage` must be a string literal (not function call or variable)',
+        },
+      ],
+      options: ['literal'],
+    },
     {
       code: `
             intl.formatMessage({

packages/eslint-plugin-formatjs/tests/enforce-description.test.ts

@@ -31,6 +31,21 @@ _({
         },
       ],
     },
+    {
+      code: `
+            import {_} from '@formatjs/macro'
+            _({
+                defaultMessage: '{count, plural, one {#} other {# more}}',
+                description: foo
+            })`,
+      errors: [
+        {
+          message:
+            '`description` has to be a string literal (not function call or variable)',
+        },
+      ],
+      options: ['literal'],
+    },
     {
       code: `
             intl.formatMessage({