https://github.com/bottelet/translation-checker
find translations you forgot to add to your language files, check, and maintain translations in yor Laravel application
https://github.com/bottelet/translation-checker
Last synced: 5 months ago
JSON representation
find translations you forgot to add to your language files, check, and maintain translations in yor Laravel application
- Host: GitHub
- URL: https://github.com/bottelet/translation-checker
- Owner: Bottelet
- License: mit
- Created: 2024-09-14T20:55:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-17T23:16:49.000Z (9 months ago)
- Last Synced: 2025-04-05T21:00:06.641Z (6 months ago)
- Language: PHP
- Size: 348 KB
- Stars: 112
- Watchers: 3
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Translation Checker
Translation Checker is tool designed to help you find translations you forgot to add to your language files, check, and maintain translations in your project. It provides a set of commands to help with language files, ensuring consistency and completeness across your translations.
It works with Laravel and supports various frontend frameworks like Vue.js, React, and Svelte.
## How it works
1. Scan Source Files: The system looks through your code for strings that need translation.
2. Check Language Files: It then checks if these strings exist in your language files.
3. Add missing translation keys: It adds the missing key with empty values if there is no translation service used.
### Example:
`lang.json`
```json
{
"test.value": "Value"
}
```
`lang.php`
```php
return [
'test.value' => 'Value',
];
```
TestClass.php
```php
class TestClass
{
public function getValue()
{
return __('translate this string');
}
}
```
```bash
php artisan translations:check en
```
`lang.json`
```json
{
"test.value": "Value",
"translate this string": null
}
```
`lang.php`
```php
return [
'test.value' => 'Value',
'translate this string' => null,
];
```
The reason we default to null when no translation service are used is because it defaults to the key used in the function call.
## Quick Start
Install the package via composer:
```bash
composer require bottelet/translation-checker --dev
```
## Usage
Translation Checker provides several commands to manage your translations. The most versatile is the `check` command:
```bash
php artisan translations:check en
```
For detailed information on all available commands and their usage, refer to the [documentation](https://bottelet.github.io/translation-checker/).
## Testing
Run the tests with:
```bash
./vendor/bin/phpunit
```
## Documentation
For full documentation, visit our [GitHub documentation page](https://bottelet.github.io/translation-checker/).
If you encounter any issues or have suggestions, please create an issue on GitHub.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.