Start working on automatic README generation.

Author: Holt59

.pre-commit-config.yaml

@@ -28,6 +28,15 @@ repos:
             "-o",
             "plugin-requirements.txt",
           ]
+  - repo: local
+    hooks:
+      - id: update-readme-games
+        name: Update list of games in README.md
+        entry: python
+        language: python
+        # files: ^(.*/)?\.py$
+        args: [pre-commit-hooks/update-readme-games.py]
+        additional_dependencies: [jinja2==3.1.6]
 
 ci:
   autofix_commit_msg: "[pre-commit.ci] Auto fixes from pre-commit.com hooks."

README.md

@@ -45,6 +45,8 @@ You can rename `modorganizer-basic_games-xxx` to whatever you want (e.g., `basic
 
 ## Supported games
 
+<!-- START: GAMES -->
+
 | Game | Author | File | Extras |
 |------|--------|------|--------|
 | The Binding of Isaac: Rebirth — [STEAM](https://store.steampowered.com/app/250900/The_Binding_of_Isaac_Rebirth/) |[EzioTheDeadPoet](https://github.com/EzioTheDeadPoet)|[game_thebindingofisaacrebirth.py](games/game_thebindingofisaacrebirth.py)|<ul><li>profile specific ini file</li></ul>|
@@ -82,6 +84,8 @@ You can rename `modorganizer-basic_games-xxx` to whatever you want (e.g., `basic
 | Yu-Gi-Oh! Master Duel — [STEAM](https://store.steampowered.com/app/1449850/) | [The Conceptionist](https://github.com/the-conceptionist) & [uwx](https://github.com/uwx) | [game_masterduel.py](games/game_masterduel.py) | |
 | Zeus and Poseidon — [GOG](https://www.gog.com/game/zeus_poseidon) / [STEAM](https://store.steampowered.com/app/566050/Zeus__Poseidon/) | [Holt59](https://github.com/holt59/) | [game_zeusandpoiseidon.py](games/game_zeusandpoiseidon.py) | <ul><li>mod data checker</li></ul> |
 
+<!-- END: GAMES -->
+
 ## How to add a new game?
 
 You can create a plugin by providing a python class in the `games` folder.

poetry.lock

@@ -0,0 +1,10 @@
+{%- for game in games -%}
+| {{ game.name }} | {%- for author in game.authors -%}
+{%- if author.homepage -%}
+[{{ author.name }}]({{ author.homepage }})
+{%- else -%}
+{{ author.name }}
+{%- endif -%}
+{%- if not loop.last %}, {% endif %}
+{%- endfor -%} | [{{ game.file.split('/') | last }}]({{ game.file }}) | |
+{% endfor %}

pre-commit-hooks/update-readme-games.jinja

@@ -0,0 +1,149 @@
+import ast
+import logging
+from pathlib import Path
+from typing import TypedDict, cast
+
+from jinja2 import Template
+
+START_TAG = "<!-- START: GAMES -->"
+END_TAG = "<!-- END: GAMES -->"
+
+_FILE = Path(__file__)
+ROOT = _FILE.parent.parent
+TPLT = _FILE.with_suffix(".jinja")
+
+# careful with the new lines here
+HEADER = """
+<!-- This section was automatically generated, do not edit! -->
+
+| Game | Author | File | Extras |
+|------|--------|------|--------|
+"""
+FOOTER = """
+"""
+
+CUSTOM_AUTHOR_HOMEPAGES = {
+    "Luca/EzioTheDeadPoet": "https://eziothedeadpoet.github.io/AboutMe/",
+    "R3z Shark": "",
+    "Miner Of Worlds": "",
+    "Kane Dou": "",
+    "Ryan Young": "",
+    "The Conceptionist": "",
+}
+
+
+class Author(TypedDict):
+    name: str
+    homepage: str
+
+
+class BasicGameInformation(TypedDict, total=False):
+    name: str
+    authors: list[Author]
+    file: str
+
+
+def extract_basic_games(path: Path):
+    logging.info(f"extracting basic games from {path}...")
+    with open(path, "r") as fp:
+        module = ast.parse(fp.read())
+
+    games: list[ast.ClassDef] = []
+    for stmt in module.body:
+        if not isinstance(stmt, ast.ClassDef):
+            continue
+
+        for base in stmt.bases:
+            if isinstance(base, ast.Name) and base.id == "BasicGame":
+                games.append(stmt)
+                break
+
+            # not sure if this is possible? would mean something like xxx.BasicGame
+            if isinstance(base, ast.Attribute) and base.attr == "BasicGame":
+                games.append(stmt)
+                break
+
+    return games
+
+
+def extract_basic_game_information(path: Path, game: ast.ClassDef):
+    value: BasicGameInformation = {
+        "file": "https://github.com/ModOrganizer/modorganizer-basic_games/blob/master/"
+        + path.relative_to(ROOT).as_posix()
+    }
+    for stmt in game.body:
+        if not isinstance(stmt, ast.Assign):
+            continue
+
+        # skip multiple assignments (should not be any in a class?)
+        if len(stmt.targets) != 1:
+            continue
+
+        target = stmt.targets[0]
+        if not isinstance(target, ast.Name):  # can this happen?
+            continue
+
+        match target.id:
+            case "GameName":
+                assert isinstance(stmt.value, ast.Constant)
+                value["name"] = stmt.value.value
+            case "Author":
+                assert isinstance(stmt.value, ast.Constant)
+                author_s = cast(str, stmt.value.value)
+
+                authors = [p.strip() for p in author_s.split(",")]
+                authors = [p.strip() for pp in authors for p in pp.split("&")]
+                value["authors"] = sorted(
+                    [
+                        {
+                            "name": author,
+                            "homepage": CUSTOM_AUTHOR_HOMEPAGES.get(
+                                author, f"https://github.com/{author}"
+                            ),
+                        }
+                        for author in authors
+                    ],
+                    key=lambda a: a["name"],
+                )
+            case _:
+                pass
+
+        print(stmt, stmt.value, target.id)
+    return value
+
+
+def generate_table():
+    # list the games
+    games: list[tuple[Path, ast.ClassDef]] = []
+    for path in ROOT.joinpath("games").glob("**/*.py"):
+        if path.parent.name == "quarantine":
+            continue
+
+        games.extend((path, game) for game in extract_basic_games(path))
+
+    infos = [extract_basic_game_information(path, game) for path, game in games]
+
+    with open(TPLT, "r") as fp:
+        template = Template(fp.read())
+
+    content = template.render(games=sorted(infos, key=lambda g: g.get("name", "")))
+
+    return HEADER + content + FOOTER
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+
+    # read the README content
+    with open(ROOT.joinpath("README.md"), "r") as fp:
+        readme = fp.read()
+
+    # find the start and end block
+    start = readme.find(START_TAG)
+    end = readme.find(END_TAG)
+    assert start >= 0 and end >= 0
+
+    readme = readme[:start] + START_TAG + "\n" + generate_table() + readme[end:]
+
+    with open(ROOT.joinpath("README2.md"), "w") as fp:
+        fp.write(readme)

pre-commit-hooks/update-readme-games.py

@@ -28,6 +28,7 @@ pyright = "^1.1.400"
 ruff = "^0.11.7"
 types-psutil = "^5.9.5.20240516"
 poethepoet = "^0.34.0"
+jinja2 = "3.1.6"
 
 [build-system]
 requires = ["poetry-core (>=2.0)"]