gtx-cli 2.6.10 → 2.6.11

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.6.11
+
+### Patch Changes
+
+- [#988](https://github.com/generaltranslation/gt/pull/988) [`efdf632`](https://github.com/generaltranslation/gt/commit/efdf632acab7cdd4d1819408d808bd4ac05bc7c8) Thanks [@pie575](https://github.com/pie575)! - Added function to export errors as json from running validate
+
 ## 2.6.10
 
 ### Patch Changes

package/dist/console/logging.d.ts

@@ -1,4 +1,8 @@
 import { FileToUpload } from 'generaltranslation/types';
+/**
+ * Strip ANSI escape codes from a string (e.g., chalk color codes)
+ */
+export declare function stripAnsi(str: string): string;
 export declare function logErrorAndExit(message: string): never;
 export declare function exitSync(code: number): never;
 export declare function displayHeader(introString?: string): void;

package/dist/console/logging.js

@@ -3,6 +3,12 @@ import chalk from 'chalk';
 import { getCLIVersion } from '../utils/packageJson.js';
 import { logger } from './logger.js';
 import { TEMPLATE_FILE_NAME } from '../utils/constants.js';
+/**
+ * Strip ANSI escape codes from a string (e.g., chalk color codes)
+ */
+export function stripAnsi(str) {
+    return str.replace(/\x1B\[[0-9;]*m/g, '');
+}
 export function logErrorAndExit(message) {
     logger.error(message);
     return exitSync(1);

package/dist/functions.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file serves as an entrypoint for programmatically invoking CLI commands.
+ * Import from 'gtx-cli/functions' to access these APIs.
+ */
+export { getValidateJson } from './translation/validate.js';
+export type { ValidationResult, ValidationMessage, ValidationLevel, } from './translation/validate.js';

package/dist/functions.js

@@ -0,0 +1,5 @@
+/**
+ * This file serves as an entrypoint for programmatically invoking CLI commands.
+ * Import from 'gtx-cli/functions' to access these APIs.
+ */
+export { getValidateJson } from './translation/validate.js';

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "2.6.10";
+export declare const PACKAGE_VERSION = "2.6.11";

package/dist/generated/version.js

@@ -1,2 +1,2 @@
 // This file is auto-generated. Do not edit manually.
-export const PACKAGE_VERSION = '2.6.10';
+export const PACKAGE_VERSION = '2.6.11';

package/dist/translation/validate.d.ts

@@ -1,2 +1,13 @@
 import { Options, Settings } from '../types/index.js';
+export type ValidationLevel = 'error' | 'warning';
+export type ValidationMessage = {
+    level: ValidationLevel;
+    message: string;
+};
+export type ValidationResult = Record<string, ValidationMessage[]>;
+/**
+ * Programmatic API for validation - returns structured results instead of logging/exiting.
+ * Equivalent to running `gtx-cli validate` but returns data.
+ */
+export declare function getValidateJson(settings: Options & Settings, pkg: 'gt-react' | 'gt-next', files?: string[]): Promise<ValidationResult>;
 export declare function validateProject(settings: Options & Settings, pkg: 'gt-react' | 'gt-next', files?: string[]): Promise<void>;

package/dist/translation/validate.js

@@ -1,24 +1,20 @@
-import { logErrorAndExit } from '../console/logging.js';
+import { logErrorAndExit, stripAnsi } from '../console/logging.js';
 import chalk from 'chalk';
 import findFilepath from '../fs/findFilepath.js';
 import { logger } from '../console/logger.js';
 import { createUpdates } from './parse.js';
 import { createInlineUpdates } from '../react/parse/createInlineUpdates.js';
-export async function validateProject(settings, pkg, files) {
+/**
+ * Shared validation logic - returns raw results from createUpdates/createInlineUpdates
+ */
+async function runValidation(settings, pkg, files) {
     if (files && files.length > 0) {
-        // Validate specific files using createInlineUpdates
-        const { errors, updates } = await createInlineUpdates(pkg, true, files, settings.parsingOptions);
-        if (errors.length > 0) {
-            logErrorAndExit(chalk.red(`Error: CLI tool encountered ${errors.length} syntax errors:\n` +
-                errors
-                    .map((error) => chalk.red('• ') + chalk.white(error) + '\n')
-                    .join('')));
-        }
-        logger.success(chalk.green(`Success! Found ${updates.length} translatable entries.`));
-        return;
+        return createInlineUpdates(pkg, true, files, settings.parsingOptions);
     }
-    if (!settings.dictionary) {
-        settings.dictionary = findFilepath([
+    // Full project validation
+    // Use local variable to avoid mutating caller's settings object
+    const dictionary = settings.dictionary ||
+        findFilepath([
             './dictionary.js',
             './src/dictionary.js',
             './dictionary.json',
@@ -26,8 +22,54 @@ export async function validateProject(settings, pkg, files) {
             './dictionary.ts',
             './src/dictionary.ts',
         ]);
+    return createUpdates(settings, settings.src, dictionary, pkg, true, settings.parsingOptions);
+}
+/**
+ * Parse file path from error/warning string in withLocation format: "filepath (line:col): message"
+ */
+function parseFileFromMessage(msg) {
+    // First try to match with location format: "filepath (line:col): message"
+    // Using [\s\S] instead of . with /s flag for ES5 compatibility
+    const withLocation = msg.match(/^(.+)\s+\(\d+:\d+\)\s*:\s*([\s\S]+)$/);
+    if (withLocation) {
+        return { file: withLocation[1].trim(), message: withLocation[2].trim() };
+    }
+    // Fallback: find the last ": " pattern (handles Windows paths like C:\...)
+    const lastColonSpace = msg.lastIndexOf(': ');
+    if (lastColonSpace > 0) {
+        return {
+            file: msg.substring(0, lastColonSpace).trim(),
+            message: msg.substring(lastColonSpace + 2).trim(),
+        };
+    }
+    // No file found - use empty string as key for "global" messages
+    return { file: '', message: msg };
+}
+/**
+ * Programmatic API for validation - returns structured results instead of logging/exiting.
+ * Equivalent to running `gtx-cli validate` but returns data.
+ */
+export async function getValidateJson(settings, pkg, files) {
+    const { errors, warnings } = await runValidation(settings, pkg, files);
+    const result = {};
+    const addMessage = (file, level, message) => {
+        if (!result[file]) {
+            result[file] = [];
+        }
+        result[file].push({ level, message });
+    };
+    for (const error of errors) {
+        const { file, message } = parseFileFromMessage(stripAnsi(error));
+        addMessage(file, 'error', message);
+    }
+    for (const warning of warnings) {
+        const { file, message } = parseFileFromMessage(stripAnsi(warning));
+        addMessage(file, 'warning', message);
     }
-    const { updates, errors, warnings } = await createUpdates(settings, settings.src, settings.dictionary, pkg, true, settings.parsingOptions);
+    return result;
+}
+export async function validateProject(settings, pkg, files) {
+    const { updates, errors, warnings } = await runValidation(settings, pkg, files);
     if (warnings.length > 0) {
         logger.warn(chalk.yellow(`CLI tool encountered ${warnings.length} warnings while scanning for translatable content.`) +
             '\n' +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.6.10",
+  "version": "2.6.11",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [
@@ -18,6 +18,10 @@
       "import": "./dist/types.js",
       "types": "./dist/types.d.ts"
     },
+    "./functions": {
+      "import": "./dist/functions.js",
+      "types": "./dist/functions.d.ts"
+    },
     "./updates/*": {
       "import": "./dist/updates/*.js",
       "types": "./dist/updates/*.d.ts"