summaryrefslogtreecommitdiffstats
path: root/intl/l10n/docs/migrations/fluent.rst
blob: 1db422ee2618ed8d19d32e98b1fe5d863c06bc17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.. role:: bash(code)
   :language: bash

.. role:: js(code)
   :language: javascript

.. role:: python(code)
   :language: python


===========================
Fluent to Fluent Migrations
===========================

It’s possible to migrate existing Fluent messages using :python:`COPY_PATTERN`
in a migration recipe. Unlike migrations from legacy content, it’s not possible
to interpolate the text, only to copy existing content without changes.

Consider for example a patch modifying an existing message to move the original
value to a :js:`alt` attribute.

Original message:


.. code-block:: fluent

  about-logins-icon = Warning icon
      .title = Breached website


New message:


.. code-block:: fluent

  about-logins-breach-icon =
      .alt = Warning icon
      .title = Breached website


This type of changes requires a new message identifier, which in turn causes
existing translations to be lost. It’s possible to migrate the existing
translated content with:


.. code-block:: python

    from fluent.migrate import COPY_PATTERN

    ctx.add_transforms(
        "browser/browser/aboutLogins.ftl",
        "browser/browser/aboutLogins.ftl",
        transforms_from(
    """
    about-logins-breach-icon =
        .alt = {COPY_PATTERN(from_path, "about-logins-icon")}
        .title = {COPY_PATTERN(from_path, "about-logins-icon.title")}
    """,from_path="browser/browser/aboutLogins.ftl"),
    )


In this specific case, the destination and source files are the same. The dot
notation is used to access attributes: :js:`about-logins-icon.title` matches
the :js:`title` attribute of the message with identifier
:js:`about-logins-icon`, while :js:`about-logins-icon` alone matches the value
of the message.


.. warning::

  Using the message identifier in :python:`COPY_PATTERN` will not migrate the
  message as a whole, with all its attributes, only its value.