tarektaher/artisan-language

add artisan commands for language

0.1.1 2024-11-28 12:56 UTC

Requires

• php: 8.*
• laravel/framework: 11.*

MIT

• tarektaher

README

Artisan Language is a Laravel package designed to streamline the management of translation keys in your application. It provides powerful Artisan commands to synchronize, scan, and manage translation keys for Blade templates, PHP files, and JavaScript files.

Features

• Synchronize translation keys across multiple locales.
• Automatically update JSON language files with missing keys.
• Remove unused keys from JSON language files.
• Scan Blade, PHP, and JavaScript files for translation keys.
• Fully customizable through the configuration file.

Installation

Install the package via Composer:

composer require tarektaher/artisan-language

Publish the configuration file:

php artisan vendor:publish --tag=artisan-language-config

This will create the configuration file at config/artisan-language.php.

Configuration

The configuration file allows you to define paths, patterns, and settings for the package.

Default Configuration:

return [
    'default_language' => 'en', // Default language for synchronization
    'languages' => [ // Supported languages
        'en' => 'English',
        'fr' => 'French',
    ],
    'scan_paths' => [ // Paths to scan for translation keys
        app_path(),
        resource_path('views'),
        resource_path('assets/js'),
    ],
    'scan_pattern' => '/(@lang|__|\$t|\$tc)\s*(\(\s*[\'"])([^$]*)([\'"]+\s*(,[^\)]*)*\))/U', // Regex pattern to detect keys
    'lang_path' => base_path('lang'), // Path to JSON language files
];

Commands

1. Scan for Missing Keys

Scan configured paths (Blade templates, PHP files, JavaScript files) for missing translation keys and update the JSON language files.

php artisan lg:scan

Options:

• --lang: Specify the target language (default: configured default language).

Example:

php artisan lg:scan --lang=fr

2. Synchronize Translation Keys

Synchronize translation keys between the base language and a target locale.

php artisan lg:sync {locale}

Arguments:

• locale: The locale to synchronize.

Options:

• --nomissing: Skip adding missing keys from the base language file.
• --nofurther: Skip removing extra keys from the target language file.

Example:

php artisan lg:sync fr --nomissing

3. Add Translation Keys

Add a new translation key to the specified language file.

php artisan lg:add {key} {value} {--lang=en}

Arguments:

• key: The translation key to add.
• value: The value for the key.

Options:

• --lang: Specify the target language (default: en).

Example:

php artisan lg:add welcome "Welcome to our app" --lang=fr

4. Remove Translation Keys

Remove a translation key from the specified language file.

php artisan lg:remove {key} {--lang=}

Arguments:

• key: The translation key to remove.

Options:

• --lang: Specify the target language.

Example:

php artisan lg:remove "Your email is invalid" --lang=fr

Customization

You can customize paths, regex patterns, and language file locations in the configuration file (config/artisan-language.php).

Download

You can download the latest release of Artisan Language here:

Contributing

Contributions are welcome! Feel free to fork this repository, submit a pull request, or open an issue on GitHub.

License

This package is open-sourced software licensed under the MIT License. See the LICENSE file for details.

Support

For issues or questions, please contact Tarek Taher or open a GitHub issue.

With Artisan Language, managing translations has never been easier. Start synchronizing and scanning your keys today! 🎉