@docusaurus/eslint-plugin 0.0.0-4933 → 0.0.0-4940

package/lib/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare const _default: {
+    rules: {
+        'no-untranslated-text': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"translateChildren", [{
+            ignoredStrings: string[];
+        }], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+        'string-literal-i18n-messages': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"translateChildren" | "translateArg", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+    };
+    configs: {
+        recommended: {
+            rules: {
+                '@docusaurus/string-literal-i18n-messages': string;
+            };
+        };
+        all: {
+            rules: {
+                '@docusaurus/string-literal-i18n-messages': string;
+                '@docusaurus/no-untranslated-text': string;
+            };
+        };
+    };
+};
+export = _default;

package/lib/index.js

@@ -1,25 +1,25 @@
+"use strict";
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-const requireIndex = require('requireindex');
-
+const tslib_1 = require("tslib");
+const rules_1 = tslib_1.__importDefault(require("./rules"));
 module.exports = {
-  rules: requireIndex(`${__dirname}/rules`),
-  configs: {
-    recommended: {
-      rules: {
-        '@docusaurus/string-literal-i18n-messages': 'error',
-      },
+    rules: rules_1.default,
+    configs: {
+        recommended: {
+            rules: {
+                '@docusaurus/string-literal-i18n-messages': 'error',
+            },
+        },
+        all: {
+            rules: {
+                '@docusaurus/string-literal-i18n-messages': 'error',
+                '@docusaurus/no-untranslated-text': 'warn',
+            },
+        },
     },
-    all: {
-      rules: {
-        '@docusaurus/string-literal-i18n-messages': 'error',
-        '@docusaurus/no-untranslated-text': 'warn',
-      },
-    },
-  },
 };

package/lib/rules/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare const _default: {
+    'no-untranslated-text': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"translateChildren", [{
+        ignoredStrings: string[];
+    }], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+    'string-literal-i18n-messages': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"translateChildren" | "translateArg", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+};
+export default _default;

package/lib/rules/index.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const no_untranslated_text_1 = tslib_1.__importDefault(require("./no-untranslated-text"));
+const string_literal_i18n_messages_1 = tslib_1.__importDefault(require("./string-literal-i18n-messages"));
+exports.default = {
+    'no-untranslated-text': no_untranslated_text_1.default,
+    'string-literal-i18n-messages': string_literal_i18n_messages_1.default,
+};

package/lib/rules/no-untranslated-text.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare type Options = [
+    {
+        ignoredStrings: string[];
+    }
+];
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"translateChildren", Options, import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default _default;

package/lib/rules/no-untranslated-text.js

@@ -1,71 +1,58 @@
+"use strict";
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-const {isTextLabelChild, report} = require('../util');
-
-/**
- * @type {import('eslint').Rule.RuleModule}
- */
-module.exports = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description:
-        'enforce text labels in JSX to be wrapped by translate calls',
-      category: 'Suggestions',
-      url: 'https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text',
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+exports.default = (0, util_1.createRule)({
+    name: 'no-untranslated-text',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'enforce text labels in JSX to be wrapped by translate calls',
+            recommended: false,
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    ignoredStrings: {
+                        type: 'array',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            translateChildren: 'All text labels in JSX should be wrapped by translate calls',
+        },
     },
-    schema: [
-      {
-        type: 'object',
-        properties: {
-          ignoreStrings: {
-            type: 'array',
-          },
+    defaultOptions: [
+        {
+            ignoredStrings: [],
         },
-        additionalProperties: false,
-      },
     ],
-    messages: {
-      translateChildren:
-        'All text labels in JSX should be wrapped by translate calls',
+    create(context, [options]) {
+        const { ignoredStrings } = options;
+        return {
+            JSXElement(node) {
+                if (node.openingElement.selfClosing ||
+                    node.openingElement.name.name ===
+                        'Translate') {
+                    return;
+                }
+                if (node.children.some((child) => (0, util_1.isTextLabelChild)(child, { ignoredStrings }))) {
+                    context.report({ node, messageId: 'translateChildren' });
+                }
+            },
+            JSXFragment(node) {
+                if (node.children.some((child) => (0, util_1.isTextLabelChild)(child, { ignoredStrings }))) {
+                    context.report({ node, messageId: 'translateChildren' });
+                }
+            },
+        };
     },
-  },
-
-  create(context) {
-    const stringsToIgnore = context.options[0]?.ignoreStrings ?? [];
-
-    const isParentTranslate = ({child, isParentFragment}) =>
-      !isParentFragment &&
-      child.parent.openingElement.name.name === 'Translate';
-
-    const isChildValid = ({child, isParentFragment}) => {
-      if (!isTextLabelChild({child, ignoreWhitespace: true, stringsToIgnore})) {
-        return true;
-      }
-      return isParentTranslate({child, isParentFragment});
-    };
-
-    const isNodeValid = ({node, isFragment = false} = {}) =>
-      node.children.every((child) =>
-        isChildValid({child, isParentFragment: isFragment}),
-      );
-
-    return {
-      'JSXElement[openingElement.selfClosing=false]': (node) => {
-        if (!isNodeValid({node})) {
-          report(context, node, 'translateChildren');
-        }
-      },
-      'JSXFragment[openingFragment]': (node) => {
-        if (!isNodeValid({node, isFragment: true})) {
-          report(context, node, 'translateChildren');
-        }
-      },
-    };
-  },
-};
+});

package/lib/rules/string-literal-i18n-messages.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare type MessageIds = 'translateChildren' | 'translateArg';
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<MessageIds, [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default _default;

package/lib/rules/string-literal-i18n-messages.js

@@ -1,62 +1,57 @@
+"use strict";
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-const {
-  isTextLabelChild,
-  report,
-  isStringWithoutExpressions,
-} = require('../util');
-
-/**
- * @type {import('eslint').Rule.RuleModule}
- */
-module.exports = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'enforce translate APIs to be called on plain text labels',
-      category: 'Possible Problems',
-      url: 'https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages',
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+exports.default = (0, util_1.createRule)({
+    name: 'string-literal-i18n-messages',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'enforce translate APIs to be called on plain text labels',
+            recommended: 'error',
+        },
+        schema: [],
+        messages: {
+            translateChildren: '<Translate> children must be hardcoded strings. You can have in-string dynamic placeholders using the values prop.',
+            translateArg: 'translation message must be a hardcoded string. You can have in-string dynamic placeholders using the values argument.',
+        },
     },
-    schema: [],
-    messages: {
-      translateChildren:
-        '<Translate> children must be hardcoded strings. You can have in-string dynamic placeholders using the values prop.',
-      translateArg:
-        'translation message must be a hardcoded string. You can have in-string dynamic placeholders using the values argument.',
+    defaultOptions: [],
+    create(context) {
+        return {
+            JSXElement(node) {
+                if (node.openingElement.name.name !==
+                    'Translate') {
+                    return;
+                }
+                if (node.children.some((child) => !(0, util_1.isTextLabelChild)(child))) {
+                    context.report({ node, messageId: 'translateChildren' });
+                }
+            },
+            CallExpression(node) {
+                if (node.callee.type !== 'Identifier' ||
+                    node.callee.name !== 'translate') {
+                    return;
+                }
+                const param = node.arguments[0];
+                if (!param || param.type !== 'ObjectExpression') {
+                    context.report({ node, messageId: 'translateArg' });
+                    return;
+                }
+                const messageProperty = param.properties.find((property) => property.type === 'Property' &&
+                    property.key.name === 'message');
+                if (!messageProperty) {
+                    return;
+                }
+                if (!(0, util_1.isStringWithoutExpressions)(messageProperty.value)) {
+                    context.report({ node, messageId: 'translateArg' });
+                }
+            },
+        };
     },
-  },
-
-  create(context) {
-    const isNodeValid = (node) =>
-      node.children.every((child) => isTextLabelChild({child}));
-
-    return {
-      "JSXElement[openingElement.name.name='Translate']": (node) => {
-        if (!isNodeValid(node)) {
-          report(context, node, 'translateChildren');
-        }
-      },
-      "CallExpression > Identifier[name='translate']": (node) => {
-        const messageProperty = node.parent.arguments[0].properties.find(
-          (property) => property.key.name === 'message',
-        );
-        if (!messageProperty) {
-          return;
-        }
-
-        if (
-          !isStringWithoutExpressions({
-            text: messageProperty.value,
-          })
-        ) {
-          report(context, node, 'translateArg');
-        }
-      },
-    };
-  },
-};
+});

package/lib/util.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { ESLintUtils } from '@typescript-eslint/utils';
+import type { TSESTree } from '@typescript-eslint/types/dist/ts-estree';
+declare type CheckTranslateChildOptions = {
+    ignoredStrings?: string[];
+};
+export declare function isStringWithoutExpressions(text: TSESTree.Node, options?: CheckTranslateChildOptions): boolean;
+export declare function isTextLabelChild(child: TSESTree.JSXChild, options?: CheckTranslateChildOptions): boolean;
+export declare const createRule: <TOptions extends readonly unknown[], TMessageIds extends string, TRuleListener extends import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener = import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<TOptions, TMessageIds, TRuleListener>>) => import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<TMessageIds, TOptions, TRuleListener>;
+export {};

package/lib/util.js

@@ -1,145 +1,44 @@
+"use strict";
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-const isMadeOfIgnoredStrings = ({text, stringsToIgnore}) =>
-  text
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRule = exports.isTextLabelChild = exports.isStringWithoutExpressions = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const isMadeOfIgnoredStrings = (text, ignoredStrings) => text
     .trim()
     .split(/\s+/)
-    .every((string) => stringsToIgnore.includes(string));
-
-const isWhitespace = (text) => !text || !text.trim();
-
-const isTextValid = ({text, ignoreWhitespace, stringsToIgnore}) =>
-  !!text &&
-  !(ignoreWhitespace && isWhitespace(text)) &&
-  !isMadeOfIgnoredStrings({
-    text,
-    stringsToIgnore,
-  });
-
-const isStringWithoutExpressions = ({
-  text,
-  ignoreWhitespace = false,
-  stringsToIgnore = [],
-} = {}) => {
-  switch (text.type) {
-    case 'Literal':
-      return isTextValid({text: text.value, ignoreWhitespace, stringsToIgnore});
-    case 'TemplateLiteral':
-      return (
-        !text.expressions.length &&
-        isTextValid({
-          text: text.quasis[0].value.raw,
-          ignoreWhitespace,
-          stringsToIgnore,
-        })
-      );
-    default:
-      return false;
-  }
-};
-
-const isTextLabelChild = ({
-  child,
-  ignoreWhitespace = false,
-  stringsToIgnore = [],
-} = {}) => {
-  switch (child.type) {
-    case 'JSXText':
-      return isTextValid({
-        text: child.value,
-        ignoreWhitespace,
-        stringsToIgnore,
-      });
-    case 'JSXExpressionContainer':
-      return isStringWithoutExpressions({
-        text: child.expression,
-        ignoreWhitespace,
-        stringsToIgnore,
-      });
-    default:
-      return false;
-  }
-};
-
-const report = (context, node, messageId) => {
-  context.report({
-    node,
-    messageId,
-  });
-};
-
-const getCommonValidTests = () => [
-  {
-    code: '<Translate>text</Translate>',
-  },
-  {
-    code: '<Translate> text </Translate>',
-  },
-  {
-    code: '<Translate>"text"</Translate>',
-  },
-  {
-    code: "<Translate>'text'</Translate>",
-  },
-  {
-    code: '<Translate>`text`</Translate>',
-  },
-  {
-    code: '<Translate>{"text"}</Translate>',
-  },
-  {
-    code: "<Translate>{'text'}</Translate>",
-  },
-  {
-    code: '<Translate>{`text`}</Translate>',
-  },
-  {
-    code: '<Component>{text}</Component>',
-  },
-  {
-    code: '<Component> {text} </Component>',
-  },
-  {
-    code: 'translate({message: `My page meta title`})',
-  },
-  {
-    code: `<Translate
-              id="homepage.title"
-              description="The homepage welcome message">
-                Welcome to my website
-            </Translate>`,
-  },
-  {
-    code: `<Translate
-              values={{firstName: 'Sébastien'}}>
-                {'Welcome, {firstName}! How are you?'}
-            </Translate>`,
-  },
-  {
-    code: `<Translate>{'This'} is {\`valid\`}</Translate>`,
-  },
-  {
-    code: "translate({message: 'My page meta title'})",
-  },
-  {
-    code: "translate({message: 'The logo of site {siteName}'}, {siteName: 'Docusaurus'})",
-  },
-  {
-    code: 'translate({otherProp: metaTitle})',
-  },
-  {
-    code: 'translate({otherProp: `My page meta title`})',
-  },
-];
-
-module.exports = {
-  isTextLabelChild,
-  report,
-  getCommonValidTests,
-  isStringWithoutExpressions,
+    .every((string) => !string || ignoredStrings.includes(string));
+const isValidTranslationLabel = (text, { ignoredStrings } = {}) => {
+    if (!ignoredStrings) {
+        return typeof text === 'string';
+    }
+    return (typeof text === 'string' && !isMadeOfIgnoredStrings(text, ignoredStrings));
 };
+function isStringWithoutExpressions(text, options) {
+    switch (text.type) {
+        case 'Literal':
+            return isValidTranslationLabel(text.value, options);
+        case 'TemplateLiteral':
+            return (text.expressions.length === 0 &&
+                isValidTranslationLabel(text.quasis[0].value.raw, options));
+        default:
+            return false;
+    }
+}
+exports.isStringWithoutExpressions = isStringWithoutExpressions;
+function isTextLabelChild(child, options) {
+    switch (child.type) {
+        case 'JSXText':
+            return isValidTranslationLabel(child.value, options);
+        case 'JSXExpressionContainer':
+            return isStringWithoutExpressions(child.expression, options);
+        default:
+            return false;
+    }
+}
+exports.isTextLabelChild = isTextLabelChild;
+exports.createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin/${name}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/eslint-plugin",
-  "version": "0.0.0-4933",
+  "version": "0.0.0-4940",
   "description": "ESLint plugin to enforce best Docusaurus practices.",
   "main": "lib/index.js",
   "keywords": [
@@ -17,8 +17,12 @@
     "access": "public"
   },
   "license": "MIT",
+  "scripts": {
+    "build": "tsc"
+  },
   "dependencies": {
-    "requireindex": "^1.2.0"
+    "@typescript-eslint/utils": "^5.21.0",
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
     "eslint-plugin-eslint-plugin": "^4.1.0"
@@ -29,5 +33,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "574df22fbe70bb8171267e47548a13921c083f8a"
+  "gitHead": "e2752f0bd8c9da9eff67162cb5f64dc30194cbf9"
 }

package/src/index.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import rules from './rules';
+
+export = {
+  rules,
+  configs: {
+    recommended: {
+      rules: {
+        '@docusaurus/string-literal-i18n-messages': 'error',
+      },
+    },
+    all: {
+      rules: {
+        '@docusaurus/string-literal-i18n-messages': 'error',
+        '@docusaurus/no-untranslated-text': 'warn',
+      },
+    },
+  },
+};

package/src/rules/index.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import noUntranslatedText from './no-untranslated-text';
+import stringLiteralI18nMessages from './string-literal-i18n-messages';
+
+export default {
+  'no-untranslated-text': noUntranslatedText,
+  'string-literal-i18n-messages': stringLiteralI18nMessages,
+};

package/src/rules/no-untranslated-text.ts

@@ -0,0 +1,79 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {isTextLabelChild, createRule} from '../util';
+import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
+
+type Options = [
+  {
+    ignoredStrings: string[];
+  },
+];
+type MessageIds = 'translateChildren';
+
+export default createRule<Options, MessageIds>({
+  name: 'no-untranslated-text',
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description:
+        'enforce text labels in JSX to be wrapped by translate calls',
+      recommended: false,
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          ignoredStrings: {
+            type: 'array',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      translateChildren:
+        'All text labels in JSX should be wrapped by translate calls',
+    },
+  },
+  defaultOptions: [
+    {
+      ignoredStrings: [],
+    },
+  ],
+
+  create(context, [options]) {
+    const {ignoredStrings} = options;
+    return {
+      JSXElement(node) {
+        if (
+          node.openingElement.selfClosing ||
+          (node.openingElement.name as TSESTree.JSXIdentifier).name ===
+            'Translate'
+        ) {
+          return;
+        }
+        if (
+          node.children.some((child) =>
+            isTextLabelChild(child, {ignoredStrings}),
+          )
+        ) {
+          context.report({node, messageId: 'translateChildren'});
+        }
+      },
+      JSXFragment(node) {
+        if (
+          node.children.some((child) =>
+            isTextLabelChild(child, {ignoredStrings}),
+          )
+        ) {
+          context.report({node, messageId: 'translateChildren'});
+        }
+      },
+    };
+  },
+});

package/src/rules/string-literal-i18n-messages.ts

@@ -0,0 +1,76 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {
+  isTextLabelChild,
+  isStringWithoutExpressions,
+  createRule,
+} from '../util';
+import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
+
+type Options = [];
+type MessageIds = 'translateChildren' | 'translateArg';
+
+export default createRule<Options, MessageIds>({
+  name: 'string-literal-i18n-messages',
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'enforce translate APIs to be called on plain text labels',
+      recommended: 'error',
+    },
+    schema: [],
+    messages: {
+      translateChildren:
+        '<Translate> children must be hardcoded strings. You can have in-string dynamic placeholders using the values prop.',
+      translateArg:
+        'translation message must be a hardcoded string. You can have in-string dynamic placeholders using the values argument.',
+    },
+  },
+  defaultOptions: [],
+
+  create(context) {
+    return {
+      JSXElement(node) {
+        if (
+          (node.openingElement.name as TSESTree.JSXIdentifier).name !==
+          'Translate'
+        ) {
+          return;
+        }
+        if (node.children.some((child) => !isTextLabelChild(child))) {
+          context.report({node, messageId: 'translateChildren'});
+        }
+      },
+      CallExpression(node) {
+        if (
+          node.callee.type !== 'Identifier' ||
+          node.callee.name !== 'translate'
+        ) {
+          return;
+        }
+        const param = node.arguments[0];
+        if (!param || param.type !== 'ObjectExpression') {
+          context.report({node, messageId: 'translateArg'});
+          return;
+        }
+        const messageProperty = param.properties.find(
+          (property): property is TSESTree.Property =>
+            property.type === 'Property' &&
+            (property.key as TSESTree.Identifier).name === 'message',
+        );
+        if (!messageProperty) {
+          return;
+        }
+
+        if (!isStringWithoutExpressions(messageProperty.value)) {
+          context.report({node, messageId: 'translateArg'});
+        }
+      },
+    };
+  },
+});

package/src/util.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {ESLintUtils} from '@typescript-eslint/utils';
+import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
+
+type CheckTranslateChildOptions = {
+  ignoredStrings?: string[];
+};
+
+const isMadeOfIgnoredStrings = (text: string, ignoredStrings: string[]) =>
+  text
+    .trim()
+    .split(/\s+/)
+    .every((string) => !string || ignoredStrings.includes(string));
+
+const isValidTranslationLabel = (
+  text: unknown,
+  {ignoredStrings}: CheckTranslateChildOptions = {},
+) => {
+  if (!ignoredStrings) {
+    return typeof text === 'string';
+  }
+  return (
+    typeof text === 'string' && !isMadeOfIgnoredStrings(text, ignoredStrings)
+  );
+};
+
+export function isStringWithoutExpressions(
+  text: TSESTree.Node,
+  options?: CheckTranslateChildOptions,
+): boolean {
+  switch (text.type) {
+    case 'Literal':
+      return isValidTranslationLabel(text.value, options);
+    case 'TemplateLiteral':
+      return (
+        text.expressions.length === 0 &&
+        isValidTranslationLabel(text.quasis[0]!.value.raw, options)
+      );
+    default:
+      return false;
+  }
+}
+
+export function isTextLabelChild(
+  child: TSESTree.JSXChild,
+  options?: CheckTranslateChildOptions,
+): boolean {
+  switch (child.type) {
+    case 'JSXText':
+      return isValidTranslationLabel(child.value, options);
+    case 'JSXExpressionContainer':
+      return isStringWithoutExpressions(child.expression, options);
+    default:
+      return false;
+  }
+}
+
+export const createRule = ESLintUtils.RuleCreator(
+  (name) =>
+    `https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin/${name}`,
+);