How to Find Errors in Translation Files

Symfony processes all the application translation files as part of the process that compiles the application code before executing it. If there's an error in any translation file, you'll see an error message explaining the problem.

If you prefer, you can also validate the contents of any YAML and XLIFF translation file using the lint:yaml and lint:xliff commands:

1
2
3
4
5
6
7
8
9
10
11

# lint a single file
$ php bin/console lint:yaml translations/messages.en.yaml
$ php bin/console lint:xliff translations/messages.en.xlf

# lint a whole directory
$ php bin/console lint:yaml translations
$ php bin/console lint:xliff translations

# lint multiple files or directories
$ php bin/console lint:yaml translations path/to/trans
$ php bin/console lint:xliff translations/messages.en.xlf translations/messages.es.xlf

The linter results can be exported to JSON using the --format option:

1
2

$ php bin/console lint:yaml translations/ --format=json
$ php bin/console lint:xliff translations/ --format=json

When running these linters inside GitHub Actions, the output is automatically adapted to the format required by GitHub, but you can force that format too:

1
2

$ php bin/console lint:yaml translations/ --format=github
$ php bin/console lint:xliff translations/ --format=github

1

$ php vendor/bin/yaml-lint translations/