README

A PHP package for ensuring proper French typography and consistent terminology in PO translation files. Checks are split into errors (must fix) and warnings (suggestions).

The main idea is to help developers and translators maintain high-quality French translations by enforcing typographic rules and checking for consistency in terminology. The rules of typography are based on the Les règles typographiques utilisées pour la traduction de WordPress.

This package will also allow to translate missing translations using any AI provider compatibile with the OpenAI API (OpenAI, OpenRouter, Ollama, Deepseek, etc.). The transalation can be either fully automated or interactive, allowing you to finetune the suggestions, or add them as fuzzy so you can update them in your favorite PO editor. This feature is still in development and needs your feedback.

Features

Typography Rules

Non-breaking spaces before double punctuation (!, ?, :, ;, »)
French quotation marks (« ») with proper spacing
Typographic apostrophes (')
Proper ellipsis character (…)

Translation Features

PO file parsing and generation
Translation consistency checking via glossary
Interactive (or not) translation mode with OpenAI API integration (compatible with OpenAI, OpenRouter, Ollama, Deepseek, etc.)

French Typography Reference

The implemented rules and upcoming are listed in docs/french-rules.md

Installation

composer require youniwemi/translation-checker

Usage

Command Line

Check a file:

vendor/bin/check-french fr.po

Check and fix issues:

vendor/bin/check-french --fix fr.po

Process multiple files:

vendor/bin/check-french --fix *.po

Translate missing translations:

vendor/bin/check-french --fix --translate fr.po

Translate missing translations in interactive mode:

vendor/bin/check-french --fix --translate --interactive fr.po

Options:

--fix Fix issues and save changes
--quiet Only show errors and warnings (no progress info)
--no-warnings Only show errors (ignore warnings)
--translate Translate the missing translations
--interactive Use interactive mode for translation
--glossary Path to the glossary file (defaults to 'glossary.json')
--help Show help message

Messages

Errors (Must Fix)

"Espace insécable manquant avant les '!'"
"Utiliser les guillemets français « » au lieu des guillemets droits"
"Utiliser l'apostrophe typographique (') au lieu de l'apostrophe droite (')"
"Accent manquant sur la majuscule"
"Utiliser le caractère unique pour les points de suspension (…)"

Warnings (Suggestions)

"Le terme 'x' devrait être traduit par 'y'" - Suggests using consistent terminology from glossary

Development

# Install dependencies
composer install

# Run tests
composer test

# Run code style fixer
composer cs

# Run static analysis
composer stan

# Run all quality checks
composer qa

License

MIT License. See LICENSE for more information.

Contributing

Fork the repository
Create your feature branch
Write tests for your changes
Ensure tests pass
Submit a pull request

All tests must pass and code must follow PSR-12 standards.

Credits and Acknowledgements

This package uses gettext/gettext for PO/MO file parsing and generation.

Environment Variables for Translation

When using the --translate option, the following environment variables are required:

OPENAI_API_KEY: Your OpenAI API key
OPENAI_API_URL: OpenAI API URL (optional, for custom endpoints, OpenRouter, Ollama, Deepseek, etc.)
OPENAI_MODEL: Model to use (defaults to 'gpt-3.5-turbo')

youniwemi / translation-checker

Maintainers

Details