Move JS directory inside reactpy to fix broken source distributions

docs/source/about/changelog.rst

@@ -27,6 +27,7 @@ Unreleased
 
 - :pull:`1118` - `module_from_template` is broken with a recent release of `requests`
 - :pull:`1131` - `module_from_template` did not work when using Flask backend
+- :pull:`1183` - Fix broken source distributions due to missing JavaScript client source code
 
 **Added**
 

docs/source/about/contributor-guide.rst

@@ -131,8 +131,8 @@ This repository is set up to be able to manage many applications and libraries w
 in a variety of languages. All projects can be found under the ``src`` directory:
 
 - ``src/py/{project}`` - Python packages
-- ``src/js/app`` - ReactPy's built-in JS client
-- ``src/js/packages/{project}`` - JS packages
+- ``src/py/reactpy/js/app`` - ReactPy's built-in JS client
+- ``src/py/reactpy/js/packages/{project}`` - JS packages
 
 At the root of the repository is a ``pyproject.toml`` file that contains scripts and
 their respective dependencies for managing all other projects. Most of these global
@@ -162,7 +162,7 @@ For Javascript, you'd do:
 
 .. code-block:: bash
 
-    cd src/js/packages/event-to-object
+    cd src/py/reactpy/js/packages/event-to-object
     npm run check:tests
 
 

src/py/reactpy/.gitignore

@@ -1,4 +1,22 @@
 .coverage.*
 
+# --- External gitignores ---
+# For hatch, this is the only .gitignore that matters!
+# Changes to another .gitignore may need to be reflected here
+# if it is necessary to exclude them from the source distribution,
+# such as build artifacts.
+#
+# When duplicating patterns, keep in mind that their meaning changes
+# between .gitignore locations:
+# https://git-scm.com/docs/gitignore#_pattern_format
+
+# /.gitignore
+node_modules
+
+# /src/py/reactpy/js/.gitignore
+js/**/tsconfig.tsbuildinfo
+js/packages/**/package-lock.json
+js/**/dist
+
 # --- Build Artifacts ---
 reactpy/_static

src/py/reactpy/hatch_build_sdist.py

@@ -0,0 +1,30 @@
+"""Custom sdist build hook for reactpy.
+
+As defined in pyproject.toml, this script should automatically be executed
+when creating a source (.tar.gz) distribution.
+
+See also: https://hatch.pypa.io/1.9/plugins/build-hook/custom/
+
+"""
+import shutil
+from pathlib import Path
+from typing import Any
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        # https://github.com/pypa/hatch/issues/1197
+        # As a workaround, delete js/node_modules/ so hatchling does not
+        # mistakenly omit js/packages/ from the source distribution.
+        #
+        # If only the source distribution is built, i.e. by running one of:
+        #   - `hatch build --target sdist`
+        #   - `python -m build --sdist`
+        # then node_modules/ will be missing. Developers that later want to run
+        # `npm run build` will also need to reinstall with `npm ci`.
+        modules = Path(self.root) / "js" / "node_modules"
+        if modules.is_dir():
+            print("Removing", modules)
+            shutil.rmtree(modules)

src/py/reactpy/pyproject.toml

@@ -124,8 +124,17 @@ dependencies = [
 types = "mypy --strict reactpy"
 all = ["types"]
 
-[[tool.hatch.build.hooks.build-scripts.scripts]]
-work_dir = "../../js"
+[tool.hatch.build.targets.sdist]
+only-include = ["js", "reactpy"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"reactpy/_static" = "reactpy/_static"  # bypass .gitignore
+
+[tool.hatch.build.targets.sdist.hooks.custom]
+path = "hatch_build_sdist.py"
+
+[[tool.hatch.build.targets.wheel.hooks.build-scripts.scripts]]
+work_dir = "js"
 out_dir = "reactpy/_static"
 commands = [
   "npm ci",

tasks.py

@@ -50,7 +50,7 @@ def __call__(
 ROOT = Path(__file__).parent
 DOCS_DIR = ROOT / "docs"
 SRC_DIR = ROOT / "src"
-JS_DIR = SRC_DIR / "js"
+JS_DIR = SRC_DIR / "py" / "reactpy" / "js"
 PY_DIR = SRC_DIR / "py"
 PY_PROJECTS = [p for p in PY_DIR.iterdir() if (p / "pyproject.toml").exists()]
 TAG_PATTERN = re.compile(