Rewrite item/block rendering

.github/workflows/ci.yml

@@ -52,10 +52,37 @@ jobs:
           name: python-build
           path: dist
 
+  pre-commit:
+    runs-on: ubuntu-latest
+    env:
+      HEXDOC_RELEASE: false
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - uses: yezz123/setup-uv@v4
+
+      - name: Run pre-commit hooks
+        env:
+          SKIP: pyright
+        uses: pre-commit/action@v3.0.0
+
   test:
     runs-on: ubuntu-latest
     env:
       HEXDOC_RELEASE: false
+    strategy:
+      fail-fast: false
+      matrix:
+        nox-args:
+          - --tags test_fast
+          - --sessions test_build "test_hexcasting(branch='1.19')"
+          - --sessions test_build "test_hexcasting(branch='main')"
+          - --sessions test_build test_copier
     steps:
       - uses: actions/checkout@v4
         with:
@@ -71,20 +98,15 @@ jobs:
         with:
           packages: xvfb
 
-      - name: Run pre-commit hooks
-        env:
-          SKIP: pyright
-        uses: pre-commit/action@v3.0.0
-
       - name: Install Nox
         run: uv pip install --system nox
 
       - name: Run Nox with display server
-        run: xvfb-run --auto-servernum nox
+        run: xvfb-run --auto-servernum nox ${{ matrix.nox-args }}
 
   update-tags:
     runs-on: ubuntu-latest
-    needs: [build, test]
+    needs: [build, pre-commit, test]
     if: github.event_name == 'push' && needs.build.outputs.release == 'true'
     permissions:
       contents: write
@@ -108,7 +130,7 @@ jobs:
 
   publish-pypi:
     runs-on: ubuntu-latest
-    needs: [build, test]
+    needs: [build, pre-commit, test]
     if: github.event_name == 'push' && needs.build.outputs.release == 'true'
     environment:
       name: pypi

.gitignore

@@ -5,6 +5,7 @@ __gradle_version__.py
 out/
 .hexdoc*/
 out.png
+out.gif
 
 node_modules/
 package-lock.json

.gitmodules

@@ -1,6 +1,9 @@
 [submodule "submodules/HexMod"]
-	path = submodules/HexMod
+	path = submodules/HexMod_main
 	url = https://github.com/object-Object/HexMod
 [submodule "submodules/hexdoc-hexcasting-template"]
 	path = submodules/hexdoc-hexcasting-template
 	url = https://github.com/hexdoc-dev/hexdoc-hexcasting-template
+[submodule "submodules/HexMod_1.19"]
+	path = submodules/HexMod_1.19
+	url = https://github.com/object-Object/HexMod

.pre-commit-config.yaml

@@ -1,14 +1,22 @@
 exclude: '__snapshots__|^vendor/'
-
+default_install_hook_types:
+  - pre-commit
+  - pre-push
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        files: ^web/docusaurus/
+        types_or: [javascript, jsx, ts, tsx, mdx]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.2
+    rev: v0.14.10
     hooks:
       - name: ruff-fix
         id: ruff
@@ -19,6 +27,7 @@ repos:
     hooks:
       - id: pyright
         name: pyright
+        stages: [pre-push]
         entry: nox -s pyright --
         language: python
         language_version: '3.11'

.vscode/launch.json

@@ -20,7 +20,7 @@
             "args": [
                 "build",
                 // "--props",
-                // "./submodules/HexMod/doc/hexdoc.toml",
+                // "./submodules/HexMod_main/doc/hexdoc.toml",
                 // "--release",
             ],
             "console": "integratedTerminal",

.vscode/settings.json

@@ -14,8 +14,8 @@
         "editor.rulers": [120],
     },
     "ruff.organizeImports": true,
-    "ruff.lint.args": [
-        "--extend-ignore=I", // format on save is enabled, so don't show the squiggles
+    "ruff.lint.ignore": [
+        "I", // format on save is enabled, so don't show the squiggles
     ],
     "python.languageServer": "Pylance",
     "python.analysis.diagnosticMode": "workspace",

examples/model_rendering/.gitignore

@@ -1,5 +1,6 @@
 # hexdoc
 out/
+/renders/
 .hexdoc*/
 out.png
 

examples/model_rendering/resources/assets/example/models/item/example_item.json

@@ -1,3 +1,6 @@
 {
-    "parent": "minecraft:block/stone"
+    "parent": "item/generated",
+    "textures": {
+        "layer0": "minecraft:block/command_block_front"
+    }
 }

nodemon.json

@@ -3,12 +3,12 @@
         "src",
         "resources",
         "vendor",
-        "submodules/HexMod/doc/src",
-        "submodules/HexMod/doc/resources",
-        "submodules/HexMod/doc/hexdoc.toml",
-        "submodules/HexMod/Common/src/main/resources/assets/*/lang"
+        "submodules/HexMod_main/doc/src",
+        "submodules/HexMod_main/doc/resources",
+        "submodules/HexMod_main/doc/hexdoc.toml",
+        "submodules/HexMod_main/Common/src/main/resources/assets/*/lang"
     ],
     "ignore": ["**/generated/**"],
     "ext": "jinja,html,css,js,ts,toml,json,json5,py,png,mcmeta",
-    "exec": "hexdoc build && hexdoc --quiet-lang ru_ru --quiet-lang zh_cn serve --props submodules/HexMod/doc/hexdoc.toml"
+    "exec": "hexdoc build && hexdoc serve --props submodules/HexMod_main/doc/hexdoc.toml"
 }

noxfile.py

@@ -36,7 +36,7 @@
 # tests
 
 
-@nox.session
+@nox.session(tags=["test_fast"])
 def pyright(session: nox.Session):
     session.install("-e", ".[test]")
 
@@ -47,7 +47,7 @@ def pyright(session: nox.Session):
     session.run("pyright", *args)
 
 
-@nox.session(tags=["test"])
+@nox.session(tags=["test", "test_fast"])
 def test(session: nox.Session):
     session.install("-e", ".[test]")
 
@@ -61,46 +61,45 @@ def test_build(session: nox.Session):
     session.run("hexdoc", "build", "--branch=main", env=MOCK_ENV)
 
 
-@nox.session(tags=["test", "post_build"])
-@nox.parametrize(["branch"], ["1.19_old", "main_old"])
+@nox.session(tags=["test"])
+@nox.parametrize(["branch"], ["1.19", "main"])
 def test_hexcasting(session: nox.Session, branch: str):
-    with session.cd("submodules/HexMod"):
-        original_branch = run_silent_external(
-            session, "git", "rev-parse", "--abbrev-ref", "HEAD"
-        )
-        if original_branch == "HEAD":  # properly handle detached HEAD
-            original_branch = run_silent_external(session, "git", "rev-parse", "HEAD")
+    submodule = f"submodules/HexMod_{branch}"
 
-        session.run("git", "checkout", branch, external=True)
+    session.install("-e", ".[test]", "-e", f"./{submodule}")
 
-    try:
-        session.install("-e", ".[test]", "-e", "./submodules/HexMod")
-
-        session.run(
-            "hexdoc",
-            "--quiet-lang=ru_ru",
-            "--quiet-lang=zh_cn",
-            "build",
-            "--branch=main",
-            "--props=submodules/HexMod/doc/hexdoc.toml",
-            env=MOCK_ENV,
-        )
+    session.run(
+        "hexdoc",
+        "build",
+        "--branch=main",
+        f"--props={submodule}/doc/hexdoc.toml",
+        env=MOCK_ENV,
+    )
 
-        session.run(
-            "pytest",
-            "-m",
-            "hexcasting",
-            *session.posargs,
-            env={"MOCK_PLATFORM": "Windows"},
-        )
-    finally:
-        with session.cd("submodules/HexMod"):
-            session.run("git", "checkout", original_branch, external=True)
+    session.run(
+        "pytest",
+        "-m",
+        "hexcasting",
+        *session.posargs,
+        env={
+            "MOCK_PLATFORM": "Windows",
+            "TEST_SUBMODULE": submodule,
+            "TEST_BRANCH": branch,
+        },
+    )
 
 
-@nox.session(tags=["test", "post_build"])
+@nox.session(tags=["test"])
 def test_copier(session: nox.Session):
-    session.install("pip", "-e", ".[test]", "-e", "./submodules/HexMod")
+    session.install("pip", "-e", ".[test]", "-e", "./submodules/HexMod_main")
+
+    session.run(
+        "hexdoc",
+        "build",
+        "--branch=main",
+        "--props=submodules/HexMod_main/doc/hexdoc.toml",
+        env=MOCK_ENV,
+    )
 
     template_repo = Path("submodules/hexdoc-hexcasting-template")
     rendered_template = template_repo / ".ctt" / "test_copier"
@@ -174,7 +173,8 @@ def pdoc(session: nox.Session):
 
 
 # docs for the docs!
-@nox.session(tags=["docs"], python=False)
+# note: we can't use python=False because then --no-install doesn't work
+@nox.session(tags=["docs"])
 def docusaurus(session: nox.Session):
     shutil.copytree("media", f"{STATIC_GENERATED}/img", dirs_exist_ok=True)
 
@@ -227,7 +227,7 @@ def tag(session: nox.Session):
 def setup(session: nox.Session):
     session.install("uv", "pre-commit")
 
-    if not Path("submodules/HexMod/pyproject.toml").exists():
+    if not Path("submodules/HexMod_main/pyproject.toml").exists():
         session.run("git", "submodule", "update", "--init")
 
     rmtree(session, "venv", onerror=on_rm_error)
@@ -237,7 +237,7 @@ def setup(session: nox.Session):
         *("uv", "pip", "install"),
         "--quiet",
         "-e=.[dev]",
-        "-e=./submodules/HexMod",
+        "-e=./submodules/HexMod_main",
         env={
             "VIRTUAL_ENV": str(Path.cwd() / "venv"),
         },
@@ -649,6 +649,9 @@ def dummy_setup(session: nox.Session):
                     "foo:baz" = false
                     "mod:foo" = false
 
+                    [textures]
+                    strict = false
+
                     [template]
                     icon = "icon.png"
                     include = [

pyproject.toml

@@ -57,6 +57,7 @@ dependencies = [
     "pygithub~=2.1",
     "pyjson5~=1.6",
     "requests~=2.31",
+    "tqdm~=4.66",
     "typer~=0.12",
     "typing_extensions~=4.6",
     "yarl~=1.9",
@@ -75,7 +76,7 @@ pdoc = [
     "pdoc~=14.1",
 ]
 test = [
-    "pyright==1.1.361",
+    "pyright==1.1.389",
     "pytest~=7.4",
     "pytest-dependency~=0.5",
     "pytest-describe~=2.2",
@@ -85,7 +86,7 @@ test = [
 ]
 dev = [
     "hexdoc[pdoc,test]",
-    "ruff~=0.3.2",
+    "ruff~=0.14.10",
     "pre-commit",
     "nox[uv]",
 ]
@@ -193,6 +194,7 @@ include = [
 ]
 extraPaths = [
     "vendor",
+    "typings",
 ]
 exclude = [
     "noxfile.py",
@@ -205,7 +207,6 @@ exclude = [
 
 typeCheckingMode = "basic"
 
-enableExperimentalFeatures = true
 strictDictionaryInference = true
 strictListInference = true
 strictSetInference = true

src/_scripts/json_schema.py

@@ -4,11 +4,12 @@
 
 import rich
 import typer
+from pydantic import BaseModel, TypeAdapter
+from typer import Argument, Option
+
 from hexdoc.cli.utils import DefaultTyper
 from hexdoc.cli.utils.args import parse_import_class
 from hexdoc.core.compat import MinecraftVersion
-from pydantic import BaseModel, TypeAdapter
-from typer import Argument, Option
 
 app = DefaultTyper()
 

src/hexdoc/__version__.py

@@ -1 +1 @@
-VERSION = "1!0.1.0a35"
+VERSION = "1!0.2.0rc1.dev0"

src/hexdoc/_export/resources/assets/hexdoc/lang/en_us.flatten.json5

@@ -43,8 +43,6 @@
 
     when_clicked: "When clicked, would execute: {}",
 
-    any_block:  "Any Block",
-
     redirect: {
       "category.title": "Category: {}",
       "entry.title": "Entry: {}",
@@ -55,4 +53,6 @@
       Minecraft content and materials are the intellectual property of their respective owners.$(br2)\
       Made with ❤️ using $(l:https://pypi.org/project/hexdoc/)hexdoc/$."
   },
+
+  "gui.hexdoc.any_block": "Any Block",
 }