Extensões¶

As extensões fornecem maneiras de personalizar e automatizar o fluxo de trabalho de tradução. Os administradores podem adicionar e gerir os add-ons no menu Gerir ↓ Extensões de cada projeto ou componente de tradução respetivo. Os add-ons também podem ser instalados em todo o site em Interface de gestão.

Dica

Também pode configurar extensões utilizando API, DEFAULT_ADDONS ou install_addon.

Events that trigger add-ons¶

Add-on installation¶

Triggered when add-on is being installed.

Component update¶

Triggered whenever a change happens in a component such as:

Strings are changed in the repository.
A string is added.
A new translation is added.

Daily¶

Triggered daily, but add-ons usually split the daily load between components depending on BACKGROUND_TASKS.

Repository post-add¶

Triggered just after the new translation is added and committed.

Repository post-commit¶

Triggered just after the changes are committed.

Repository post-push¶

Triggered just after the repository is pushed upstream.

Repository post-update¶

Triggered whenever new changes are pulled from the upstream repository.

Repository pre-commit¶

Triggered just before the changes are committed.

Repository pre-push¶

Triggered just before the repository is pushed upstream.

Repository pre-update¶

Triggered just before the repository update is attempted.

Storage post-load¶

Triggered when file is parsed by Weblate.

Unit post-save¶

Triggered just after the string is saved.

Unit pre-create¶

Triggered just after the newly created string is saved.

Extensões embutidas¶

Tradução automática¶

ID da extensão:

weblate.autotranslate.autotranslate

Configuração:

`mode`	Modo de tradução automático	Escolhas disponíveis: `suggest` – Adiciona como sugestão `translate` – Adiciona como tradução `fuzzy` – Adiciona como «Necessita de edição»
`filter_type`	Filtro de procura	Por favor, note que a tradução de todas as cadeias irá descartar todas as traduções existentes. Escolhas disponíveis: `all` – Todos os textos `nottranslated` – Cadeias não traduzidas `todo` – Cadeias não finalizadas `fuzzy` – Textos marcados para edição `check: inconsistent` – Verificação com falha: Inconsistente `check:translated` – Failing check: Has been translated
`auto_source`	Fonte das traduções automáticas	Escolhas disponíveis: `others` – Outros componentes da tradução `mt` – Tradução de máquina
`component`	Componente	Introduza a lesma de um componente para utilizar como fonte, deixe em branco para utilizar todos os componentes no projeto atual.
`engines`	Motores de tradução automática
`threshold`	Limite de pontuação

Gatilhos:

Add-on installation, Component update, Daily

Traduz automaticamente as cadeias utilizando a tradução automática ou outros componentes.

Veja também

Tradução automática, Manter traduções iguais entre componentes

CDN de localização JavaScript¶

Added in version 4.2.

ID da extensão:

weblate.cdn.cdnjs

Configuração:

`threshold`	Limiar de tradução	Limiar para inclusão de traduções.
`css_selector`	Seletor de CSS	Seletor CSS para detetar elementos localizáveis.
`cookie_name`	Nome do cookie do idioma	Nome do cookie que armazena a preferência de idioma.
`files`	Extrair cadeias de ficheiros de HTML	Lista de nomes de ficheiros no repositório atual ou URLs remotas a serem analisados para obter cadeias traduzíveis.

Gatilhos:

Add-on installation, Daily, Repository post-commit, Repository post-update

Publica traduções na rede de distribuição de conteúdo para o uso na localização de JavaScript ou HTML.

Pode ser usado para localizar páginas HTML estáticas ou para carregar a localização no código JavaScript.

Gera um URL exclusivo para o seu componente, que pode ser incluído em páginas HTML para localizá-los. Veja Traduzir HTML e JavaScript a usar CDN Weblate para mais detalhes.

Nota

Este complemento requer configuração adicional no servidor Weblate. LOCALIZE_CDN_PATH configura onde os ficheiros gerados serão gravados (num sistema de ficheiros) e LOCALIZE_CDN_URL define onde eles serão servidos (URL). O serviço dos ficheiros não é feito pelo Weblate e deve ser configurado externamente (normalmente usando um serviço CDN).

Esta extensão é configurado em Hosted Weblate e disponibiliza os ficheiros via https://weblate-cdn.com/.

Veja também

Configurando extensão de CDN do Weblate, Traduzir HTML e JavaScript a usar CDN Weblate, Extração de cadeias para CDN Weblate, Localização de HTML a usar CDN Weblate

Remover cadeias em branco¶

Added in version 4.4.

ID da extensão:: weblate.cleanup.blank
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Repository post-commit, Repository post-update

Remove cadeias não traduzidas dos ficheiros de tradução.

Use isso para não ter cadeias vazias em ficheiros de tradução (por exemplo, se a sua biblioteca de localização os exibe como em falta em vez de recorrer ao texto fonte).

Veja também

O Weblate atualiza ficheiros de tradução além de traduções?

Limpeza de ficheiros de tradução¶

ID da extensão:: weblate.cleanup.generic
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Repository post-update, Repository pre-commit

Atualize todos os ficheiros de tradução para coincidirem com o ficheiro monolingue base. Para a maioria dos formatos de ficheiro, significa remover as chaves de tradução obsoletas que já não existem no ficheiro base.

Para formatos que contêm conteúdo adicional além das cadeias de tradução (como Ficheiro HTML, Ficheiros RC do Windows ou Formato OpenDocument), isto também sincroniza o ficheiro de tradução com o ficheiro base.

Veja também

O Weblate atualiza ficheiros de tradução além de traduções?

Adiciona idiomas em falta¶

ID da extensão:: weblate.consistency.languages
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Daily, Repository post-add

Garante que um conjunto consistente de idiomas seja usado para todos os componentes de um projeto.

Os idiomas ausentes são verificados uma vez a cada 24 horas e quando novos idiomas são adicionados no Weblate.

Ao contrário da maioria dos outros, esta extensão afeta todo o projeto.

Dica

Traduza as cadeias recém-adicionadas automaticamente com Tradução automática.

Descoberta de componentes¶

ID da extensão:

weblate.discovery.discovery

Configuração:

`match`	Expressão regular para corresponder ficheiros de tradução
`file_format`	Formato de ficheiro
`name_template`	Personalizar nome do componente
`base_file_template`	Definir nome do ficheiro base monolingue	Manter vazio para ficheiros de tradução bilingue.
`new_base_template`	Defina o ficheiro base para as novas traduções	Nome do ficheiro utilizado para criar as novas traduções. Para gettext, escolher o ficheiro «.pot».
`intermediate_template`	Ficheiro de idioma intermédio	Nome do ficheiro de tradução intermediária. Geralmente este é um ficheiro de tradução fornecido pelos programadores e é usado na criação de cadeias de origem reais.
`language_regex`	Filtro de idioma	Expressão regular para filtrar ficheiros de tradução ao examinar por uma máscara de ficheiros.
`copy_addons`	Clonar extensões do componente principal para os recém-criados
`remove`	Remover componentes para os ficheiros inexistentes
`confirm`	Confirmo que as correspondências acima parecem correctas

Gatilhos:

Add-on installation, Repository post-update

Adiciona ou remove automaticamente componentes do projeto com base em alterações de ficheiros no sistema de controlo de versão.

A correspondência é feita a usar expressões regulares que permitem uma configuração complexa, mas é necessário algum conhecimento para fazê-la. Alguns exemplos para casos de uso comum encontram-se na secção de ajuda de extensões.

A expressão regular para corresponder aos ficheiros de tradução deve conter dois grupos nomeados para corresponder ao componente e ao idioma. Todos os grupos nomeados na expressão regular podem ser usados como variáveis nos campos do modelo.

Pode usar a marcação do template Django em todos os campos de nome de ficheiro, por exemplo:

{{ component }}: Nome do componente correspondente
{{ component|title }}: Nome do componente com a 1ª letra maiúscula
{{ path }}: {{ component }}: Grupo de correspondência personalizado da expressão regular

Uma vez que acertar Gravar, uma prévia dos componentes correspondentes será apresentada, de onde pode verificar se a configuração realmente corresponde às suas necessidades:

{{ originalHierarchy }}: {{ component }}

Ficheiros correspondentes:

parent/module1/submodule/src/main/resources/ApplicationResources_fr.properties
parent/module1/submodule/src/main/resources/ApplicationResource_es.properties
parent/module2/src/main/resources/ApplicationResource_de.properties
parent/module2/src/main/resources/ApplicationResource_ro.properties

Dica

A extensão de descoberta de componentes usa URLs internas do Weblate. É uma maneira conveniente de compartilhar a configuração do VCS entre vários componentes. Os componentes vinculados usam o repositório local do componente principal configurado a preencher weblate://project/main-component no campo Repositório do código-fonte (em Gerir ↓ Configurações ↓ Sistema de controle de versão) de cada componente. Isso economiza tempo com configuração e recursos do sistema também.

Veja também

Marcação de modelo, import_project

Edição em massa¶

ID da extensão:

weblate.flags.bulk

Configuração:

`q`	Consulta
`state`	Estado a definir	Escolhas disponíveis: `-1` – Não alterar `10` – Necessita edição `20` – Traduzido `30` – Aprovado
`add_flags`	Bandeiras de tradução para adicionar
`remove_flags`	Bandeiras de tradução para remover
`add_labels`	Etiqueta a adicionar
`remove_labels`	Etiquetas a remover

Gatilhos:

Add-on installation, Component update

Edição em série de marcadores, etiquetas, ou estados de cadeias.

Exemplos::

Rotula novas cadeias automaticamente¶
Consulta de pesquisa	`NOT has:label`
Etiqueta a adicionar	recente

Marcar como somente leitura todas as cadeias do changelog de Ficheiros de metadados da App Store¶
Consulta de pesquisa	`language:en AND key:changelogs/`
Bandeiras de tradução para adicionar	`read-only`

Marking certain strings read-only¶
Consulta de pesquisa	source:r"^\`\`[.a-zA-Z0-9_-]*\`\`$" AND language:en
Bandeiras de tradução para adicionar	`read-only`

Veja também

Edição em massa, Personalizando comportamento a usar marcadores, Etiquetas de cadeia

Marcar as traduções inalteradas como «Precisa de edição»¶

ID da extensão:: weblate.flags.same_edit
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Unit pre-create

Sempre que uma nova cadeia traduzível é importada do VCS e corresponde a uma cadeia fonte, é marcada como necessita de edição no Weblate. Isto é especialmente útil para os formatos de ficheiro que incluem cadeias não traduzidas.

Dica

Também pode reforçar a verificação Tradução inalterada a adicionar o marcador strict-same aos Marcadores de tradução.

Veja também

Estados de tradução

Marcar as novas cadeias fonte como «Precisa de edição»¶

ID da extensão:: weblate.flags.source_edit
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Unit pre-create

Sempre que uma nova cadeia é importada do VCS, é marcada como necessita de edição no Weblate. Deste modo pode filtrar e editar facilmente as cadeias fonte escritas pelos programadores.

Veja também

Estados de tradução

Marcar as novas traduções como «Precisa de edição»¶

ID da extensão:: weblate.flags.target_edit
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Unit pre-create

Sempre que uma nova cadeia de tradução é importada do VCS, é marcada como necessita de edição no Weblate. Deste modo pode facilmente filtrar e editar as traduções criadas pelos programadores.

Veja também

Estados de tradução

Preencher cadeias de caracteres só de leitura com a fonte¶

Added in version 4.18.

ID da extensão:: weblate.generate.fill_read_only
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Component update, Daily

Preenche a tradução de cadeias de caracteres só de leitura com a cadeia fonte.

Gerador de estatísticas¶

ID da extensão:

weblate.generate.generate

Configuração:

`filename`	Nome do ficheiro gerado
`template`	Conteúdo do ficheiro gerado

Gatilhos:

Repository pre-commit

Gera um ficheiro que contêm a informação detalhada sobre o estado da tradução.

Pode usar um modelo do Django, tanto de nome de ficheiro e conteúdo, veja Ficheiros de Markdown para uma descrição detalhada de marcação.

Por exemplo, a geração de um ficheiro de resumo para cada tradução:

Nome do ficheiro gerado

locale/{{ language_code }}.json

Conteúdo

{
   "language": "{{ language_code }}",
   "strings": "{{ stats.all }}",
   "translated": "{{ stats.translated }}",
   "last_changed": "{{ stats.last_changed }}",
   "last_author": "{{ stats.last_author }}",
}

Veja também

Marcação de modelo

Preencher a tradução com fonte¶

Added in version 4.11.

ID da extensão:: weblate.generate.prefill
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Component update, Daily

Preenche cadeias de tradução com a cadeia fonte.

Todos os textos não traduzidos no componente serão preenchidos com a cadeia fonte e marcados como necessita de edição. Use-o quando não puder ter cadeias vazias nos ficheiros de tradução.

Geração da pseudolocalidade¶

Added in version 4.5.

ID da extensão:

weblate.generate.pseudolocale

Configuração:

`source`	Cadeias fonte
`target`	Tradução de destino	Todas as cadeias nesta tradução serão sobrescritas
`prefix`	Prefixo de cadeia fixo
`var_prefix`	Prefixo da cadeia variável
`suffix`	Sufixo da cadeia fixo
`var_suffix`	Sufixo da cadeia variável
`var_multiplier`	Multiplicador de partes variável	Quantas vezes repetir a parte variável dependendo do comprimento da cadeia fonte.
`include_readonly`	Incluir cadeias somente leitura

Gatilhos:

Add-on installation, Component update, Daily

Gera uma tradução a adicionar um prefixo e sufixo às cadeias de origem automaticamente.

Pseudolocalidades são úteis para encontrar textos que não estão preparadas para localização. Isso é feito a alterar todas as cadeias fonte traduzíveis para facilitar a descoberta de textos inalterados ao executar a aplicação no idioma da pseudolocalidade.

Também é possível encontrar cadeias cujas contrapartes localizadas podem não se ajustar ao layout.

O uso das partes variáveis possibilita procurar por cadeias que podem não caber na interface do utilizador após a localização – isso estende o texto com base no comprimento da cadeia fonte. As partes variáveis são repetidas pelo comprimento do texto multiplicado pelo multiplicador. Por exemplo, Hello world com sufixo variável _ e multiplicador variável de 1 se torna Hello world___________ – o sufixo é repetido uma vez para cada caractere na cadeia fonte.

As cadeias serão geradas segundo o padrão:

Prefixo de cadeia fixo Prefixo de cadeia variável Cadeia fonte Sufixo de cadeia variável Sufixo de cadeia fixo

Dica

Pode usar idiomas reais para teste, mas existem pseudolocalidades disponíveis no Weblate - en_XA e ar_XB.

Dica

Pode usar esta extensão para iniciar a tradução para uma nova localidade de um idioma existente ou idioma semelhante. Depois de adicionar a tradução ao componente, siga para a extensão. Exemplo: Se tem fr e deseja iniciar a tradução fr_CA, simplesmente defina fr como fonte,` fr_CA` como o destino e deixe o prefixo e o sufixo em branco.

Desinstale a extensão depois de preencher a nova tradução para evitar que o Weblate altere as traduções feitas após a cópia.

Contribuintes em comentários¶

ID da extensão:: weblate.gettext.authors
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Repository pre-commit

Atualiza a parte do comentário no cabeçalho do ficheiro PO para incluir nomes de colaboradores e anos de contribuições.

O cabeçalho do ficheiro PO terá a seguinte aparência:

# Michal Čihař <michal@weblate.org>, 2012, 2018, 2019, 2020.
# Pavel Borecki <pavel@example.com>, 2018, 2019.
# Filip Hron <filip@example.com>, 2018, 2019.
# anonymous <noreply@weblate.org>, 2019.

Atualizar a variável ALL_LINGUAS no ficheiro «configure»¶

ID da extensão:: weblate.gettext.configure
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Daily, Repository post-add

Atualiza a variável ALL_LINGUAS em ficheiros configure, configure.in ou configure.ac, quando uma nova tradução é adicionada.

Personalizar a saída gettext¶

ID da extensão:

weblate.gettext.customize

Configuração:

width

Ajuste de linhas longas

Por predefinição, o gettext quebra as linhas a 77 carateres e novas linhas. Com o parâmetro –no-wrap, quebra apenas em novas linhas.

Escolhas disponíveis:

77 – Quebrar linhas com 77 carateres e nas novas linhas (predefinição de xgettext)

65535 – Quebrar as linhas apenas nas novas linhas (como “xgettext –no-wrap”)

-1 – Sem quebra de linhas

Gatilhos:

Storage post-load

Permite personalizar o comportamento da saída gettext, por exemplo, a quebra de linhas.

Oferece as seguintes opções:

Quebrar linhas em 77 caracteres e em novas linhas
Quebrar as linhas apenas nas novas linhas
Sem quebra de linhas

Nota

Por padrão, o gettext quebra as linhas em 77 caracteres e em novas linhas. Com o parâmetro --no-wrap, a quebra só é feita em novas linhas.

Atualizar ficheiro LINGUAS¶

ID da extensão:: weblate.gettext.linguas
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Daily, Repository post-add

Atualiza o ficheiro LINGUAS quando é adicionada uma nova tradução.

Gerar ficheiros MO¶

ID da extensão:

weblate.gettext.mo

Configuração:

`path`	Caminho do ficheiro MO gerado	Se não especificado, será utilizada a localização do ficheiro PO.
`fuzzy`	Incluir cadeias que necessitam edição	Cadeias que necessitam edição (fuzzy/aproximados) normalmente não estão prontas para uso como traduções.

Gatilhos:

Repository pre-commit

Gera automaticamente um ficheiro MO para cada ficheiro PO alterado.

O local do ficheiro MO gerado pode ser personalizada e o campo para ele usa Marcação de modelo.

Nota

Se uma tradução for removida, o seu ficheiro de PO será apagado do repositório, mas o ficheiro de MO gerado por esse complemento não. O ficheiro de MO deve ser removido do upstream manualmente.

Atualizar ficheiros PO para coincidir com POT (msgmerge)¶

ID da extensão:

weblate.gettext.msgmerge

Configuração:

`previous`	Manter «msgids» anteriores das cadeias traduzidas
`no_location`	Remover localizações das cadeias traduzidas
`fuzzy`	Utilizar correspondência de imprecisa

Gatilhos:

Add-on installation, Repository post-update

Atualiza todos os ficheiros PO (configurados por Máscara de ficheiros) para corresponder ao ficheiro POT (configurado por Modelo para novas traduções) usando msgmerge.

Most msgmerge command-line options can be set up through the add-on configuration.

Veja também

O Weblate atualiza ficheiros de tradução além de traduções?

Squash de commits git¶

ID da extensão:

weblate.git.squash

Configuração:

squash

Submeter com squash

Escolhas disponíveis:

all – Todos os commits num só

language – Por idioma

file – Por ficheiro

author – Por autor

append_trailers

Anexar linhas finalizadoras à mensagem do commit de squash

As linhas finalizadoras são linhas semelhantes aos cabeçalhos de e-mail RFC 822, no final de uma mensagem de commit de outra forma livre, como «Co-authored-by: …”.

commit_message

Mensagem de commit

Esta mensagem de commit será usada em vez das mensagens de commit combinadas dos commits após squash.

Gatilhos:

Add-on installation, Repository post-commit

Comprimir as submissões Git antes de enviar as alterações.

Commits Git podem ter squash feito antes de fazer o push das alterações num dos seguintes modos:

Todos os commits num só
Por idioma
Por ficheiro
Por autor

As mensagens de commit originais são mantidas, mas a autoria é perdida a menos que Por autor seja selecionada ou a mensagem de commit, seja personalizada para incluí-la.

As mensagens de commit originais podem opcionalmente ser substituídas por uma mensagem de commit personalizada.

Linhas finalizadoras (linhas de commits como Co-authored-by: …) podem opcionalmente ser removidas das mensagens de commit originais e anexadas ao final da mensagem de compromisso após um squash. Isso também gera crédito próprio Co-authored-by: para cada tradutor.

Personalizar a saída JSON¶

ID da extensão:

weblate.json.customize

Configuração:

sort_keys

Ordenar chaves JSON

indent

Indentação JSON

style

Estilo de indentação JSON

Escolhas disponíveis:

spaces – Espaços

tabs – Tabulações

Gatilhos:

Storage post-load

Permite ajustar o comportamento da saída JSON, por exemplo, a indentação ou a ordenação.

Formatar as propriedades do ficheiro Java¶

ID da extensão:

weblate.properties.sort

Configuração:

case_sensitive

Ativar a ordenação de chaves sensível a maiúsculas e minúsculas

Gatilhos:

Repository pre-commit

Formata e ordena as propriedades do ficheiro Java.

Consolida quebras de linhas para Unix.
Formatação em maiúsculas de sequências de escape Unicode (caso estejam presentes).
Tira linhas em branco e comentários.
Ordena as cadeias pelas chaves.
Solta cadeias duplicadas.

Purga de comentários obsoletos¶

ID da extensão:

weblate.removal.comments

Configuração:

age

Dias para manter

Gatilhos:

Add-on installation, Daily

Definir um prazo para a remoção de comentários.

Isso pode ser útil para remover comentários antigos que podem ter ficado desatualizados. Use com cuidado, pois comentários ficarem velhos não significam que eles perderam importância.

Purga de sugestões obsoletas¶

ID da extensão:

weblate.removal.suggestions

Configuração:

`age`	Dias para manter
`votes`	Limites de votação	Limite para a remoção. Este campo não tem efeito com os votos desativados.

Gatilhos:

Add-on installation, Daily

Definir um prazo para a remoção de sugestões.

Pode ser muito útil em relação à votação em sugestão (vej Revisão por pares) para remover sugestões que não recebem votos positivos suficientes num determinado período de tempo.

Atualizar ficheiros RESX¶

ID da extensão:: weblate.resx.update
Configuração:: Esta extensão não tem configuração.
Gatilhos:: Add-on installation, Repository post-update

Atualize todos os ficheiros de tradução para que correspondam ao ficheiro base monolingue original. As cadeias não utilizadas são removidas e as cadeias novas são adicionadas como cópias da cadeia fonte.

Dica

Use Limpeza de ficheiros de tradução se só quiser remover chaves de tradução obsoletas.

Veja também

O Weblate atualiza ficheiros de tradução além de traduções?

Personalizar a saída de XML¶

Added in version 4.15.

ID da extensão:

weblate.xml.customize

Configuração:

closing_tags

Incluir etiqueta de fecho para etiquetas XML em branco

Gatilhos:

Storage post-load

Permite ajustar o comportamento da saída XML, por exemplo, fechando tags.

Personalizar a saída YAML¶

ID da extensão:

weblate.yaml.customize

Configuração:

indent

Indentação de YAML

width

Ajuste de linhas longas

Escolhas disponíveis:

80 – Quebra linhas em 80 caracteres

100 – Quebra linhas em 100 caracteres

120 – Quebra linhas em 120 caracteres

180 – Quebra linhas em 180 caracteres

65535 – Sem quebra de linhas

line_break

Quebras de linha

Escolhas disponíveis:

dos – DOS (\r\n)

unix – UNIX (\n)

mac – MAC (\r)

Gatilhos:

Storage post-load

Permite ajustar o comportamento da saída YAML, por exemplo, o comprimento de linha ou novas linhas.

Personalizando a lista de extensões¶

A lista de extensões é configurada por WEBLATE_ADDONS. Para adicionar outra extensão, basta incluir o nome absoluto da classe nesta configuração.

Escrevendo extensões¶

També pode escrever as suas próprias extensões. Crie uma subclasse de weblate.addons.base.BaseAddon para definir os metadados da extensão e, então, implemente uma função de retorno que vai fazer o processamento.

Veja também

Desenvolver extensões

Escrevendo scripts para extensões¶

Extensões também podem ser usadas para executar scripts externos. Isso costumava estar integrado no Weblate, mas agora tem que escrever algum código para embrulhar o seu script com uma extensão.

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

"""Example pre commit script."""

from django.utils.translation import gettext_lazy

from weblate.addons.events import AddonEvent
from weblate.addons.scripts import BaseScriptAddon


class ExamplePreAddon(BaseScriptAddon):
    # Event used to trigger the script
    events: set[AddonEvent] = {
        AddonEvent.EVENT_PRE_COMMIT,
    }
    # Name of the addon, has to be unique
    name = "weblate.example.pre"
    # Verbose name and long description
    verbose = gettext_lazy("Execute script before commit")
    description = gettext_lazy("This add-on executes a script.")

    # Script to execute
    script = "/bin/true"
    # File to add in commit (for pre commit event)
    # does not have to be set
    add_file = "po/{{ language_code }}.po"

Para instruções de instalação, veja Verificações de qualidade personalizadas, extensões e correções automáticas.

repositório VCS para qualquer componente.

Além disso, as seguintes variáveis de ambiente estão disponíveis:

WL_VCS¶: Sistema de controle de versão usado.

WL_REPO¶: URL do repositório upstream.

WL_PATH¶: Caminho absoluto ao repositório VCS.

WL_BRANCH¶: Ramo do repositório configurado no componente atual.

WL_FILEMASK¶: Máscara de ficheiro para componente atual.

WL_TEMPLATE¶: Nome de ficheiro de modelo para traduções monolínguas (pode estar vazio).

WL_NEW_BASE¶: Nome do ficheiro usado para criar traduções (pode estar vazio).

WL_FILE_FORMAT¶: Formato de ficheiro usado no componente atual.

WL_LANGUAGE¶: Idioma da tradução processada atualmente (não disponível para ganchos de nível de componente).

WL_PREVIOUS_HEAD¶: HEAD anterior após atualização (disponível apenas ao executar o gancho de pós-atualização).

WL_COMPONENT_SLUG¶: Slug do componente usado para construir a URL.

WL_PROJECT_SLUG¶: Slug de projeto usado para construir a URL.

WL_COMPONENT_NAME¶: Nome de componente.

WL_PROJECT_NAME¶: Nome do projeto.

WL_COMPONENT_URL¶: URL do componente.

WL_ENGAGE_URL¶: URL de engajamento do projeto.

Veja também

Configuração de componente

Processamento de repositório pós-atualização¶

Pode ser usado para atualizar ficheiros de tradução quando a fonte VCS do upstream alterar. Para conseguir isso, lembre-se que o Weblate só vê fcheiros dos quais se fez commit com o VCS, então precisa fazer commit das alterações como parte do script.

Por exemplo, com Gulp, pode fazê-lo a usar o código seguinte:

#! /bin/sh
gulp --gulpfile gulp-i18n-extract.js
git commit -m 'Update source strings' src/languages/en.lang.json

Processamento pré-commit de traduções¶

Use o script de commit para alterar automaticamente uma tradução antes de fazer commit dela para o repositório.

É passado como um parâmetro único que consiste o nome de uma tradução atual.

Registo de atividades complementares¶

O registo de atividades da extensão mantém o controle da execução da extensão e pode ser usado para acompanhar a atividade da extensão.

Os registos podem ser podados após um certo intervalo de tempo configurando o ADDON_ACTIVITY_LOG_EXPIRY.