Crea un file di configurazione nella CLI (Strings))

Contenuti tradotti automaticamente dall'inglese con Phrase Language AI.

Prerequisiti

Token di accesso API con ambito lettura scrittura
ID progetto Strings mostrato nella scheda API delle impostazioni del progetto
Conoscenze di base su YAML, inclusa l'indentazione
Permessi di lettura e scrittura di Git se il repository eseguirà phrase push o phrase pull in CI

Per creare automaticamente un file di configurazione, segui i passaggi indicati qui sotto:

Dalla riga di comando, digita phrase init per creare un file .phrase.yml.

La procedura guidata di configurazione inizia nella CLI.
Indica:
- Token di accesso
  
  Incolla o premi Invio per consentire l'uso di $PHRASE_ACCESS_TOKEN
- ID progetto Strings (ad es. abcdef1234567890abcdef1234567890)
- Formato file locale (ad es. json, rails_yaml, ios_strings)
- Percorso locale
  
  Percorso glob o esatto ai file locali nel codice sorgente del progetto (ad es. config/locales/*.json)

Un file di base .phrase.yml è creato nella directory corrente.

Consiglio

Fornisci flag per saltare completamente la procedura guidata, ad esempio phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

Se utilizzi un file di configurazione creato o copiato manualmente, spostalo in una di queste posizioni:

La directory di lavoro corrente (pwd) in cui viene chiamato il client CLI.
La cartella home dell'utente attuale ($HOME in Unix, $HomePath in Windows).
Il percorso specificato nella variabile d’ambiente PHRASEAPP_CONFIG.
Percorso del file di configurazione tramite il flag --config (ad es. /some/path/to/phrase.yml).

Panoramica delle opzioni CLI

File di configurazione di esempio.

Impostazioni globali

Chiave	Tipo	Richiesto	Descrizione
`phrase.access_token`	stringa	Sì	Token di accesso personale.
`phrase.project_id`	stringa	Sì	ID progetto pubblico mostrato nelle impostazioni del progetto Strings.
`phrase.file_format`	stringa	Sì	Formato file locale predefinito (estensione API).
`phrase.locale_mapping`	oggetto	No	Mappa le ID delle impostazioni locali di Phrase a nomi personalizzati per l'uso nei percorsi dei file con il segnaposto `<locale_name>`. Questo è utile per piattaforme con convenzioni di denominazione non standard, come Android. Se un'impostazione locale non è specificata nella mappatura, il suo nome standard delle impostazioni locali di Phrase viene utilizzato per impostazione predefinita.

Push: Sources

Chiave	Tipo	Richiesto	Descrizione
`push.sources[].file`	percorso	Sì	Percorso relativo ai file da inviare, ad esempio `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	stringa		Sovrascrivi il `project_id` globale per questa specifica sorgente di file. Utile quando si inviano file a più progetti Phrase dallo stesso file di configurazione.

Push: Parameters

Parametro	Tipo	Predefinita	Descrizione
`file_format`	stringa	intestazione	Sovrascrivi il formato del file per questa sorgente.
`locale_id`	stringa	—	Nome dell'impostazione locale (ad es. `en-US`) o ID pubblico dell'impostazione locale.
`tags`	stringa	—	Tag separati da virgola per nuove chiavi.
`update_translations`	booleano	`false`	Aggiorna le traduzioni esistenti con il contenuto del file.
`update_translation_keys`	booleano	`vero`	Passa `false` qui per impedire la creazione di nuove chiavi e l'aggiornamento delle chiavi esistenti.
`update_descriptions`	booleano	`false`	Aggiorna le descrizioni delle chiavi; le descrizioni vuote sovrascrivono quelle esistenti.
`skip_upload_tags`	booleano	`false`	I tag di caricamento non vengono creati.
`skip_unverification`	booleano	`false`	Le traduzioni aggiornate non sono non verificate.
`file_encoding`	stringa	—	Codifica file: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE`, o `ISO-8859-1`.
`locale_mapping`	oggetto	—	(Solo Excel/CSV) Mappa i codici locali ai nomi delle colonne, ad es. `{"en": "C", "de": "D"}` per l'analisi delle traduzioni. Questo è distinto dalla `impostazioni_locali` di livello superiore utilizzata per i percorsi dei file.
`autotranslate`	booleano	`false`	Recupera automaticamente le traduzioni per la lingua caricata.
`mark_reviewed`	booleano	`false`	Contrassegna le traduzioni importate come revisionate (flusso di lavoro di revisione avanzato deve essere abilitato).

Invia: Opzioni di formato

Tutte le opzioni di formato disponibili sono supportate nella configurazione CLI. Vedi File di configurazione di esempio per esempi.

Ricevi: Destinazioni

Chiave	Tipo	Richiesto	Descrizione
`pull.targets[].file`	percorso	Sì	Percorso relativo per i file locali estratti, ad es. `./Radio.de/<locale_code>.lproj/Localizable.strings`.
`pull.targets[].project_id`	stringa		Sovrascrivi il `id_progetto` globale per questo specifico obiettivo di estrazione. Abilita l'estrazione delle traduzioni da più progetti Phrase utilizzando lo stesso file di configurazione.

Ricevi: Parametri

Parametro	Tipo	Predefinita	Descrizione
`file_format`	stringa	—	Deve essere `Strings`.
`locale_id`	stringa	—	Nome dell'impostazione locale (ad es. `en-US`) o ID pubblico dell'impostazione locale.
`tags`	stringa	—	Tag separati da virgole per filtrare quali chiavi estrarre.
`include_empty_translations`	booleano	`false`	Includere chiavi senza traduzioni.
`exclude_empty_zero_forms`	booleano	`false`	Escludere plurali a forma zero quando vuoto.
`include_translated_keys`	booleano	`vero`	Includere chiavi che hanno già traduzioni.
`keep_notranslate_tags`	booleano	`false`	Preservare i tag `[NOTRANSLATE]` nell'output.
`encoding`	stringa	—	Codifica file: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE`, o `ISO-8859-1`.
`include_unverified_translations`	booleano	`vero`	Se `false`, escludere traduzioni non verificate.
`use_last_reviewed_version`	booleano	`false`	Se `true`, usare l'ultima versione revisionata (richiede un flusso di lavoro di revisione avanzato).
`fallback_locale_id`	stringa	—	Impostazioni locali da usare per traduzioni mancanti.

Estrai: Opzioni di formato

Tutte le opzioni di formato disponibili sono supportate nella configurazione CLI. Vedi File di configurazione di esempio per esempi.

Configurazioni multiple

Nei monorepo, posizionare un file di configurazione in ciascun pacchetto ed eseguire il CLI dalla sottocartella corrispondente, oppure puntare i lavori CI a diversi file di configurazione con l'opzione --config.

Integrazione Git

GitLab:

Il file di configurazione .phrase.yml dev’essere presente nell'archivio. Il file definisce quali file importare (pull) o esportare (push) dall'archivio.
Per l’archivio è necessaria l’autorizzazione alla lettura e alla scrittura.
I file di configurazione definiti in maniera errata potrebbero provocare degli errori. Assicurati che il file contenga almeno una destinazione push e una pull, formati di file corretti e l’impostazione corretta del parametro update_translations.
Usa GitLab 9.5 o una sua versione più recente per garantire la compatibilità API.

GitHub:

Il file di configurazione .phrase.yml dev’essere presente nell'archivio. Il file definisce quali file importare (pull) o esportare (push) dall'archivio.
Per l’archivio è necessaria l’autorizzazione alla lettura e alla scrittura.
I file di configurazione definiti in maniera errata potrebbero provocare degli errori. Assicurati che il file contenga almeno una destinazione push e una pull, formati di file corretti e l’impostazione corretta del parametro update_translations.
Un token di accesso di GitHub per l’ambito dell’archivio (public_repo se si sincronizza con un archivio pubblico).
Se SSO è abilitato in GitHub, deve essere abilitato anche per il token di accesso.
Il branch phrase_translations non può essere protetto.
Assicurati che le impostazioni dell’archivio non richiedano commit firmati.

Bitbucket:

Il file di configurazione .phrase.yml dev’essere presente nell'archivio. Il file definisce quali file importare (pull) o esportare (push) dall'archivio.
Per l’archivio è necessaria l’autorizzazione alla lettura e alla scrittura.
I file di configurazione definiti in maniera errata potrebbero provocare degli errori. Assicurati che il file contenga almeno una destinazione push e una pull, formati di file corretti e l’impostazione corretta del parametro update_translations.

phrase_configuration_overview.yml
(8 KB)