@docusaurus/core 0.0.0-4441 → 0.0.0-4443

package/lib/server/translations/translationsExtractor.js

@@ -118,109 +118,142 @@ https://github.com/pugjs/babel-walk
 function extractSourceCodeAstTranslations(ast, sourceCodeFilePath) {
     function sourceWarningPart(node) {
         var _a;
-        return `File: ${sourceCodeFilePath} at ${(_a = node.loc) === null || _a === void 0 ? void 0 : _a.start.line} line\nFull code: ${(0, generator_1.default)(node).code}`;
+        return `File: ${sourceCodeFilePath} at line ${(_a = node.loc) === null || _a === void 0 ? void 0 : _a.start.line}
+Full code: ${(0, generator_1.default)(node).code}`;
     }
     const translations = {};
     const warnings = [];
-    // TODO we should check the presence of the correct @docusaurus imports here!
+    let translateComponentName;
+    let translateFunctionName;
+    // First pass: find import declarations of Translate / translate.
+    // If not found, don't process the rest to avoid false positives
     (0, traverse_1.default)(ast, {
-        JSXElement(path) {
-            if (!path
-                .get('openingElement')
-                .get('name')
-                .isJSXIdentifier({ name: 'Translate' })) {
+        ImportDeclaration(path) {
+            if (path.node.importKind === 'type' ||
+                path.get('source').node.value !== '@docusaurus/Translate') {
                 return;
             }
-            function evaluateJSXProp(propName) {
-                const attributePath = path
-                    .get('openingElement.attributes')
-                    .find((attr) => attr.isJSXAttribute() &&
-                    attr
-                        .get('name')
-                        .isJSXIdentifier({ name: propName }));
-                if (attributePath) {
-                    const attributeValue = attributePath.get('value');
-                    const attributeValueEvaluated = attributeValue.isJSXExpressionContainer()
-                        ? attributeValue.get('expression').evaluate()
-                        : attributeValue.evaluate();
-                    if (attributeValueEvaluated.confident &&
-                        typeof attributeValueEvaluated.value === 'string') {
-                        return attributeValueEvaluated.value;
+            const importSpecifiers = path.get('specifiers');
+            const defaultImport = importSpecifiers.find((specifier) => specifier.node.type === 'ImportDefaultSpecifier');
+            const callbackImport = importSpecifiers.find((specifier) => specifier.node.type === 'ImportSpecifier' &&
+                (specifier.get('imported')
+                    .node.name === 'translate' ||
+                    specifier.get('imported')
+                        .node.value === 'translate'));
+            translateComponentName = defaultImport === null || defaultImport === void 0 ? void 0 : defaultImport.get('local').node.name;
+            translateFunctionName = callbackImport === null || callbackImport === void 0 ? void 0 : callbackImport.get('local').node.name;
+        },
+    });
+    (0, traverse_1.default)(ast, {
+        ...(translateComponentName && {
+            JSXElement(path) {
+                if (!path
+                    .get('openingElement')
+                    .get('name')
+                    .isJSXIdentifier({ name: translateComponentName })) {
+                    return;
+                }
+                function evaluateJSXProp(propName) {
+                    const attributePath = path
+                        .get('openingElement.attributes')
+                        .find((attr) => attr.isJSXAttribute() &&
+                        attr
+                            .get('name')
+                            .isJSXIdentifier({ name: propName }));
+                    if (attributePath) {
+                        const attributeValue = attributePath.get('value');
+                        const attributeValueEvaluated = attributeValue.isJSXExpressionContainer()
+                            ? attributeValue.get('expression').evaluate()
+                            : attributeValue.evaluate();
+                        if (attributeValueEvaluated.confident &&
+                            typeof attributeValueEvaluated.value === 'string') {
+                            return attributeValueEvaluated.value;
+                        }
+                        else {
+                            warnings.push(`<Translate> prop=${propName} should be a statically evaluable object.
+Example: <Translate id="optional id" description="optional description">Message</Translate>
+Dynamically constructed values are not allowed, because they prevent translations to be extracted.
+${sourceWarningPart(path.node)}`);
+                        }
+                    }
+                    return undefined;
+                }
+                const id = evaluateJSXProp('id');
+                const description = evaluateJSXProp('description');
+                let message;
+                const childrenPath = path.get('children');
+                // Handle empty content
+                if (!childrenPath.length) {
+                    if (!id) {
+                        warnings.push(`<Translate> without children must have id prop.
+Example: <Translate id="my-id" />
+${sourceWarningPart(path.node)}`);
                     }
                     else {
-                        warnings.push(`<Translate> prop=${propName} should be a statically evaluable object.\nExample: <Translate id="optional.id" description="optional description">Message</Translate>\nDynamically constructed values are not allowed, because they prevent translations to be extracted.\n${sourceWarningPart(path.node)}`);
+                        translations[id] = {
+                            message: message !== null && message !== void 0 ? message : id,
+                            ...(description && { description }),
+                        };
                     }
+                    return;
                 }
-                return undefined;
-            }
-            const id = evaluateJSXProp('id');
-            const description = evaluateJSXProp('description');
-            let message;
-            const childrenPath = path.get('children');
-            // Handle empty content
-            if (!childrenPath.length) {
-                if (!id) {
-                    warnings.push(`
-            <Translate> without children must have id prop.\nExample: <Translate id="my-id" />\n${sourceWarningPart(path.node)}
-          `);
-                }
-                else {
-                    translations[id] = {
-                        message: message !== null && message !== void 0 ? message : id,
-                        ...(description && { description }),
-                    };
-                }
-                return;
-            }
-            // Handle single non-empty content
-            const singleChildren = childrenPath
-                // Remove empty/useless text nodes that might be around our translation!
-                // Makes the translation system more reliable to JSX formatting issues
-                .filter((children) => !(children.isJSXText() &&
-                children.node.value.replace('\n', '').trim() === ''))
-                .pop();
-            const isJSXText = singleChildren && singleChildren.isJSXText();
-            const isJSXExpressionContainer = singleChildren &&
-                singleChildren.isJSXExpressionContainer() &&
-                singleChildren.get('expression').evaluate().confident;
-            if (isJSXText || isJSXExpressionContainer) {
-                message = isJSXText
-                    ? singleChildren.node.value.trim().replace(/\s+/g, ' ')
-                    : singleChildren.get('expression').evaluate().value;
-                translations[id !== null && id !== void 0 ? id : message] = {
-                    message,
-                    ...(description && { description }),
-                };
-            }
-            else {
-                warnings.push(`Translate content could not be extracted. It has to be a static string and use optional but static props, like <Translate id="my-id" description="my-description">text</Translate>.\n${sourceWarningPart(path.node)}`);
-            }
-        },
-        CallExpression(path) {
-            if (!path.get('callee').isIdentifier({ name: 'translate' })) {
-                return;
-            }
-            const args = path.get('arguments');
-            if (args.length === 1 || args.length === 2) {
-                const firstArgPath = args[0];
-                // evaluation allows translate("x" + "y"); to be considered as translate("xy");
-                const firstArgEvaluated = firstArgPath.evaluate();
-                if (firstArgEvaluated.confident &&
-                    typeof firstArgEvaluated.value === 'object') {
-                    const { message, id, description } = firstArgEvaluated.value;
+                // Handle single non-empty content
+                const singleChildren = childrenPath
+                    // Remove empty/useless text nodes that might be around our translation!
+                    // Makes the translation system more reliable to JSX formatting issues
+                    .filter((children) => !(children.isJSXText() &&
+                    children.node.value.replace('\n', '').trim() === ''))
+                    .pop();
+                const isJSXText = singleChildren && singleChildren.isJSXText();
+                const isJSXExpressionContainer = singleChildren &&
+                    singleChildren.isJSXExpressionContainer() &&
+                    singleChildren.get('expression').evaluate().confident;
+                if (isJSXText || isJSXExpressionContainer) {
+                    message = isJSXText
+                        ? singleChildren.node.value.trim().replace(/\s+/g, ' ')
+                        : singleChildren.get('expression').evaluate().value;
                     translations[id !== null && id !== void 0 ? id : message] = {
-                        message: message !== null && message !== void 0 ? message : id,
+                        message,
                         ...(description && { description }),
                     };
                 }
                 else {
-                    warnings.push(`translate() first arg should be a statically evaluable object.\nExample: translate({message: "text",id: "optional.id",description: "optional description"}\nDynamically constructed values are not allowed, because they prevent translations to be extracted.\n${sourceWarningPart(path.node)}`);
+                    warnings.push(`Translate content could not be extracted. It has to be a static string and use optional but static props, like <Translate id="my-id" description="my-description">text</Translate>.
+${sourceWarningPart(path.node)}`);
                 }
-            }
-            else {
-                warnings.push(`translate() function only takes 1 or 2 args\n${sourceWarningPart(path.node)}`);
-            }
-        },
+            },
+        }),
+        ...(translateFunctionName && {
+            CallExpression(path) {
+                if (!path.get('callee').isIdentifier({ name: translateFunctionName })) {
+                    return;
+                }
+                const args = path.get('arguments');
+                if (args.length === 1 || args.length === 2) {
+                    const firstArgPath = args[0];
+                    // evaluation allows translate("x" + "y"); to be considered as translate("xy");
+                    const firstArgEvaluated = firstArgPath.evaluate();
+                    if (firstArgEvaluated.confident &&
+                        typeof firstArgEvaluated.value === 'object') {
+                        const { message, id, description } = firstArgEvaluated.value;
+                        translations[id !== null && id !== void 0 ? id : message] = {
+                            message: message !== null && message !== void 0 ? message : id,
+                            ...(description && { description }),
+                        };
+                    }
+                    else {
+                        warnings.push(`translate() first arg should be a statically evaluable object.
+Example: translate({message: "text",id: "optional.id",description: "optional description"}
+Dynamically constructed values are not allowed, because they prevent translations to be extracted.
+${sourceWarningPart(path.node)}`);
+                    }
+                }
+                else {
+                    warnings.push(`translate() function only takes 1 or 2 args
+${sourceWarningPart(path.node)}`);
+                }
+            },
+        }),
     });
     return { sourceCodeFilePath, translations, warnings };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4441",
+  "version": "0.0.0-4443",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.16.3",
     "@babel/runtime-corejs3": "^7.16.3",
     "@babel/traverse": "^7.16.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4441",
-    "@docusaurus/logger": "0.0.0-4441",
-    "@docusaurus/mdx-loader": "0.0.0-4441",
+    "@docusaurus/cssnano-preset": "0.0.0-4443",
+    "@docusaurus/logger": "0.0.0-4443",
+    "@docusaurus/mdx-loader": "0.0.0-4443",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4441",
-    "@docusaurus/utils-common": "0.0.0-4441",
-    "@docusaurus/utils-validation": "0.0.0-4441",
+    "@docusaurus/utils": "0.0.0-4443",
+    "@docusaurus/utils-common": "0.0.0-4443",
+    "@docusaurus/utils-validation": "0.0.0-4443",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.0",
     "@svgr/webpack": "^6.0.0",
     "autoprefixer": "^10.3.5",
@@ -108,8 +108,8 @@
     "webpackbar": "^5.0.0-3"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4441",
-    "@docusaurus/types": "0.0.0-4441",
+    "@docusaurus/module-type-aliases": "0.0.0-4443",
+    "@docusaurus/types": "0.0.0-4443",
     "@types/copy-webpack-plugin": "^8.0.1",
     "@types/detect-port": "^1.3.0",
     "@types/mini-css-extract-plugin": "^1.4.3",
@@ -128,5 +128,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "43dbd283d8dbcab6ce2f3b1d2ebc0fe0334c77c9"
+  "gitHead": "2527fb4a3705407f060ff425874fa4972b8eea4c"
 }