lint: Validate strings #234

german77 · 2025-01-09T00:33:25Z

Is not invalid string, is invalid swing. This PR adds an additional check to check-format.py. It finds strings in the source code and checks if the string is defined in the nso.

This check can't validate if the string is the correct one for that specific line of code but at least ensures typos or incomplete strings can't be added to the project.

It also adds a new tool generate-strings.py that creates the csv file from the main.nso file.

This change is

MonsterDruide1

Reviewed 6 of 7 files at r1, all commit messages.
Reviewable status: 6 of 7 files reviewed, 11 unresolved discussions (waiting on @german77)

tools/generate-strings.py line 1 at r1 (raw file):

#!/ usr / bin / env python3

Suggestion:

#!/usr/bin/env python3

tools/generate-strings.py line 9 at r1 (raw file):

MIN_TEXT_SIZE = 0x2
MAX_TEXT_SIZE = 0x400

There are some more longer strings

Suggestion:

MAX_TEXT_SIZE = 0x600

tools/generate-strings.py line 20 at r1 (raw file):

        return
    if len(buffer) > MAX_TEXT_SIZE:
        return

Throw error here instead

tools/generate-strings.py line 31 at r1 (raw file):

        text = text.replace("\r", "\\r")
        text = text.replace("\t", "\\t")
        text = text.replace("\"", "\\\"")

Also add a replacement for backslash \ => \

tools/generate-strings.py line 44 at r1 (raw file):

def parse_nso(csv_file, nso_file):
    offset = START_OFFSET - NSO_OFFSET + 0x100

Why is that juggling with 0x100 done? I see that it fails to start at the right offset otherwise, but ... why?

tools/generate-strings.py line 46 at r1 (raw file):

    offset = START_OFFSET - NSO_OFFSET + 0x100
    end = END_OFFSET - NSO_OFFSET + 0x100
    nso_file.seek(offset);

Suggestion:

nso_file.seek(offset)

tools/generate-strings.py line 77 at r1 (raw file):

    
    nso_file.close()
    csv_file.close()

with to avoid closing

Code quote:

    csv_file = open(string_path, "w")
    nso_file = open(nso_path, "rb")

    parse_nso(csv_file, nso_file)

    nso_file.close()
    csv_file.close()

tools/generate-strings.py line 85 at r1 (raw file):

        print("main.nso not found")
        return
    create_string_table(project_root / 'data'/ "data_strings.csv", project_root / 'data'/ "main.nso");

Suggestion:

create_string_table(project_root / 'data'/ "data_strings.csv", project_root / 'data'/ "main.nso")

src/Player/PlayerConst.cpp line 0 at r1 (raw file):
Please also rename the PlayerConst members for all typos fixed in here

tools/check-format.py line 447 at r1 (raw file):

def read_csv_file(path):
    if not os.path.isfile(path):
        return []

raise exception instead

Code quote:

return []

tools/check-format.py line 456 at r1 (raw file):

        rows.append(row)

    file.close()

with to avoid manually closing the file

Code quote:

    file = open(path, mode="r")
    reader = csv.reader(file)

    rows = []
    for row in reader:
        rows.append(row)

    file.close()

tools/check-format.py line 475 at r1 (raw file):

                file_path = os.path.join(root, file)
                file_str = str(file_path)
                check_file(file_str, string_table)

Do not add parameters for individual checks here - instead, create a function get_string_table() and use the @cache tool to avoid performance hits.

german77

Reviewable status: 3 of 8 files reviewed, 11 unresolved discussions (waiting on @MonsterDruide1)

src/Player/PlayerConst.cpp line at r1 (raw file):