Download the PHP package kfriars/laravel-translations-manager without Composer
On this page you can find all versions of the php package kfriars/laravel-translations-manager. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kfriars/laravel-translations-manager
More information about kfriars/laravel-translations-manager
Files in kfriars/laravel-translations-manager
Package laravel-translations-manager
Short Description A tool to manage translations in Laravel
License MIT
Homepage https://github.com/kfriars/laravel-translations-manager
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-translations-manager
Laravel Translations Manager
Why use this Package?
Have you ever worked on a project with multiple locales to be supported, created a new branch, worked for a few days, then wondered exactly what translations you have added or changed? If so, you know it is time intensive and error prone for developers to be managing what translations need to be added or updated.
This package's intended purpose is to make this entire process a breeze. Want to know what has been updated, deleted and added? Simple. Want to export everything needing to be translated to a file that can be sent to a translator? No problem. Want to automatically update all of the files that were translated so there are no more errors? Done.
Contents
- Laravel Translations Manager
- Why use this Package?
- Contents
- Installation
- Reference Locale
- Workflow
- 1) Check for errors
- 2) Clean Up Dead Translations
- 3) Ignoring Errors
- 4) Fix-File Generation
- 5) Fixing Files
- 6) Validating Translations
- 7) Locking Translations
- 8) Create PR and Merge
- Commands
- Validate
- Errors
- Clean
- Ignore
- Unignore
- Generate Fixes
- Fix
- Status
- Testing
- Changelog
- Contributing
- Security
- Credits
- License
Installation
You can install the package via composer:
This package should work out of the box without any changes to configuration. However, you can publish the config file using:
This is the contents of the published config file:
Reference Locale
The reference locale is the language your development team uses for development. This package is built around the idea that the current reference locale's translations are the correct version of the translations for the project.
For example:
You are working on a project for a French company but the project also supports English, German and Spanish. The mock-ups are given in French, so you make French the default app locale, and create translations files in French first. Then everything is translated to English, German and Spanish after the fact. French would be the reference locale.
Workflow
Assume standard git-flow is used, where the branch gets deployed to production and the branch should be kept in a deployable state.
This package is intended to be used as part of a project's workflow. For a branch to be in a deploayble state there should be no translation errors.
When a branch is completed, and ready to make a pull request to , the following steps should be taken to ensure there are no translation errors.
1) Check for errors
This command will list all translation errors in your project.
Example output:
Error Types:
| Error | Description |
|---|---|
| translation_missing | This error is when a translation is present in the reference locale, but not present in one of the supported locales. |
| file_not_translated | This error is when an entire translations file from the reference locale is not present in one of the supported locales. |
| reference_translation_updated | This error occurs when a locked translation of the reference locale does not match the current translation in the reference locale. This error helps you know what you have changed in your current branch, so it can be updated in the supported locales. |
| no_reference_translation | This error occurs when a supported locale has a translation that cannot be found in the reference locale. This error is for eliminating dead translations. |
| incorrect_translation_type | This error occurs when translation keys match in the reference and supported locales, but their types are different |
2) Clean Up Dead Translations
The errors likely indicate dead translations from removing keys in the reference locale, and forgetting to remove them in the supported locales. After you have inspected all of these errors and ensured they are in fact dead translations, you can run the clean command to remove all of these keys from your the supported locales.
3) Ignoring Errors
If there are any translations that do not need to be maintained in the supported locales, then those errors can be ignored. In the example output from , it is likely the admin interface's translations do need to be translated.
As such, they can be ignored using:
4) Fix-File Generation
Now that all remaining errors require some action, fix-files can be generated containing all translations required to fix the errors in each locale. This file is intended to be sent to a translator, and returned in its current format. The files are in JSON since it is human readable, and reliably parseable.
By default, the files are generated with the naming pattern . These files are saved in the configured . The default is .
The following fix files would be generated using French as the reference locale.
5) Fixing Files
When the fix files have been completed and returned by the translator, you can place them in the configured . The default is . Once the files have been placed in the directory you can run the following command.
It is important to note, that this command will remove all translations with errors from the supported locales.
Also, any translations that have and were included in the fix file, will have their lockfile updated with the current reference locale translation.
6) Validating Translations
Now you can test whether there are any translation errors by running the following command:
If the output is , then you can move on to the next step. I strongly recommend you add this command and ensure it passes in your ci/cd flow for deployments to production.
7) Locking Translations
If validation has failed due to errors, but you are satisfied with the state of the supported locales translations, you can lock the current state of the reference locale's translations by running the following command:
This will eliminate all errors.
8) Create PR and Merge
Once translations validation passes, you are ready to merge your code!
Commands
Validate
Signature:
Determine if there are any errors present in the specified locales. If no locales are provided all supported locales will be validated.
| Argument | Required | Description | Example Values |
|---|---|---|---|
| locales | ✗ | The locales you want to ensure are valid. | de, en, es, fr |
| Options | Description | Example Values |
|---|---|---|
| no-ignore | Do not filter ignored errors from the results. | --no-ignore |
Errors
Signature:
List any errors present in the specified locales.
| Argument | Required | Description | Example Values |
|---|---|---|---|
| locales | ✗ | The locales you want to ensure are valid. | de, en, es, fr |
| Options | Description | Example Values |
|---|---|---|
| no-ignore | Do not filter ignored errors from the results. | --no-ignore |
Clean
Signature:
Clean the dead translations -- errors with the message 'no_reference_translation' -- from the specified locales.
| Argument | Required | Description | Example Values |
|---|---|---|---|
| locales | ✗ | The locales of the translations to be cleaned. | de, en, es, fr |
Ignore
Signature:
Ignore a translations error. Omitting the key argument from the command will ignore all errors from the file. Ignoring an error allows the Validate command to pass if there are errors you do not wish to address.
| Argument | Required | Description | Example Values | |
|---|---|---|---|---|
| locale | ✓ | The locale of the translations to be ignored. | de, en, es, fr | |
| file | ✓ | The file of the translation to be ignored. This should be specified as the path from the base of the locale's lang folder. | path/to/file | |
| key | ✗ | The key to be ignored in dot notation. | keys.to.translation |
Unignore
Signature:
Unignore a translations error. Omitting the key argument from the command will unignore all errors from the file.
| Argument | Required | Description | Example Values | |
|---|---|---|---|---|
| locale | ✓ | The locale of the translations to be unignored. | de, en, es, fr | |
| file | ✓ | The file of the translation to be unignored. This should be specified as the path from the base of the locale's lang folder. | path/to/file | |
| key | ✗ | The key to be unignored in dot notation. | keys.to.translation |
Generate Fixes
Signature:
Generate fix files for the locales specified. If no locales are provided, all supported locales will have fix files generated. Fix files are generated to the configured .
| Argument | Required | Description | Example Values |
|---|---|---|---|
| locales | ✗ | The locales you want to generate fix files for. | de, en, es, fr |
Fix
Signature:
Fix the specified locales using the fix files. If no locales are provided, all supported locales will be fixed. The comand looks for the fix files in the the configured .
| Argument | Required | Description | Example Values |
|---|---|---|---|
| locales | ✗ | The locales you want to be fix using the fix files. | de, en, es, fr |
Status
Signature:
Get a complete listing of the status of the translations manager. The status shows the state of every translation file's error and ignore information for every local specified. If no locales are provided, all supported locales will have their status listed.
| Argument | Required | Description | Example Values |
|---|---|---|---|
| locales | ✗ | The locales you want included in the status. | de, en, es, fr |
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Kurt Friars
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-translations-manager with dependencies
illuminate/contracts Version ^6|^7|^8
illuminate/filesystem Version ^6|^7|^8
illuminate/support Version ^6|^7|^8
illuminate/translation Version ^6|^7|^8
kfriars/php-array-to-file Version ^1.1.2
league/flysystem Version ^1.0.34
php Version ^7.2