i18next-cli 1.34.0 → 1.35.0

package/dist/esm/extractor/core/key-finder.js

@@ -1 +1,130 @@
-import{glob as r}from"glob";import{processFile as e}from"./extractor.js";import{ConsoleLogger as t}from"../../utils/logger.js";import{createPluginContext as o,initializePlugins as n}from"../plugin-manager.js";import{ASTVisitors as a}from"./ast-visitors.js";import{ExpressionResolver as s}from"../parsers/expression-resolver.js";async function i(i,c=new t){const{plugins:l,...p}=i,m=l||[],f=await async function(e){const t=["node_modules/**"],o=Array.isArray(e.extract.ignore)?e.extract.ignore:e.extract.ignore?[e.extract.ignore]:[];return await r(e.extract.input,{ignore:[...t,...o],cwd:process.cwd()})}(i),u=new Map,g=o(u,m,p,c),x={onBeforeVisitNode:r=>{for(const e of m)try{e.onVisitNode?.(r,g)}catch(r){c.warn(`Plugin ${e.name} onVisitNode failed:`,r)}},resolvePossibleKeyStringValues:r=>m.flatMap(e=>{try{return e.extractKeysFromExpression?.(r,i,c)??[]}catch(r){return c.warn(`Plugin ${e.name} extractKeysFromExpression failed:`,r),[]}}),resolvePossibleContextStringValues:r=>m.flatMap(e=>{try{return e.extractContextFromExpression?.(r,i,c)??[]}catch(r){return c.warn(`Plugin ${e.name} extractContextFromExpression failed:`,r),[]}})},d=new s(x),w=new a(p,g,c,x,d);g.getVarFromScope=w.getVarFromScope.bind(w),await n(m);for(const r of f)await e(r,m,w,g,p,c);for(const r of m)await(r.onEnd?.(u));const y=p.extract?.pluralSeparator??"_",h=["zero","one","two","few","many","other"];for(const r of u.values()){const e=String(r.key).split(y),t=e[e.length-1],o=e.length>=3&&"ordinal"===e[e.length-2];(h.includes(t)||o&&h.includes(t))&&(r.isExpandedPlural=!0)}return{allKeys:u,objectKeys:w.objectKeys}}export{i as findKeys};
+import { glob } from 'glob';
+import { processFile } from './extractor.js';
+import { ConsoleLogger } from '../../utils/logger.js';
+import { createPluginContext, initializePlugins } from '../plugin-manager.js';
+import { ASTVisitors } from './ast-visitors.js';
+import { ExpressionResolver } from '../parsers/expression-resolver.js';
+
+/**
+ * Main function for finding translation keys across all source files in a project.
+ *
+ * This function orchestrates the key extraction process:
+ * 1. Processes source files based on input patterns
+ * 2. Initializes and manages plugins
+ * 3. Processes each file through AST parsing and key extraction
+ * 4. Runs plugin lifecycle hooks
+ * 5. Returns a deduplicated map of all found keys
+ *
+ * @param config - The i18next toolkit configuration object
+ * @param logger - Logger instance for output (defaults to ConsoleLogger)
+ * @returns Promise resolving to a Map of unique translation keys with metadata
+ *
+ * @example
+ * ```typescript
+ * const config = {
+ *   extract: {
+ *     input: ['src/**\/*.{ts,tsx}'],
+ *     functions: ['t', '*.t'],
+ *     transComponents: ['Trans']
+ *   }
+ * }
+ *
+ * const keys = await findKeys(config)
+ * console.log(`Found ${keys.size} unique translation keys`)
+ * ```
+ */
+async function findKeys(config, logger = new ConsoleLogger()) {
+    const { plugins: pluginsOrUndefined, ...otherConfig } = config;
+    const plugins = pluginsOrUndefined || [];
+    const sourceFiles = await processSourceFiles(config);
+    const allKeys = new Map();
+    // 1. Create the base context with config and logger.
+    const pluginContext = createPluginContext(allKeys, plugins, otherConfig, logger);
+    // 2. Create hooks for plugins to hook into AST
+    const hooks = {
+        onBeforeVisitNode: (node) => {
+            for (const plugin of plugins) {
+                try {
+                    plugin.onVisitNode?.(node, pluginContext);
+                }
+                catch (err) {
+                    logger.warn(`Plugin ${plugin.name} onVisitNode failed:`, err);
+                }
+            }
+        },
+        resolvePossibleKeyStringValues: (expression) => {
+            return plugins.flatMap(plugin => {
+                try {
+                    return plugin.extractKeysFromExpression?.(expression, config, logger) ?? [];
+                }
+                catch (err) {
+                    logger.warn(`Plugin ${plugin.name} extractKeysFromExpression failed:`, err);
+                    return [];
+                }
+            });
+        },
+        resolvePossibleContextStringValues: (expression) => {
+            return plugins.flatMap(plugin => {
+                try {
+                    return plugin.extractContextFromExpression?.(expression, config, logger) ?? [];
+                }
+                catch (err) {
+                    logger.warn(`Plugin ${plugin.name} extractContextFromExpression failed:`, err);
+                    return [];
+                }
+            });
+        },
+    };
+    // 3. Create the visitor instance, passing it the context.
+    // Use a shared ExpressionResolver so captured enums/objects in one file are available when resolving MemberExpressions
+    const sharedExpressionResolver = new ExpressionResolver(hooks);
+    const astVisitors = new ASTVisitors(otherConfig, pluginContext, logger, hooks, sharedExpressionResolver);
+    // 4. "Wire up" the visitor's scope method to the context.
+    // This avoids a circular dependency while giving plugins access to the scope.
+    pluginContext.getVarFromScope = astVisitors.getVarFromScope.bind(astVisitors);
+    // 5. Initialize plugins
+    await initializePlugins(plugins);
+    // 6. Process each file
+    for (const file of sourceFiles) {
+        await processFile(file, plugins, astVisitors, pluginContext, otherConfig, logger);
+    }
+    // 7. Run onEnd hooks
+    for (const plugin of plugins) {
+        await plugin.onEnd?.(allKeys);
+    }
+    // Normalization: mark already-expanded plural keys
+    const pluralSeparator = otherConfig.extract?.pluralSeparator ?? '_';
+    const categories = ['zero', 'one', 'two', 'few', 'many', 'other'];
+    for (const ek of allKeys.values()) {
+        const parts = String(ek.key).split(pluralSeparator);
+        const last = parts[parts.length - 1];
+        const isOrdinal = parts.length >= 3 && parts[parts.length - 2] === 'ordinal';
+        if (categories.includes(last) || (isOrdinal && categories.includes(last))) {
+            ek.isExpandedPlural = true;
+        }
+    }
+    return { allKeys, objectKeys: astVisitors.objectKeys };
+}
+/**
+ * Processes source files using glob patterns from configuration.
+ * Excludes node_modules by default and resolves relative to current working directory.
+ *
+ * @param config - The i18next toolkit configuration object
+ * @returns Promise resolving to array of file paths to process
+ *
+ * @internal
+ */
+async function processSourceFiles(config) {
+    const defaultIgnore = ['node_modules/**'];
+    // Normalize the user's ignore option into an array
+    const userIgnore = Array.isArray(config.extract.ignore)
+        ? config.extract.ignore
+        : config.extract.ignore ? [config.extract.ignore] : [];
+    return await glob(config.extract.input, {
+        // Combine default ignore patterns with user-configured ones
+        ignore: [...defaultIgnore, ...userIgnore],
+        cwd: process.cwd(),
+    });
+}
+
+export { findKeys };