Crea un file di configurazione nella CLI (Strings))

Contenuti tradotti automaticamente dall'inglese con Phrase Language AI.

Prerequisiti

Token di accesso<1> API con ambito read write
ID progetto Strings mostrato nella scheda API<1> delle impostazioni del progetto
Conoscenza di base di YAML, inclusa l'indentazione
Autorizzazioni di lettura e scrittura Git se l'archivio eseguirà phrase push o phrase pull in CI

Suggerimento

Per informazioni più dettagliate, consulta il Developer Hub.

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 Enter per consentire l'utilizzo di $PHRASE_ACCESS_TOKEN
- ID progetto Strings (ad es. abcdef1234567890abcdef1234567890)
- Formato file impostazioni locali (ad es. json, rails_yaml, ios_strings)
- Percorso locale
  
  Glob o percorso esatto dei file delle impostazioni locali nella base di codice del progetto (ad es. config/locales/*.json)

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

Consiglio

Fornisci i flag per ignorare 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 cliente 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ì	Impostazioni locali predefinite formato file (estensione API).
`phrase.locale_mapping`	oggetto	No	Mappa gli ID impostazioni locali Phrase a nomi Personalizzato da usare nei percorsi dei file con il segnaposto `<locale_name>`. Questo è utile per piattaforme con convenzioni di denominazione non standard, come Android. Se un'impostazioni locali non è specificata nella mappatura, viene usato per impostazione predefinita il suo nome impostazioni locali Phrase standard.

Push: Origini

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

Push: Parametri

Parametro	Tipo	Predefinita	Descrizione
`file_format`	stringa	intestazione	Sovrascrivi il formato per questa origine.
`locale_id`	stringa	—	Nome impostazioni locali (ad es. `en-US`) o ID impostazioni locali pubblico.
`tags`	stringa	—	Tag separati da virgola per le nuove chiavi.
`update_translations`	booleano	`false`	Aggiornare le traduzioni esistenti con il contenuto del file.
`update_translation_keys`	booleano	`vero`	Impostare `false` qui per impedire la creazione di nuove chiavi e l'aggiornamento di quelle esistenti.
`update_descriptions`	booleano	`false`	Aggiornare le descrizioni delle chiave; le descrizioni vuoto sovrascrivono quelle esistenti.
`skip_upload_tags`	booleano	`false`	I tag di caricare non vengono creati.
`skip_unverification`	booleano	`false`	Le traduzioni aggiornate non sono non verificato.
`file_encoding`	stringa	—	Codifica file: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` o `ISO-8859-1`.
`locale_mapping`	oggetto	—	(Solo Excel/CSV) Mappare i codici delle impostazioni locali ai nomi delle colonne, ad es. `{"en": "C", "de": "D"}` per l'analisi delle traduzioni. Questo è distinto dal `locale_mapping` di primo livello utilizzato per i percorsi dei file.
`autotranslate`	booleano	`false`	Recuperare automaticamente le traduzioni per la lingua caricare.
`mark_reviewed`	booleano	`false`	Contrassegnare le traduzioni importate come revisionato (flusso di lavoro di revisione avanzato deve essere abilitare).

Push: Opzioni di formato

Tutte le Opzioni di formato disponibili sono supportate nella configurazione CLI. Vedere File di configurazione di esempio per esempi.

Pull: Destinazione

Chiave	Tipo	Richiesto	Descrizione
`pull.targets[].file`	percorso	Sì	Percorso relativo per i file di impostazioni locali estratti, ad es. `./Radio.de/<locale_code>.lproj/Localizable.Strings`.
`pull.targets[].project_id`	stringa		Sovrascrivere il `project_id` globale per questa specifica destinazione di pull. Abilitare l'estrazione delle traduzioni da più progetti Phrase utilizzando lo stesso file di configurazione.

Pull: Parametri

Parametro	Tipo	Predefinita	Descrizione
`file_format`	stringa	—	Deve essere `Strings`.
`locale_id`	stringa	—	Nome impostazioni locali (ad es. `en-US`) o ID impostazioni locali pubblico.
`tags`	stringa	—	Tag separati da virgola per filtrare quali chiave estrarre.
`include_empty_translations`	booleano	`false`	Includi chiavi senza alcuna traduzione.
`exclude_empty_zero_forms`	booleano	`false`	Escludi i plurali in forma zero quando vuoto.
`include_translated_keys`	booleano	`vero`	Includi chiavi che hanno già traduzioni.
`keep_notranslate_tags`	booleano	`false`	Preserva i tag `[NOTRANSLATE]` nell'output.
`Codifica`	stringa	—	Codifica file: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` o `ISO-8859-1`.
`include_unverified_translations`	booleano	`vero`	Se `false`, Escludi le traduzioni non verificato.
`use_last_reviewed_version`	booleano	`false`	Se `true`, usare l'ultima versione revisionato (richiede un flusso di lavoro di revisione avanzato).
`fallback_locale_id`	stringa	—	Impostazioni locali di fallback da usare per le traduzioni mancanti.

Pull: Opzioni di formato

Tutte le Opzioni di formato disponibili sono supportate nella configurazione CLI. Vedere File di configurazione di esempio per esempi.

Configurazioni multiple

Nei monorepo, posizionare un file di configurazione in ogni pacchetto ed eseguire la CLI dalla sottocartella corrispondente, oppure puntare i processi CI a file di configurazione diversi 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.