Warn instead of crashing when hexdoc_minecraft_version is not impleme…

…nted

README.md

@@ -87,4 +87,8 @@ nox --no-install # after the first Nox run, use this to skip reinstalling every
 
 # update test snapshots
 nox -- --snapshot-update
+
+# run hexdoc commands in an isolated environment to ensure it works on its own
+nox -s hexdoc -- export
+nox -s hexdoc -- repl
 ```

noxfile.py

@@ -1,5 +1,13 @@
 import nox
 
+nox.options.sessions = ["tests"]
+
+
+@nox.session(reuse_venv=True)
+def hexdoc(session: nox.Session):
+ session.install(".")
+ session.run("hexdoc", *session.posargs)
+
 
 @nox.session(reuse_venv=True)
 def tests(session: nox.Session):

src/hexdoc/_cli/utils/load.py

@@ -27,7 +27,12 @@ def load_common_data(props_file: Path, verbosity: int):
  pm = PluginManager()
 
  version = load_version(props, pm)
- MinecraftVersion.MINECRAFT_VERSION = pm.minecraft_version()
+ minecraft_version = MinecraftVersion.MINECRAFT_VERSION = pm.minecraft_version()
+ if minecraft_version is None:
+ logging.getLogger(__name__).warning(
+ "No plugins implement hexdoc_minecraft_version, "
+ "per-version validation will fail"
+ )
 
  return props, pm, version
 

src/hexdoc/_hooks.py

@@ -7,14 +7,12 @@
  HookReturn,
  LoadJinjaTemplatesImpl,
  LoadResourceDirsImpl,
- MinecraftVersionImpl,
  ModVersionImpl,
  hookimpl,
 )
 
 
 class HexdocPlugin(
- MinecraftVersionImpl,
  ModVersionImpl,
  LoadResourceDirsImpl,
  LoadJinjaTemplatesImpl,
@@ -25,11 +23,6 @@ class HexdocPlugin(
  def hexdoc_mod_version():
  return "(TODO: remove)"
 
- @staticmethod
- @hookimpl
- def hexdoc_minecraft_version() -> str:
- return "1.20.1" # TODO: remove
-
  @staticmethod
  @hookimpl
  def hexdoc_load_resource_dirs() -> HookReturn[Package]:

src/hexdoc/core/compat.py

@@ -31,19 +31,24 @@ def matches(cls, specifier: str | SpecifierSet) -> bool:
 
 
 class MinecraftVersion(VersionSource):
- MINECRAFT_VERSION: ClassVar[str]
+ MINECRAFT_VERSION: ClassVar[str | None] = None
 
  @override
  @classmethod
- def get(cls):
+ def get(cls) -> str:
+ if cls.MINECRAFT_VERSION is None:
+ raise RuntimeError(
+ "Tried to call MinecraftVersion.get() "
+ "before initializing MinecraftVersion.MINECRAFT_VERSION"
+ )
  return cls.MINECRAFT_VERSION
 
  @override
  @classmethod
  def matches(cls, specifier: str | SpecifierSet) -> bool:
  if isinstance(specifier, str):
  specifier = SpecifierSet(specifier)
- return cls.MINECRAFT_VERSION in specifier
+ return cls.get() in specifier
 
 
 @dataclass(frozen=True)

src/hexdoc/plugin/manager.py

@@ -95,7 +95,7 @@ def __init__(self) -> None:
  def mod_version(self, modid: str):
  return self._hook_caller(PluginSpec.hexdoc_mod_version, modid)()
 
- def minecraft_version(self) -> str:
+ def minecraft_version(self) -> str | None:
  versions = dict[str, str]()
 
  for modid, caller in self._all_callers(PluginSpec.hexdoc_minecraft_version):
@@ -113,7 +113,7 @@ def minecraft_version(self) -> str:
 
  match len(set(versions.values())):
  case 0:
- raise ValueError("No plugins implement hexdoc_minecraft_version")
+ return None
  case 1:
  return versions.popitem()[1]
  case n: