.phrase.yml

Phrase configuration file

Type object
File match .phrase.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/phrase-yml/latest.json
Source https://www.schemastore.org/phrase.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

phrase object

Root element of the Phrase config

7 nested properties
host string

API URL. Set to https://api.us.app.phrase.com/v2 when using the US datacenter

access_token string

Access Token for authorization. Can be created in the user profile

file_format string

File format name. See the format guide in the documentation for all supported file formats

Default: "yml"
project_id string

ID of the project

locale_mapping Record<string, string>

Optional mapping between locale names in Phrase and locale names in the local files. This works in conjunction with <locale_name> placeholder in the file patterns. If a mapping is provided, the placeholders will be replaced with the corresponding values in the mapping. If a locale name is not included in the mapping, the locale name in Phrase will be used as a fallback.

push object
1 nested properties
sources object[]

Source files that will be uploaded on push

minItems=1
pull object
1 nested properties
targets object[]

List of files that will be downloaded on pull

minItems=1

Definitions

project_id string

ID of the project

file_format string

File format name. See the format guide in the documentation for all supported file formats

locale_id string

Locale that should be downloaded. Locale ID or locale name are valid options

encoding string

Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1"

format_options object

Additional options available for specific formats. See our format guide for complete list.

column_separator string

Column separator character

Default: ";"
locale_mapping Record<string, string>

Optional mapping between locale names in Phrase and locale names in the local files. This works in conjunction with <locale_name> placeholder in the file patterns. If a mapping is provided, the placeholders will be replaced with the corresponding values in the mapping. If a locale name is not included in the mapping, the locale name in Phrase will be used as a fallback.