Criar um arquivo de configuração de CLI (Strings)

O conteúdo de toda a Central de Ajuda é traduzido automaticamente de inglês pelo Phrase Language AI.

Pré-requisitos

Token de acesso<1> API com escopo read write
ID do projeto Strings mostrado na aba API das configurações do projeto
Conhecimento básico de YAML, incluindo indentação
Permissões de leitura e gravação do Git se o repositório for executar phrase push ou phrase pull no CI

Dica

Para obter informações mais detalhadas, consulte o Developer Hub.

Para criar automaticamente um arquivo de configuração, siga estes passos:

Na linha de comando, digite phrase init para criar um arquivo .phrase.yml.

O assistente de configuração começa no CLI.
Forneça:
- Token de acesso
  
  Cole ou pressione Enter para permitir que $PHRASE_ACCESS_TOKEN seja usado
- ID do projeto Strings (por exemplo, abcdef1234567890abcdef1234567890)
- Formato de arquivo de local (por exemplo, json, rails_yaml, ios_strings)
- Caminho local
  
  Glob ou caminho exato para arquivos de local na base de código do projeto (por exemplo, config/locales/*.json)

Um arquivo .phrase.yml básico é criado no diretório atual.

Dica

Forneça sinalizadores para ignorar o assistente completamente, por exemplo phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

Se estiver usando um arquivo de configuração criado ou copiado manualmente, coloque-o em uma dessas localizações:

O diretório de trabalho atual (pwd) no qual o cliente CLI é chamado.
O diretório principal do usuário atual ($HOME no Unix, $HomePath no Windows).
O caminho especificado na variável do ambiente PHRASEAPP_CONFIG.
O caminho para o arquivo de configuração por meio da marca --config (por exemplo: /some/path/to/phrase.yml).

Visão geral das opções da CLI

Amostra de arquivo de configuração.

Configurações globais

Chave	Tipo	Obrigatório	Descrição
`phrase.access_token`	string	Sim	Token de acesso pessoal.
`phrase.project_id`	string	Sim	ID do projeto público mostrado nas configurações do projeto Strings.
`phrase.file_format`	string	Sim	local padrão formato de arquivo (extensão da API).
`phrase.locale_mapping`	object	Não	Mapeia IDs de local do Phrase para nomes Personalizado para usar em caminhos de arquivo com o marcador de posição `<locale_name>`. Isso é útil para plataformas com convenções de nomenclatura não padrão, como Android. Se um local não for especificado no mapeamento, seu nome de local Phrase padrão será usado por padrão.

Push: Textos originais

Chave	Tipo	Obrigatório	Descrição
`push.sources[].file`	caminho	Sim	Caminho relativo para o(s) arquivo(s) para fazer push, por exemplo, `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	string		Substituir o `ID do projeto` global para este texto original de arquivo específico. Útil ao fazer upload de arquivos para múltiplos projetos Phrase a partir do mesmo arquivo de configuração.

Push: Parâmetros

Parâmetro	Tipo	Padrão	Descrição
`file_format`	string	cabeçalho	Substituir formato de arquivo para este texto original.
`locale_id`	string	—	Nome do local (por exemplo, `en-US`) ou ID de local público.
`tags`	string	—	Tags separadas por vírgula para novas chaves.
`update_translations`	Booleano	`false`	Atualizar traduções existentes com conteúdo de arquivo.
`update_translation_keys`	Booleano	`true`	Passe `false` aqui para evitar que novas chaves sejam criadas e chaves existentes sejam atualizadas.
`update_descriptions`	Booleano	`false`	Atualizar descrições de chave; descrições vazio sobrescrevem as existentes.
`skip_upload_tags`	Booleano	`false`	Tags de upload não são criadas.
`skip_unverification`	Booleano	`false`	Traduções atualizadas não estão não verificadas.
`file_encoding`	string	—	Codificação de arquivo: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` ou `ISO-8859-1`.
`locale_mapping`	object	—	(Apenas Excel/CSV) Mapeie códigos de local para nomes de coluna, por exemplo, `{\"en\": \"C\", \"de\": \"D\"}` para analisar traduções. Isso é distinto do `locale_mapping` de nível superior usado para caminhos de arquivo.
`autotranslate`	Booleano	`false`	Buscar automaticamente traduções para o idioma enviado.
`mark_reviewed`	Booleano	`false`	Marcar traduções importadas como revisado (fluxo de trabalho de revisão avançado deve estar ativado).

Push: Opções de formato

Todas as opções de formato disponíveis são suportadas na configuração da CLI. Veja Arquivo de configuração de exemplo para exemplos.

Pull: Traduções

Chave	Tipo	Obrigatório	Descrição
`pull.targets[].file`	caminho	Sim	Caminho relativo para arquivos de local baixados, por exemplo, `./Radio.de/<locale_code>.lproj/Localizable.strings`.
`pull.targets[].project_id`	string		Substitua o `project_id` global para este alvo de pull específico. Ativar o pull de traduções de múltiplos projetos Phrase usando o mesmo arquivo de configuração.

Pull: Parâmetros

Parâmetro	Tipo	Padrão	Descrição
`file_format`	string	—	Deve ser `Strings`.
`locale_id`	string	—	Nome do local (por exemplo, `en-US`) ou ID de local público.
`tags`	string	—	Tags separadas por vírgula para filtrar quais chaves baixar.
`include_empty_translations`	Booleano	`false`	Incluir chaves sem nenhuma tradução.
`exclude_empty_zero_forms`	Booleano	`false`	Excluir plurais de forma zero quando vazio.
`include_translated_keys`	Booleano	`true`	Incluir chaves que já possuem traduções.
`keep_notranslate_tags`	Booleano	`false`	Preserve `[NOTRANSLATE]` tags na saída.
`codificação`	string	—	Codificação de arquivo: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` ou `ISO-8859-1`.
`include_unverified_translations`	Booleano	`true`	Se `false`, Excluir traduções não verificada.
`use_last_reviewed_version`	Booleano	`false`	Se `true`, usar a última versão revisado (requer fluxo de trabalho de revisão avançado).
`fallback_locale_id`	string	—	Local de fallback para usar para traduções ausentes.

Pull: Opções de formato

Todas as opções de formato disponíveis são suportadas na configuração da CLI. Veja Arquivo de configuração de exemplo para exemplos.

Múltiplas configurações

Em monorepos, coloque um arquivo de configuração em cada pacote e execute a CLI a partir da subpasta correspondente, ou aponte os trabalhos de CI para arquivos de configuração diferentes com a opção --config.

Integração com Git

GitLab:

O arquivo de configuração .phrase.yml precisa estar presente no repositório. O arquivo define quais arquivos importar (pull) ou exportar (push) do repositório.
O acesso à leitura e edição é necessário no repositório.
Arquivos de configuração com definição incorreta podem causar erros. Certifique-se de que o arquivo contenha pelo menos um destino de push e pull, os formatos de arquivo corretos e a configuração correta do parâmetro update_translations.
Use o GitLab 9.5 ou posterior para garantir a compatibilidade da API.

GitHub:

O arquivo de configuração .phrase.yml precisa estar presente no repositório. O arquivo define quais arquivos importar (pull) ou exportar (push) do repositório.
O acesso à leitura e edição é necessário no repositório.
Arquivos de configuração com definição incorreta podem causar erros. Certifique-se de que o arquivo contenha pelo menos um destino de push e pull, os formatos de arquivo corretos e a configuração correta do parâmetro update_translations.
Um token de acesso do GitHub para o escopo do repositório (public_repo se sincronizado com um repositório público).
Se o logon único estiver ativado no GitHub, ele também precisa estar ativado para o token de acesso.
O ramo phrase_translations não pode ser protegido.
Certifique-se de que as configurações do repositório não exigem confirmações assinadas.

BitBucket:

O arquivo de configuração .phrase.yml precisa estar presente no repositório. O arquivo define quais arquivos importar (pull) ou exportar (push) do repositório.
O acesso à leitura e edição é necessário no repositório.
Arquivos de configuração com definição incorreta podem causar erros. Certifique-se de que o arquivo contenha pelo menos um destino de push e pull, os formatos de arquivo corretos e a configuração correta do parâmetro update_translations.