@gjsify/vite-plugin-gettext 0.4.0 → 0.4.3

package/src/po2json.ts

@@ -1,281 +0,0 @@
-import { type Plugin } from "vite";
-import path from "node:path";
-import fs from "node:fs/promises";
-import * as gettextParser from "gettext-parser";
-import type { GettextPo2JsonPluginOptions } from "./types.js";
-import {
-  checkDependencies,
-  findAvailableLanguages,
-  ensureDirectory,
-} from "./utils.js";
-
-/**
- * Simplifies the gettext-parser output to a clean key-value object
- * where the key is the original text and the value is the translation
- * @param translations The parsed PO file from gettext-parser
- * @returns A simplified object with just the translations
- */
-function simplifyTranslations(translations: any): Record<string, string> {
-  const result: Record<string, string> = {};
-
-  // Go through all translation contexts
-  Object.keys(translations.translations).forEach((context) => {
-    const contextTranslations = translations.translations[context];
-
-    // Skip the header (empty msgid)
-    Object.keys(contextTranslations).forEach((key) => {
-      if (key === "") return;
-
-      const translation = contextTranslations[key];
-      // Get the original text (msgid)
-      const original = translation.msgid;
-      // Get the translated text (first item in msgstr array)
-      const translated = translation.msgstr[0];
-
-      // Only add the translation if it exists and is not empty
-      if (translated && translated.trim() !== "") {
-        result[original] = translated;
-      }
-    });
-  });
-
-  return result;
-}
-
-/**
- * Creates a dictionary of all original strings from all translations
- * For the default language, we need to gather all possible keys
- * @param jsonDirectory Directory with JSON files
- * @param allTranslations Collection of all translations
- * @param defaultLanguage The default language code
- * @param verbose Whether to log verbose messages
- * @param pluginName The name of the plugin
- * @param additionalTranslations Additional translations to include
- * @returns Object with original strings as both keys and values
- */
-async function createDefaultLanguageJson(
-  jsonDirectory: string,
-  allTranslations: Record<string, Record<string, string>>,
-  defaultLanguage: string,
-  verbose: boolean,
-  pluginName: string,
-  additionalTranslations: Record<string, string> = {}
-): Promise<void> {
-  // Create a set of all original strings from all translations
-  const allOriginalStrings = new Set<string>();
-
-  // Collect all original strings from all translations
-  Object.values(allTranslations).forEach((translations) => {
-    Object.keys(translations).forEach((key) => {
-      allOriginalStrings.add(key);
-    });
-  });
-
-  // Create the default language JSON with keys matching values
-  const defaultLanguageJson: Record<string, string> = {};
-  allOriginalStrings.forEach((str) => {
-    defaultLanguageJson[str] = str;
-  });
-
-  // Process additional translations
-  const finalTranslations = { ...defaultLanguageJson };
-
-  // For each additional translation, try to find a translation or use the original
-  Object.entries(additionalTranslations).forEach(([key, originalText]) => {
-    // If there's a translation for the original text, use it
-    if (defaultLanguageJson[originalText]) {
-      finalTranslations[key] = defaultLanguageJson[originalText];
-    } else {
-      // Otherwise use the original text
-      finalTranslations[key] = originalText;
-    }
-  });
-
-  // Write the default language file with .default.json extension
-  const defaultLangDefaultFile = path.join(
-    jsonDirectory,
-    `${defaultLanguage}.default.json`
-  );
-
-  if (verbose) {
-    console.log(
-      `[${pluginName}] Creating default language file: ${defaultLangDefaultFile}`
-    );
-  }
-
-  await fs.writeFile(
-    defaultLangDefaultFile,
-    JSON.stringify(finalTranslations, null, 2)
-  );
-}
-
-/**
- * Creates a Vite plugin that converts PO translation files to JSON format
- * The JSON files are placed in the specified output directory
- * @param options Configuration options for the plugin
- * @returns A Vite plugin that handles PO to JSON conversion
- */
-export function po2jsonPlugin(options: GettextPo2JsonPluginOptions): Plugin {
-  const {
-    poDirectory,
-    jsonDirectory,
-    defaultLanguage = "en",
-    verbose = false,
-    additionalTranslations = {},
-  } = options;
-
-  const pluginName = "vite-plugin-gettext-po2json";
-
-  async function convertPoToJson() {
-    try {
-      // Check if PO directory exists
-      try {
-        await ensureDirectory(poDirectory);
-      } catch {
-        if (verbose) {
-          console.log(
-            `[${pluginName}] PO directory ${poDirectory} does not exist yet, skipping conversion`
-          );
-        }
-        return;
-      }
-
-      // Find available languages
-      const languages = await findAvailableLanguages(
-        poDirectory,
-        pluginName,
-        verbose
-      );
-
-      if (languages.length === 0) {
-        if (verbose) {
-          console.log(`[${pluginName}] No translation files found`);
-        }
-        return;
-      }
-
-      // Create JSON directory
-      await ensureDirectory(jsonDirectory);
-
-      // Collection of all translations to create the default language file
-      const allTranslations: Record<string, Record<string, string>> = {};
-
-      // Skip the default language if it exists in the list
-      const nonDefaultLanguages = languages.filter(
-        (lang) => lang !== defaultLanguage
-      );
-
-      // Handle default language if it exists in the list
-      if (languages.includes(defaultLanguage)) {
-        const poFile = path.join(poDirectory, `${defaultLanguage}.po`);
-        const jsonFile = path.join(jsonDirectory, `${defaultLanguage}.json`);
-
-        if (verbose) {
-          console.log(
-            `[${pluginName}] Converting default language ${poFile} to ${jsonFile}`
-          );
-        }
-
-        // Read and parse PO file
-        const poContent = await fs.readFile(poFile);
-        const translations = gettextParser.po.parse(poContent);
-
-        // Convert the translations to a simple JSON object
-        const simplifiedTranslations = simplifyTranslations(translations);
-
-        // Process additional translations for default language
-        const finalTranslations = { ...simplifiedTranslations };
-
-        // For each additional translation, add it to the default language file
-        Object.entries(additionalTranslations).forEach(
-          ([key, originalText]) => {
-            finalTranslations[key] = originalText;
-          }
-        );
-
-        // Write JSON file for default language
-        await fs.writeFile(
-          jsonFile,
-          JSON.stringify(finalTranslations, null, 2)
-        );
-      }
-
-      // Add additional translations for all languages
-      for (const lang of nonDefaultLanguages) {
-        const poFile = path.join(poDirectory, `${lang}.po`);
-        const jsonFile = path.join(jsonDirectory, `${lang}.json`);
-
-        if (verbose) {
-          console.log(`[${pluginName}] Converting ${poFile} to ${jsonFile}`);
-        }
-
-        // Read and parse PO file
-        const poContent = await fs.readFile(poFile);
-        const translations = gettextParser.po.parse(poContent);
-
-        // Convert the translations to a simple JSON object
-        const simplifiedTranslations = simplifyTranslations(translations);
-
-        // Store translations for creating the default language file
-        allTranslations[lang] = simplifiedTranslations;
-
-        // Process additional translations
-        const finalTranslations = { ...simplifiedTranslations };
-
-        // For each additional translation, try to find a translation or use the original
-        Object.entries(additionalTranslations).forEach(
-          ([key, originalText]) => {
-            // If there's a translation for the original text, use it
-            if (simplifiedTranslations[originalText]) {
-              finalTranslations[key] = simplifiedTranslations[originalText];
-            } else {
-              // Otherwise use the original text
-              finalTranslations[key] = originalText;
-            }
-          }
-        );
-
-        // Write JSON file
-        await fs.writeFile(
-          jsonFile,
-          JSON.stringify(finalTranslations, null, 2)
-        );
-      }
-
-      // Create the default language file (with all original strings as both keys and values)
-      await createDefaultLanguageJson(
-        jsonDirectory,
-        allTranslations,
-        defaultLanguage,
-        verbose,
-        pluginName,
-        additionalTranslations
-      );
-    } catch (error) {
-      throw new Error(`Failed to convert PO files to JSON: ${error}`);
-    }
-  }
-
-  return {
-    name: pluginName,
-
-    async buildStart() {
-      await convertPoToJson();
-    },
-
-    configureServer(server) {
-      server.watcher.add(poDirectory);
-
-      server.watcher.on("change", async (file) => {
-        if (file.endsWith(".po")) {
-          if (verbose) {
-            console.log(
-              `[${pluginName}] PO file changed: ${file}, reconverting`
-            );
-          }
-          await convertPoToJson();
-        }
-      });
-    },
-  };
-}

package/src/types.ts

@@ -1,138 +0,0 @@
-/**
- * Configuration options for the xgettext plugin
- * Used to extract translatable strings from source files
- */
-export interface XGettextPluginOptions {
-  /** Glob patterns for source files to extract strings from */
-  sources: string[];
-  /** Output path for the POT template file */
-  output: string;
-  /** The gettext domain name, defaults to 'messages' */
-  domain?: string;
-  /** Keywords to look for when extracting strings, defaults to ['_', 'gettext', 'ngettext'] */
-  keywords?: string[];
-  /** Additional options to pass to xgettext command */
-  xgettextOptions?: string[];
-  /** Additional options to pass to msgcat when combining POT files */
-  msgcatOptions?: string[];
-  /** Enable verbose logging */
-  verbose?: boolean;
-  /** Automatically update PO files after POT changes */
-  autoUpdatePo?: boolean;
-  /** Version of the POT file, defaults to '1.0' */
-  version?: string;
-  /** Preset to use for extracting strings, defaults to 'glib' */
-  preset?: "glib";
-  /** URL for reporting bugs in the POT file */
-  msgidBugsAddress?: string;
-  /** Copyright holder to set in the POT file */
-  copyrightHolder?: string;
-  /** If true, do not include source reference locations in POT/PO files */
-  noLocation?: boolean;
-  /** If true, attempt to make output reproducible (stable timestamps/order) */
-  deterministic?: boolean;
-  /** When deterministic is true, use this SOURCE_DATE_EPOCH (seconds since epoch). Defaults to 0. */
-  sourceDateEpoch?: number;
-  /** Optionally force a fixed POT-Creation-Date header value (e.g. '1970-01-01 00:00+0000') */
-  fixedCreationDate?: string;
-  /** If true, preserve the existing POT-Creation-Date from the current POT file if present */
-  preserveCreationDate?: boolean;
-  /** If true, sort the output messages for stable diffs (passed to msgcat) */
-  sortOutput?: boolean;
-  /** Whether to disable text wrapping in PO/POT files, defaults to false */
-  noWrap?: boolean;
-}
-
-/**
- * Configuration options for the gettext plugin
- * Used to compile PO files to binary MO format
- */
-export interface GettextPluginOptions {
-  /** Directory containing PO translation files */
-  poDirectory: string;
-  /** Output directory for compiled MO files */
-  moDirectory: string;
-  /** Filename of the MO file, defaults to 'messages.mo' */
-  filename?: string;
-  /** Enable verbose logging */
-  verbose?: boolean;
-}
-
-/**
- * Output format types for msgfmt
- */
-export type MsgfmtFormat =
-  | "mo"
-  | "java"
-  | "java2"
-  | "csharp"
-  | "csharp-resources"
-  | "tcl"
-  | "desktop"
-  | "xml"
-  | "json"
-  | "qt";
-
-/**
- * Configuration options for the msgfmt plugin
- * Used to compile PO files to various formats including binary MO
- */
-export interface MsgfmtPluginOptions {
-  /** Directory containing PO translation files */
-  poDirectory: string;
-  /** Output directory for compiled files */
-  outputDirectory: string;
-  /** The gettext domain name, defaults to 'messages' */
-  domain?: string;
-  /** Output filename, defaults to 'messages.mo' */
-  filename?: string;
-  /** Output format, defaults to 'mo' */
-  format?: MsgfmtFormat;
-  /** Path to template file, required for XML format */
-  templateFile?: string;
-  /** Enable verbose logging */
-  verbose?: boolean;
-  /** Additional options to pass to msgfmt command */
-  msgfmtOptions?: string[];
-  /** Whether to use the standard locale structure (locale/LANG/LC_MESSAGES/domain.mo) */
-  useLocaleStructure?: boolean;
-  /** Whether to remove XML comments from output files, defaults to true */
-  removeComments?: boolean;
-}
-
-export interface PluginOptions {
-  pluginName: string;
-  verbose?: boolean;
-}
-
-/**
- * Options for the PO to JSON conversion plugin
- */
-export interface GettextPo2JsonPluginOptions {
-  /**
-   * Directory containing PO files
-   */
-  poDirectory: string;
-
-  /**
-   * Directory where JSON files will be saved
-   */
-  jsonDirectory: string;
-
-  /**
-   * Default language code (default: 'en')
-   */
-  defaultLanguage?: string;
-
-  /**
-   * Enable verbose logging
-   */
-  verbose?: boolean;
-
-  /**
-   * Additional translations to include in all language files
-   * Keys are identifiers and values are the English text
-   * The English text will be translated for non-default languages if translations exist
-   */
-  additionalTranslations?: Record<string, string>;
-}

package/src/utils.ts

@@ -1,119 +0,0 @@
-import { execa } from "execa";
-import path from "node:path";
-import fs from "node:fs/promises";
-
-/**
- * Checks if a gettext utility is installed and available
- * @param command The command to check (msgfmt, xgettext, etc.)
- * @param pluginName Name of the plugin for logging
- * @param verbose Enable verbose logging
- * @throws Error if the command is not found
- */
-export async function checkDependencies(
-  command: string,
-  pluginName: string,
-  verbose: boolean
-) {
-  try {
-    await execa(command, ["--version"]);
-    if (verbose) {
-      console.log(`[${pluginName}] Found ${command}`);
-    }
-  } catch (error) {
-    throw new Error(
-      `${command} not found. Please install gettext:\n` +
-        "  Ubuntu/Debian: sudo apt-get install gettext\n" +
-        "  Fedora: sudo dnf install gettext\n" +
-        "  Arch: sudo pacman -S gettext\n" +
-        "  macOS: brew install gettext"
-    );
-  }
-}
-
-/**
- * Scans the PO directory to find available language translations
- * @param poDirectory Directory containing PO files
- * @param pluginName Name of the plugin for logging
- * @param verbose Enable verbose logging
- * @returns Array of language codes found (e.g. ['de', 'fr', 'es'])
- */
-export async function findAvailableLanguages(
-  poDirectory: string,
-  pluginName: string,
-  verbose: boolean
-): Promise<string[]> {
-  try {
-    const files = await fs.readdir(poDirectory);
-    const languages = files
-      .filter((file) => file.endsWith(".po"))
-      .map((file) => path.basename(file, ".po"));
-
-    if (verbose) {
-      console.log(`[${pluginName}] Found languages: ${languages.join(", ")}`);
-    }
-
-    return languages;
-  } catch (error) {
-    if (verbose) {
-      console.log(`[${pluginName}] No PO directory found at ${poDirectory}`);
-    }
-    return [];
-  }
-}
-
-/**
- * Generates a LINGUAS file containing the list of available languages
- * @param languages List of language codes
- * @param poDirectory Directory where the LINGUAS file should be created
- * @param verbose Enable verbose logging
- */
-export async function generateLinguasFile(
-  languages: string[],
-  poDirectory: string,
-  verbose = false
-) {
-  const linguasPath = path.join(poDirectory, "LINGUAS");
-  const content = languages.join("\n");
-
-  try {
-    await fs.writeFile(linguasPath, content);
-    if (verbose) {
-      console.log(
-        `Generated LINGUAS file with languages: ${languages.join(", ")}`
-      );
-    }
-  } catch (error) {
-    console.error("Error writing LINGUAS file:", error);
-  }
-}
-
-/**
- * Creates directory structure recursively
- * @param directory Directory path to create
- */
-export async function ensureDirectory(directory: string): Promise<void> {
-  await fs.mkdir(directory, { recursive: true });
-}
-
-/**
- * Processes a filename with potential .in suffix
- * @param filePath Original file path or filename
- * @returns Object with processed filename and extension
- */
-export function processFilename(filePath: string): {
-  filename: string;
-  extension: string;
-} {
-  // Extract just the filename if a path is provided
-  const filename = path.basename(filePath);
-  let extension = path.extname(filename).toLowerCase();
-  let processedFilename = filename;
-
-  // Handle .in extension
-  if (filename.endsWith(".in")) {
-    processedFilename = filename.substring(0, filename.length - 3);
-    extension = path.extname(processedFilename).toLowerCase();
-  }
-
-  return { filename: processedFilename, extension };
-}