mirror of
https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git
synced 2026-05-28 07:34:33 +08:00
123 lines
4.1 KiB
ReStructuredText
Vendored
123 lines
4.1 KiB
ReStructuredText
Vendored
Checks and fixups
|
|
=================
|
|
|
|
.. _custom-autofix:
|
|
|
|
Custom automatic fixups
|
|
-----------------------
|
|
|
|
You can also implement own automatic fixup in addition to standard ones and
|
|
include them in :setting:`AUTOFIX_LIST`.
|
|
|
|
The automatic fixes are powerful, but can also cause damage, be careful when
|
|
writing one.
|
|
|
|
For example following automatic fixup would replace every occurrence of string
|
|
``foo`` in translation with ``bar``:
|
|
|
|
.. literalinclude:: ../../examples/fix_foo.py
|
|
:language: python
|
|
|
|
.. _custom-checks:
|
|
|
|
Customizing checks
|
|
------------------
|
|
|
|
Fine tuning existing checks
|
|
+++++++++++++++++++++++++++
|
|
|
|
You can fine tune checks for each source string (in source strings review) or
|
|
in the :ref:`component` (:guilabel:`Quality checks flags`), here is current
|
|
list of flags accepted:
|
|
|
|
``rst-text``
|
|
Treat text as RST document, affects :ref:`check-same`.
|
|
``python-format``, ``c-format``, ``php-format``, ``python-brace-format``, ``javascript-format``
|
|
Treats all string like format strings, affects :ref:`check-python-format`,
|
|
:ref:`check-c-format`, :ref:`check-php-format`,
|
|
:ref:`check-python-brace-format`, :ref:`check-javascript-format`, :ref:`check-same`.
|
|
``ignore-end-space``
|
|
Skip the "Trailing space" quality check.
|
|
``ignore-inconsistent``
|
|
Skip the "Inconsistent" quality check.
|
|
``ignore-begin-newline``
|
|
Skip the "Starting newline" quality check.
|
|
``ignore-zero-width-space``
|
|
Skip the "Zero-width space" quality check.
|
|
``ignore-escaped-newline``
|
|
Skip the "Mismatched \n" quality check.
|
|
``ignore-same``
|
|
Skip the "Unchanged translation" quality check.
|
|
``ignore-end-question``
|
|
Skip the "Trailing question" quality check.
|
|
``ignore-end-ellipsis``
|
|
Skip the "Trailing ellipsis" quality check.
|
|
``ignore-ellipsis``
|
|
Skip the "Ellipsis" quality check.
|
|
``ignore-python-brace-format``
|
|
Skip the "Python brace format" quality check.
|
|
``ignore-end-newline``
|
|
Skip the "Trailing newline" quality check.
|
|
``ignore-c-format``
|
|
Skip the "C format" quality check.
|
|
``ignore-javascript-format``
|
|
Skip the "Javascript format" quality check.
|
|
``ignore-optional-plural``
|
|
Skip the "Optional plural" quality check.
|
|
``ignore-end-exclamation``
|
|
Skip the "Trailing exclamation" quality check.
|
|
``ignore-end-colon``
|
|
Skip the "Trailing colon" quality check.
|
|
``ignore-xml-tags``
|
|
Skip the "XML tags mismatch" quality check.
|
|
``ignore-python-format``
|
|
Skip the "Python format" quality check.
|
|
``ignore-plurals``
|
|
Skip the "Missing plurals" quality check.
|
|
``ignore-begin-space``
|
|
Skip the "Starting spaces" quality check.
|
|
``ignore-bbcode``
|
|
Skip the "Mismatched BBcode" quality check.
|
|
``ignore-multiple-failures``
|
|
Skip the "Multiple failing checks" quality check.
|
|
``ignore-php-format``
|
|
Skip the "PHP format" quality check.
|
|
``ignore-end-stop``
|
|
Skip the "Trailing stop" quality check.
|
|
|
|
.. note::
|
|
|
|
Generally the rule is named ``ignore-*`` for any check, using its
|
|
identifier, so you can use this even for your custom checks.
|
|
|
|
These flags are understood both in :ref:`component` settings, per source string
|
|
settings and in translation file itself (eg. in GNU Gettext).
|
|
|
|
Writing own checks
|
|
++++++++++++++++++
|
|
|
|
Weblate comes with wide range of quality checks (see :ref:`checks`), though
|
|
they might not 100% cover all you want to check. The list of performed checks
|
|
can be adjusted using :setting:`CHECK_LIST` and you can also add custom checks.
|
|
All you need to do is to subclass :class:`trans.checks.Check`, set few
|
|
attributes and implement either ``check`` or ``check_single`` methods (first
|
|
one if you want to deal with plurals in your code, the latter one does this for
|
|
you). You will find below some examples.
|
|
|
|
Checking translation text does not contain "foo"
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
This is pretty simple check which just checks whether translation does not
|
|
contain string "foo".
|
|
|
|
.. literalinclude:: ../../examples/check_foo.py
|
|
:language: python
|
|
|
|
Checking Czech translation text plurals differ
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Check using language information to verify that two plural forms in Czech
|
|
language are not same.
|
|
|
|
.. literalinclude:: ../../examples/check_czech.py
|
|
:language: python
|
