@lang-tag/cli 0.12.3 → 0.13.0

package/README.md

@@ -1,5 +1,6 @@
 # Lang-tag CLI
 
+
 A professional solution for managing translations in modern JavaScript/TypeScript projects, especially those using component-based architectures. `lang-tag` simplifies internationalization by allowing you to define translation keys directly within the components where they are used. Translations become local, callable function objects with full TypeScript support, IntelliSense, and compile-time safety.
 
 ## Key Benefits

package/algorithms/config-generation/path-based-config-generator.d.ts

@@ -47,16 +47,43 @@ export interface PathBasedConfigGeneratorOptions {
     /**
      * Hierarchical structure for ignoring specific directory patterns.
      * Keys represent path segments to match, values indicate what to ignore at that level.
+     * Supports special key `_` when set to `true` to ignore current segment but continue hierarchy.
      *
      * @example
      * {
      *   'src': {
      *     'app': true,  // ignore 'app' when under 'src'
-     *     'features': ['auth', 'admin']  // ignore 'auth' and 'admin' under 'src/features'
+     *     'features': ['auth', 'admin'],  // ignore 'auth' and 'admin' under 'src/features'
+     *     'dashboard': {
+     *       _: true,  // ignore 'dashboard' but continue with nested rules
+     *       modules: true  // also ignore 'modules' under 'dashboard'
+     *     }
      *   }
      * }
      */
     ignoreStructured?: Record<string, any>;
+    /**
+     * Advanced hierarchical rules for transforming path segments.
+     * Supports ignoring and renaming segments with special keys:
+     * - `_`: when `false`, ignores the current segment but continues hierarchy
+     * - `>`: renames the current segment to the specified value
+     * - Regular keys: nested rules or boolean/string for child segments
+     *
+     * @example
+     * {
+     *   app: {
+     *     dashboard: {
+     *       _: false,          // ignore "dashboard" segment
+     *       modules: false     // ignore "modules" when under "dashboard"
+     *     },
+     *     admin: {
+     *       '>': 'management', // rename "admin" to "management"
+     *       users: true        // keep "users" as is (does nothing)
+     *     }
+     *   }
+     * }
+     */
+    pathRules?: Record<string, any>;
     /**
      * Convert the final namespace to lowercase.
      * @default false

package/algorithms/index.cjs

@@ -27,12 +27,20 @@ function pathBasedConfigGenerator(options = {}) {
     ignoreDirectories = [],
     ignoreIncludesRootDirectories = false,
     ignoreStructured = {},
+    pathRules = {},
     lowercaseNamespace = false,
     namespaceCase,
     pathCase,
     fallbackNamespace,
     clearOnDefaultNamespace = true
   } = options;
+  const hasPathRules = Object.keys(pathRules).length > 0;
+  const hasIgnoreStructured = Object.keys(ignoreStructured).length > 0;
+  if (hasPathRules && hasIgnoreStructured) {
+    throw new Error(
+      'pathBasedConfigGenerator: Cannot use both "pathRules" and "ignoreStructured" options simultaneously. Please use "pathRules" (recommended) or "ignoreStructured" (legacy), but not both.'
+    );
+  }
   return async (event) => {
     const { relativePath, langTagConfig } = event;
     const actualFallbackNamespace = fallbackNamespace ?? langTagConfig.collect?.defaultNamespace;
@@ -54,7 +62,11 @@ function pathBasedConfigGenerator(options = {}) {
       }
       return segment;
     }).filter((seg) => seg !== null);
-    pathSegments = applyStructuredIgnore(pathSegments, ignoreStructured);
+    if (hasPathRules) {
+      pathSegments = applyPathRules(pathSegments, pathRules);
+    } else {
+      pathSegments = applyStructuredIgnore(pathSegments, ignoreStructured);
+    }
     if (ignoreIncludesRootDirectories && langTagConfig.includes && pathSegments.length > 0) {
       const extractedDirectories = extractRootDirectoriesFromIncludes(langTagConfig.includes);
       if (extractedDirectories.includes(pathSegments[0])) {
@@ -135,7 +147,56 @@ function applyStructuredIgnore(segments, structure) {
         currentStructure = structure;
         continue;
       } else if (typeof rule === "object" && rule !== null) {
+        const ignoreSelf = rule["_"] === true;
+        if (ignoreSelf) {
+          currentStructure = rule;
+          continue;
+        } else {
+          result.push(segment);
+          currentStructure = rule;
+          continue;
+        }
+      }
+    }
+    result.push(segment);
+    currentStructure = structure;
+  }
+  return result;
+}
+function applyPathRules(segments, structure) {
+  const result = [];
+  let currentStructure = structure;
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i];
+    if (segment in currentStructure) {
+      const rule = currentStructure[segment];
+      if (rule === true) {
+        currentStructure = structure;
+        continue;
+      } else if (rule === false) {
+        currentStructure = structure;
+        continue;
+      } else if (typeof rule === "string") {
+        result.push(rule);
+        currentStructure = structure;
+        continue;
+      } else if (Array.isArray(rule)) {
         result.push(segment);
+        if (i + 1 < segments.length && rule.includes(segments[i + 1])) {
+          i++;
+        }
+        currentStructure = structure;
+        continue;
+      } else if (typeof rule === "object" && rule !== null) {
+        const ignoreSelf = rule["_"] === false;
+        const renameTo = rule[">"];
+        if (!ignoreSelf) {
+          if (typeof renameTo === "string") {
+            result.push(renameTo);
+          } else {
+            result.push(segment);
+          }
+        }
         currentStructure = rule;
         continue;
       }

package/algorithms/index.js

@@ -8,12 +8,20 @@ function pathBasedConfigGenerator(options = {}) {
     ignoreDirectories = [],
     ignoreIncludesRootDirectories = false,
     ignoreStructured = {},
+    pathRules = {},
     lowercaseNamespace = false,
     namespaceCase,
     pathCase,
     fallbackNamespace,
     clearOnDefaultNamespace = true
   } = options;
+  const hasPathRules = Object.keys(pathRules).length > 0;
+  const hasIgnoreStructured = Object.keys(ignoreStructured).length > 0;
+  if (hasPathRules && hasIgnoreStructured) {
+    throw new Error(
+      'pathBasedConfigGenerator: Cannot use both "pathRules" and "ignoreStructured" options simultaneously. Please use "pathRules" (recommended) or "ignoreStructured" (legacy), but not both.'
+    );
+  }
   return async (event) => {
     const { relativePath, langTagConfig } = event;
     const actualFallbackNamespace = fallbackNamespace ?? langTagConfig.collect?.defaultNamespace;
@@ -35,7 +43,11 @@ function pathBasedConfigGenerator(options = {}) {
       }
       return segment;
     }).filter((seg) => seg !== null);
-    pathSegments = applyStructuredIgnore(pathSegments, ignoreStructured);
+    if (hasPathRules) {
+      pathSegments = applyPathRules(pathSegments, pathRules);
+    } else {
+      pathSegments = applyStructuredIgnore(pathSegments, ignoreStructured);
+    }
     if (ignoreIncludesRootDirectories && langTagConfig.includes && pathSegments.length > 0) {
       const extractedDirectories = extractRootDirectoriesFromIncludes(langTagConfig.includes);
       if (extractedDirectories.includes(pathSegments[0])) {
@@ -116,7 +128,56 @@ function applyStructuredIgnore(segments, structure) {
         currentStructure = structure;
         continue;
       } else if (typeof rule === "object" && rule !== null) {
+        const ignoreSelf = rule["_"] === true;
+        if (ignoreSelf) {
+          currentStructure = rule;
+          continue;
+        } else {
+          result.push(segment);
+          currentStructure = rule;
+          continue;
+        }
+      }
+    }
+    result.push(segment);
+    currentStructure = structure;
+  }
+  return result;
+}
+function applyPathRules(segments, structure) {
+  const result = [];
+  let currentStructure = structure;
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i];
+    if (segment in currentStructure) {
+      const rule = currentStructure[segment];
+      if (rule === true) {
+        currentStructure = structure;
+        continue;
+      } else if (rule === false) {
+        currentStructure = structure;
+        continue;
+      } else if (typeof rule === "string") {
+        result.push(rule);
+        currentStructure = structure;
+        continue;
+      } else if (Array.isArray(rule)) {
         result.push(segment);
+        if (i + 1 < segments.length && rule.includes(segments[i + 1])) {
+          i++;
+        }
+        currentStructure = structure;
+        continue;
+      } else if (typeof rule === "object" && rule !== null) {
+        const ignoreSelf = rule["_"] === false;
+        const renameTo = rule[">"];
+        if (!ignoreSelf) {
+          if (typeof renameTo === "string") {
+            result.push(renameTo);
+          } else {
+            result.push(segment);
+          }
+        }
         currentStructure = rule;
         continue;
       }

package/index.cjs

@@ -484,7 +484,8 @@ async function checkAndRegenerateFileLangTags(config, logger, file, path$12) {
   if (replacements.length) {
     const newContent = processor.replaceTags(fileContent, replacements);
     await promises.writeFile(file, newContent, "utf-8");
-    logger.info('Lang tag configurations written for file "{path}" (file://{file}:{line})', { path: path$12, file, line: lastUpdatedLine });
+    const encodedFile = encodeURI(file);
+    logger.info('Lang tag configurations written for file "{path}" (file://{file}:{line})', { path: path$12, file: encodedFile, line: lastUpdatedLine });
     return true;
   }
   return false;
@@ -904,7 +905,8 @@ async function logTagConflictInfo(tagInfo, prefix, conflictPath, translationArgP
         console.error("Failed to colorize config:", error);
       }
     }
-    console.log(`${ANSI.gray}${prefix}${ANSI.reset} ${ANSI.cyan}file://${filePath}${ANSI.reset}${ANSI.gray}:${lineNum}${ANSI.reset}`);
+    const encodedPath = encodeURI(filePath);
+    console.log(`${ANSI.gray}${prefix}${ANSI.reset} ${ANSI.cyan}file://${encodedPath}${ANSI.reset}${ANSI.gray}:${lineNum}${ANSI.reset}`);
     printLines(colorizedWhole.split("\n"), startLine, errorLines, condense);
   } catch (error) {
     console.error("Error displaying conflict:", error);
@@ -1452,7 +1454,20 @@ const generationAlgorithm = pathBasedConfigGenerator({
     namespaceCase: 'kebab',
     pathCase: 'camel',
     clearOnDefaultNamespace: true,
-    ignoreDirectories: ['core', 'utils', 'helpers']
+    ignoreDirectories: ['core', 'utils', 'helpers'],
+    // Advanced: Use pathRules for hierarchical transformations with ignore and rename
+    // pathRules: {
+    //     app: {
+    //         dashboard: {
+    //             _: false,          // ignore "dashboard" but continue with nested rules
+    //             modules: false     // also ignore "modules"
+    //         },
+    //         admin: {
+    //             '>': 'management', // rename "admin" to "management"
+    //             users: false       // ignore "users"
+    //         }
+    //     }
+    // }
 });
 const keeper = configKeeper();
 

package/index.js

@@ -464,7 +464,8 @@ async function checkAndRegenerateFileLangTags(config, logger, file, path2) {
   if (replacements.length) {
     const newContent = processor.replaceTags(fileContent, replacements);
     await writeFile(file, newContent, "utf-8");
-    logger.info('Lang tag configurations written for file "{path}" (file://{file}:{line})', { path: path2, file, line: lastUpdatedLine });
+    const encodedFile = encodeURI(file);
+    logger.info('Lang tag configurations written for file "{path}" (file://{file}:{line})', { path: path2, file: encodedFile, line: lastUpdatedLine });
     return true;
   }
   return false;
@@ -884,7 +885,8 @@ async function logTagConflictInfo(tagInfo, prefix, conflictPath, translationArgP
         console.error("Failed to colorize config:", error);
       }
     }
-    console.log(`${ANSI.gray}${prefix}${ANSI.reset} ${ANSI.cyan}file://${filePath}${ANSI.reset}${ANSI.gray}:${lineNum}${ANSI.reset}`);
+    const encodedPath = encodeURI(filePath);
+    console.log(`${ANSI.gray}${prefix}${ANSI.reset} ${ANSI.cyan}file://${encodedPath}${ANSI.reset}${ANSI.gray}:${lineNum}${ANSI.reset}`);
     printLines(colorizedWhole.split("\n"), startLine, errorLines, condense);
   } catch (error) {
     console.error("Error displaying conflict:", error);
@@ -1432,7 +1434,20 @@ const generationAlgorithm = pathBasedConfigGenerator({
     namespaceCase: 'kebab',
     pathCase: 'camel',
     clearOnDefaultNamespace: true,
-    ignoreDirectories: ['core', 'utils', 'helpers']
+    ignoreDirectories: ['core', 'utils', 'helpers'],
+    // Advanced: Use pathRules for hierarchical transformations with ignore and rename
+    // pathRules: {
+    //     app: {
+    //         dashboard: {
+    //             _: false,          // ignore "dashboard" but continue with nested rules
+    //             modules: false     // also ignore "modules"
+    //         },
+    //         admin: {
+    //             '>': 'management', // rename "admin" to "management"
+    //             users: false       // ignore "users"
+    //         }
+    //     }
+    // }
 });
 const keeper = configKeeper();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lang-tag/cli",
-  "version": "0.12.3",
+  "version": "0.13.0",
   "type": "module",
   "publishConfig": {
     "access": "public"