Bulk i18n of epicmenu widget options

[moreginger]

No description provided.

[moreginger]

This doesn't cover everything, but it's a good start.
It seems to start and I went through all the settings pages - they seem OK?

using this script and some fixup:

import argparse
import json
import re

options_block_regex = re.compile(r'^options_(path|order)?\s*=')
options_start_regex = re.compile(r'^options\s*=\s*{')
widget_name_regex = re.compile(r'name\s*=\s*[\'"]([^\'"]+)[\'"],')
option_start_regex = re.compile(r'^\s+([a-zA-Z0-9_]+)\s*=\s*{')
option_string_regex = re.compile(r'^(\s+)(name|desc)\s*=\s*[\'"]([^\'"]+)[\'"],\s*$')

parser = argparse.ArgumentParser(prog='i18n_options')
parser.add_argument('filename')
parser.add_argument('--i18nfile', help='Path to translations file')

args = parser.parse_args()

filename = args.filename
i18nfile = args.i18nfile

def cleanup_string(s):
    return re.sub(r'\W+', '', s).replace('_', '').lower()

widget_prefix = None

new_content = []

epicmenu_json = None
with open(i18nfile) as json_file:
    epicmenu_json = json.load(json_file)

option_name = None

print('processing ' + filename + '...')

with open(filename) as lua_file:
    wrote_prefix = False
    in_options = False
    for line in lua_file.readlines():
        if 'i18nPrefix' in line:
            print('i18nPrefix already exists in ' + filename + '. Exiting...')
            exit(0)

        if not wrote_prefix and options_block_regex.search(line):
            new_content.append("i18nPrefix = '" + widget_prefix + "'\n")
            wrote_prefix = True

        if not widget_prefix and widget_name_regex.search(line):
            widget_prefix = cleanup_string(widget_name_regex.search(line).group(1)) + '_'
        elif options_start_regex.search(line):
            in_options = True
        elif line.startswith('}'):
            in_options = False
        elif line.endswith('},'):
            option_name = False
        elif option_start_regex.search(line):
            match = option_start_regex.search(line)
            option_name = match.group(1).lower() + '_option'
        elif in_options and option_string_regex.search(line):
            match = option_string_regex.search(line)
            content = match.group(3)
            if match.group(2) == 'name':
                epicmenu_json[widget_prefix + option_name] = content
                line = None
            elif match.group(2) == 'desc':
                epicmenu_json[widget_prefix + option_name + '_desc'] = content
                line = None

        if line:
            new_content.append(line)

if not option_name:
    print('No options found in ' + filename + '. Exiting...')
    exit(0)

with open(filename, 'w') as lua_file:
    lua_file.write(''.join(new_content))

with open(i18nfile, 'w') as json_file:
    json.dump(epicmenu_json, json_file, indent='\t', sort_keys=True, separators=(',', ' : '))

[GoogleFrog]

I wish translations didn't make the rest of development so inconvenient.

[moreginger]

They are a pain, I've gotten used to them being annoying. One option is to have the English translation with the code, and not in a resources file. But you'd have to extract and store it for switching back to English.

[sprunk]

alue. Extra scary because there could be more errors like this lurking around the patch.

[moreginger]

Thanks for spotting this.

Maybe the answer is: run script on another copy of ZK, review differences?
For ~100 files there should be no change.

Or maybe review only added/changed lines and assume deleted are OK, if there's a way to do that.

[sprunk]

Label name is probably technical and shouldn't be put into i18n.

[moreginger]

I'm interested in what the labels are. I'll have a look later.

[moreginger]

Yeah this one is weird, and good spot. It looks like the "value" is the text that we'd want here. I searched for "unitslabel" and found no references, it could be constructed of course. But as a label I find it hard to imagine the string has a technical purpose.

	unitslabel = {name="unitslabel", type = 'label', value = "Individual Toggles", path = options_path},

Generally, labels are UI elements as you no doubt know, and the i18n of them is working in other places.

[sprunk]

% is a format specifier in i18n, it should become %%

[sprunk]

Monoliths are hard to review and there's a bunch of issues as above. I think ideally there would be a bunch of commits with, say, 10 widgets per commit and then they would be easy to review and mergeable individually.

[moreginger]

You can safely replace all the % with %% in that file.

Monoliths are hard to review

Hmm I thought you'd prefer to get it all done in one.

I'm not sure that I have the staying power to create a series of 14 PRs. Especially after having done a conversion twice already. I appreciate it's a massive pain to review the large change.

I think maybe if I make a couple of changes to the script it might be best if you use it in batches you are happy with. Perhaps you can feel happier that it is acting in a sensible way? I can let you know the 2 widgets that it breaks. That will leave 10 or 20 that either partially or don't i18n without changes, but we can chase those later.

[moreginger]

You might also want to review the technique. I wonder if it's better not to move the English translation to the resources file, @GoogleFrog didn't seem happy with it. I can imagine how that might work - providing the current value as a default when requesting translations, and store it as English if you don't have an English translation stored, but I think you'd want to consider the API carefully together. If I start trying to guess what you want then we'll be here a long time!

I guess that makes it harder to translate them though 🤷

[sprunk]

tooltip seems unhandled?

[moreginger]

Oooh, good spot. I'm not sure if options work at all, certainly my script isn't smart enough to do them properly.
I guess we really need to cut this into smaller pieces.

[GoogleFrog]

@sprunk I hope you're not waiting on me for anything.

[sprunk]

No, I'm waiting for chore mana from myself.