eslint-plugin-formatjs 4.2.0 → 4.2.2

package/rules/enforce-plural-rules.ts

@@ -1,134 +0,0 @@
-import {Rule} from 'eslint'
-import {TSESTree} from '@typescript-eslint/typescript-estree'
-import {extractMessages, getSettings} from '../util'
-import {
-  parse,
-  isPluralElement,
-  MessageFormatElement,
-} from '@formatjs/icu-messageformat-parser'
-
-class PluralRulesEnforcement extends Error {
-  public message: string
-  constructor(message: string) {
-    super()
-    this.message = message
-  }
-}
-
-enum LDML {
-  zero = 'zero',
-  one = 'one',
-  two = 'two',
-  few = 'few',
-  many = 'many',
-  other = 'other',
-}
-
-function verifyAst(
-  plConfig: Record<LDML, boolean>,
-  ast: MessageFormatElement[]
-) {
-  for (const el of ast) {
-    if (isPluralElement(el)) {
-      const rules = Object.keys(plConfig) as Array<LDML>
-      for (const rule of rules) {
-        if (plConfig[rule] && !el.options[rule]) {
-          throw new PluralRulesEnforcement(`Missing plural rule "${rule}"`)
-        }
-        if (!plConfig[rule] && el.options[rule]) {
-          throw new PluralRulesEnforcement(`Plural rule "${rule}" is forbidden`)
-        }
-      }
-      const {options} = el
-      for (const selector of Object.keys(options)) {
-        verifyAst(plConfig, options[selector].value)
-      }
-    }
-  }
-}
-
-function checkNode(context: Rule.RuleContext, node: TSESTree.Node) {
-  const settings = getSettings(context)
-  const msgs = extractMessages(node, settings)
-  if (!msgs.length) {
-    return
-  }
-
-  const plConfig: Record<keyof LDML, boolean> = context.options[0]
-  if (!plConfig) {
-    return
-  }
-  for (const [
-    {
-      message: {defaultMessage},
-      messageNode,
-    },
-  ] of msgs) {
-    if (!defaultMessage || !messageNode) {
-      continue
-    }
-    try {
-      verifyAst(
-        context.options[0],
-        parse(defaultMessage, {
-          ignoreTag: settings.ignoreTag,
-        })
-      )
-    } catch (e) {
-      context.report({
-        node: messageNode as any,
-        message: e instanceof Error ? e.message : String(e),
-      })
-    }
-  }
-}
-
-const rule: Rule.RuleModule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description:
-        'Enforce plural rules to always specify certain categories like `one`/`other`',
-      category: 'Errors',
-      recommended: false,
-      url: 'https://formatjs.io/docs/tooling/linter#enforce-plural-rules',
-    },
-    fixable: 'code',
-    schema: [
-      {
-        type: 'object',
-        properties: Object.keys(LDML).reduce(
-          (schema: Record<string, {type: 'boolean'}>, k) => {
-            schema[k] = {
-              type: 'boolean',
-            }
-            return schema
-          },
-          {}
-        ),
-        additionalProperties: false,
-      },
-    ],
-  },
-  create(context) {
-    const callExpressionVisitor = (node: TSESTree.Node) =>
-      checkNode(context, node)
-
-    if (context.parserServices.defineTemplateBodyVisitor) {
-      return context.parserServices.defineTemplateBodyVisitor(
-        {
-          CallExpression: callExpressionVisitor,
-        },
-        {
-          CallExpression: callExpressionVisitor,
-        }
-      )
-    }
-    return {
-      JSXOpeningElement: (node: TSESTree.Node) => checkNode(context, node),
-      CallExpression: callExpressionVisitor,
-    }
-  },
-}
-
-export default rule

package/rules/no-camel-case.ts

@@ -1,97 +0,0 @@
-import {Rule} from 'eslint'
-import {TSESTree} from '@typescript-eslint/typescript-estree'
-import {
-  parse,
-  isPluralElement,
-  MessageFormatElement,
-  isArgumentElement,
-} from '@formatjs/icu-messageformat-parser'
-import {extractMessages, getSettings} from '../util'
-
-const CAMEL_CASE_REGEX = /[A-Z]/
-
-class CamelCase extends Error {
-  public message = 'Camel case arguments are not allowed'
-}
-
-function verifyAst(ast: MessageFormatElement[]) {
-  for (const el of ast) {
-    if (isArgumentElement(el)) {
-      if (CAMEL_CASE_REGEX.test(el.value)) {
-        throw new CamelCase()
-      }
-      continue
-    }
-    if (isPluralElement(el)) {
-      if (CAMEL_CASE_REGEX.test(el.value)) {
-        throw new CamelCase()
-      }
-      const {options} = el
-      for (const selector of Object.keys(options)) {
-        verifyAst(options[selector].value)
-      }
-    }
-  }
-}
-
-function checkNode(context: Rule.RuleContext, node: TSESTree.Node) {
-  const settings = getSettings(context)
-  const msgs = extractMessages(node, settings)
-
-  for (const [
-    {
-      message: {defaultMessage},
-      messageNode,
-    },
-  ] of msgs) {
-    if (!defaultMessage || !messageNode) {
-      continue
-    }
-    try {
-      verifyAst(
-        parse(defaultMessage, {
-          ignoreTag: settings.ignoreTag,
-        })
-      )
-    } catch (e) {
-      context.report({
-        node: messageNode as any,
-        message: e instanceof Error ? e.message : String(e),
-      })
-    }
-  }
-}
-
-const rule: Rule.RuleModule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Disallow camel case placeholders in message',
-      category: 'Errors',
-      recommended: false,
-      url: 'https://formatjs.io/docs/tooling/linter#no-camel-case',
-    },
-    fixable: 'code',
-  },
-  create(context) {
-    const callExpressionVisitor = (node: TSESTree.Node) =>
-      checkNode(context, node)
-
-    if (context.parserServices.defineTemplateBodyVisitor) {
-      return context.parserServices.defineTemplateBodyVisitor(
-        {
-          CallExpression: callExpressionVisitor,
-        },
-        {
-          CallExpression: callExpressionVisitor,
-        }
-      )
-    }
-    return {
-      JSXOpeningElement: (node: TSESTree.Node) => checkNode(context, node),
-      CallExpression: callExpressionVisitor,
-    }
-  },
-}
-
-export default rule

package/rules/no-complex-selectors.ts

@@ -1,125 +0,0 @@
-import {Rule} from 'eslint'
-import {TSESTree} from '@typescript-eslint/typescript-estree'
-import {extractMessages, getSettings} from '../util'
-import {
-  parse,
-  isPluralElement,
-  MessageFormatElement,
-  isSelectElement,
-} from '@formatjs/icu-messageformat-parser'
-import {hoistSelectors} from '@formatjs/icu-messageformat-parser/manipulator'
-
-interface Config {
-  limit: number
-}
-
-function calculateComplexity(ast: MessageFormatElement[]): number {
-  if (ast.length === 1) {
-    const el = ast[0]
-    if (isPluralElement(el) || isSelectElement(el)) {
-      return Object.keys(el.options).reduce((complexity, k) => {
-        return complexity + calculateComplexity(el.options[k].value)
-      }, 0)
-    }
-  }
-  return 1
-}
-
-function checkNode(context: Rule.RuleContext, node: TSESTree.Node) {
-  const settings = getSettings(context)
-  const msgs = extractMessages(node, settings)
-  if (!msgs.length) {
-    return
-  }
-
-  const config: Config = {
-    limit: 20,
-    ...(context.options[0] || {}),
-  }
-
-  for (const [
-    {
-      message: {defaultMessage},
-      messageNode,
-    },
-  ] of msgs) {
-    if (!defaultMessage || !messageNode) {
-      continue
-    }
-
-    let ast: MessageFormatElement[]
-    try {
-      ast = parse(defaultMessage, {
-        ignoreTag: settings.ignoreTag,
-      })
-    } catch (e) {
-      context.report({
-        node: messageNode as any,
-        message: e instanceof Error ? e.message : String(e),
-      })
-      return
-    }
-
-    const hoistedAst = hoistSelectors(ast)
-    const complexity = calculateComplexity(hoistedAst)
-    if (complexity > config.limit) {
-      context.report({
-        node: messageNode as any,
-        message: `Message complexity is too high (${complexity} vs limit at ${config.limit})`,
-      })
-    }
-  }
-}
-
-const rule: Rule.RuleModule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: `Make sure a sentence is not too complex. 
-Complexity is determined by how many strings are produced when we try to
-flatten the sentence given its selectors. For example:
-"I have {count, plural, one{a dog} other{many dogs}}"
-has the complexity of 2 because flattening the plural selector
-results in 2 sentences: "I have a dog" & "I have many dogs".
-Default complexity limit is 20 
-(using Smartling as a reference: https://help.smartling.com/hc/en-us/articles/360008030994-ICU-MessageFormat)
-`,
-      category: 'Errors',
-      recommended: false,
-      url: 'https://formatjs.io/docs/tooling/linter#no-complex-selectors',
-    },
-    schema: [
-      {
-        type: 'object',
-        properties: {
-          limit: {
-            type: 'number',
-          },
-        },
-        additionalProperties: false,
-      },
-    ],
-    fixable: 'code',
-  },
-  create(context) {
-    const callExpressionVisitor = (node: TSESTree.Node) =>
-      checkNode(context, node)
-
-    if (context.parserServices.defineTemplateBodyVisitor) {
-      return context.parserServices.defineTemplateBodyVisitor(
-        {
-          CallExpression: callExpressionVisitor,
-        },
-        {
-          CallExpression: callExpressionVisitor,
-        }
-      )
-    }
-    return {
-      JSXOpeningElement: (node: TSESTree.Node) => checkNode(context, node),
-      CallExpression: callExpressionVisitor,
-    }
-  },
-}
-
-export default rule

package/rules/no-emoji.ts

@@ -1,60 +0,0 @@
-import {Rule} from 'eslint'
-import {TSESTree} from '@typescript-eslint/typescript-estree'
-import {extractMessages, getSettings} from '../util'
-import emojiRegex from 'emoji-regex'
-const EMOJI_REGEX: RegExp = (emojiRegex as any)()
-
-function checkNode(context: Rule.RuleContext, node: TSESTree.Node) {
-  const msgs = extractMessages(node, getSettings(context))
-
-  for (const [
-    {
-      message: {defaultMessage},
-      messageNode,
-    },
-  ] of msgs) {
-    if (!defaultMessage || !messageNode) {
-      continue
-    }
-    if (EMOJI_REGEX.test(defaultMessage)) {
-      context.report({
-        node: messageNode as any,
-        message: 'Emojis are not allowed',
-      })
-    }
-  }
-}
-
-const rule: Rule.RuleModule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Disallow emojis in message',
-      category: 'Errors',
-      recommended: false,
-      url: 'https://formatjs.io/docs/tooling/linter#no-emoji',
-    },
-    fixable: 'code',
-  },
-  create(context) {
-    const callExpressionVisitor = (node: TSESTree.Node) =>
-      checkNode(context, node)
-
-    if (context.parserServices.defineTemplateBodyVisitor) {
-      return context.parserServices.defineTemplateBodyVisitor(
-        {
-          CallExpression: callExpressionVisitor,
-        },
-        {
-          CallExpression: callExpressionVisitor,
-        }
-      )
-    }
-    return {
-      JSXOpeningElement: (node: TSESTree.Node) => checkNode(context, node),
-      CallExpression: callExpressionVisitor,
-    }
-  },
-}
-
-export default rule

package/rules/no-id.ts

@@ -1,63 +0,0 @@
-import {Rule, SourceCode} from 'eslint'
-import {extractMessages, getSettings} from '../util'
-import {TSESTree} from '@typescript-eslint/typescript-estree'
-import * as ESTree from 'estree'
-
-function isComment(
-  token: ReturnType<SourceCode['getTokenAfter']>
-): token is ESTree.Comment {
-  return !!token && (token.type === 'Block' || token.type === 'Line')
-}
-
-function checkNode(context: Rule.RuleContext, node: TSESTree.Node) {
-  const msgs = extractMessages(node, getSettings(context))
-  for (const [{idPropNode}] of msgs) {
-    if (idPropNode) {
-      context.report({
-        node: idPropNode as any,
-        message: 'Manual `id` are not allowed in message descriptor',
-        fix(fixer) {
-          const src = context.getSourceCode()
-          const token = src.getTokenAfter(idPropNode as any)
-          const fixes = [fixer.remove(idPropNode as any)]
-          if (token && !isComment(token) && token?.value === ',') {
-            fixes.push(fixer.remove(token))
-          }
-          return fixes
-        },
-      })
-    }
-  }
-}
-
-export default {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Ban explicit ID from MessageDescriptor',
-      category: 'Errors',
-      recommended: false,
-      url: 'https://formatjs.io/docs/tooling/linter#no-id',
-    },
-    fixable: 'code',
-  },
-  create(context) {
-    const callExpressionVisitor = (node: TSESTree.Node) =>
-      checkNode(context, node)
-
-    if (context.parserServices.defineTemplateBodyVisitor) {
-      return context.parserServices.defineTemplateBodyVisitor(
-        {
-          CallExpression: callExpressionVisitor,
-        },
-        {
-          CallExpression: callExpressionVisitor,
-        }
-      )
-    }
-    return {
-      JSXOpeningElement: (node: TSESTree.Node) => checkNode(context, node),
-      CallExpression: callExpressionVisitor,
-    }
-  },
-} as Rule.RuleModule

package/rules/no-invalid-icu.ts

@@ -1,69 +0,0 @@
-import {Rule} from 'eslint'
-import {TSESTree} from '@typescript-eslint/typescript-estree'
-import {parse} from '@formatjs/icu-messageformat-parser'
-import {extractMessages, getSettings} from '../util'
-
-function checkNode(context: Rule.RuleContext, node: TSESTree.Node) {
-  const settings = getSettings(context)
-  const msgs = extractMessages(node, settings)
-
-  if (!msgs.length) {
-    return
-  }
-
-  for (const [
-    {
-      message: {defaultMessage},
-      messageNode,
-    },
-  ] of msgs) {
-    if (!defaultMessage || !messageNode) {
-      continue
-    }
-
-    try {
-      parse(defaultMessage, {
-        ignoreTag: settings.ignoreTag,
-      })
-    } catch (e) {
-      const msg = e instanceof Error ? e.message : e
-      context.report({
-        node: messageNode as any,
-        message: `Error parsing ICU string: ${msg}`,
-      })
-    }
-  }
-}
-
-const rule: Rule.RuleModule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: `Make sure ICU messages are formatted correctly with no bad select statements, plurals, etc.`,
-      category: 'Errors',
-      recommended: true,
-    },
-    fixable: 'code',
-  },
-  create(context) {
-    const callExpressionVisitor = (node: TSESTree.Node) =>
-      checkNode(context, node)
-
-    if (context.parserServices.defineTemplateBodyVisitor) {
-      return context.parserServices.defineTemplateBodyVisitor(
-        {
-          CallExpression: callExpressionVisitor,
-        },
-        {
-          CallExpression: callExpressionVisitor,
-        }
-      )
-    }
-    return {
-      JSXOpeningElement: (node: TSESTree.Node) => checkNode(context, node),
-      CallExpression: callExpressionVisitor,
-    }
-  },
-}
-
-export default rule