Files
airflow/dev/breeze/doc/10_ui_tasks.rst
T
조현준andClaude Fable 5 eb47cc9f15 Add --json output to breeze ui check-translation-completeness (#75831)
The checker computed its per-file statistics inside the rich table
rendering loop, so the report existed only as terminal output. Extract
the aggregation into build_completeness_report() and add a --json flag
that prints the same data as a single JSON document on stdout —
following the breeze ci verify --json pattern (#73241): narration is
suppressed (or sent to stderr with --verbose) so the output can be
piped straight to jq.

The default output stays byte-identical, exit-code semantics are
unchanged (#55327), and the existing --language/--add-missing/
--remove-unused flags compose with --json.

closes: #75772

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Claude-Session: https://claude.ai/code/session_01A18rBgPJ6X4oXAzsecJjnz
2026-11-01 23:27:55 +00:00

97 lines
3.6 KiB
ReStructuredText

.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
UI tasks
--------
There are some Breeze commands that are used to support Apache Airflow project UI.
Those are all of the available ui commands:
.. image:: ./images/output_ui.svg
:target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_ui.svg
:width: 100%
:alt: Breeze ui commands
Compiling ui assets
--------------------
Before starting Airflow, Airflow API server needs to prepare www assets - compiled with node and yarn. The
``breeze ui compile-assets`` command takes care about it. This is needed when you want to run API server
inside of the breeze.
.. image:: ./images/output_ui_compile-assets.svg
:target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/images/output_ui_compile-assets.svg
:width: 100%
:alt: Breeze ui compile-assets
Note
This command requires the ``prek`` tool, which should be installed by following
`this guide <../../../contributing-docs/03b_contributors_quick_start_seasoned_developers.rst#configuring-prek>`__.
Check translation completeness
""""""""""""""""""""""""""""""
To check if the UI translations are complete for all languages, you can use the
``breeze ui check-translation-completeness`` command. This command compares all non-English
locale translations against the English (base) translations to identify:
* Missing translation keys that need to be added
* Extra translation keys that should be removed
* TODO markers indicating incomplete translations
* Translation coverage percentages per language
The command supports language-specific plural forms (e.g., Polish has 4 forms, Arabic has 6)
and can automatically add missing keys or remove extra keys.
These are all available flags of ``check-translation-completeness`` command:
.. image:: ./images/output_ui_check-translation-completeness.svg
:target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_ui_check-translation-completeness.svg
:width: 100%
:alt: Breeze check translation completeness
Example usage:
.. code-block:: bash
# Check all languages
breeze ui check-translation-completeness
# Check a specific language
breeze ui check-translation-completeness --language pl
# Add missing translations with TODO markers
breeze ui check-translation-completeness --add-missing
# Remove unused translations (keys not required)
breeze ui check-translation-completeness --remove-unused
# Fix translations for a specific language
breeze ui check-translation-completeness --language de --add-missing --remove-unused
# Print the report as machine-readable JSON (stdout carries only the JSON document)
breeze ui check-translation-completeness --language de --json
-----
Next step: Follow the `Registry tasks <11_registry_tasks.rst>`__ instructions to learn about
the provider registry commands.