learningfoundry 0.35.0__tar.gz → 0.36.0__tar.gz

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.36.0] - 2026-04-29
+
+### Changed
+
+- **`learningfoundry preview` is now the canonical "see your work" command.** Previously the post-build prompt and the README disagreed: the CLI told users to `cd dist && pnpm install && pnpm build` (a static export that exits without serving), while the README told them to run `learningfoundry preview`. Users following whichever doc they read first ended up with redundant work or wasted `pnpm install` invocations. The CLI's post-build prompt now consistently points at `learningfoundry preview` for every `DepState`, with `cd dist && pnpm build` mentioned only as the "for a static export to deploy" alternative.
+  - `src/learningfoundry/cli.py` — collapsed the three-branch `DepState` prompt into a single message: `Next: learningfoundry preview` (with a `⚠️  Dependencies changed …` line prepended in the `CHANGED` case so the user knows the upcoming `learningfoundry preview` will reinstall).
+  - `README.md` — Quick Start step 3 now combines build+preview into one `learningfoundry preview` invocation; the `learningfoundry preview` reference section explicitly notes that it serves the SvelteKit project from source via Vite (not the `pnpm build` static output) and now skips `pnpm install` when nothing has changed.
+
+### Performance
+
+- **`learningfoundry preview` no longer runs `pnpm install` on every invocation.** It now consults `check_dep_state(output_dir)` and skips the install step entirely when the state is `UNCHANGED` (every declared dep is already present in `node_modules/`). Subsequent `learningfoundry preview` runs after a content edit go straight to `pnpm run dev`, saving 5–30 s per cycle. The install still runs unconditionally on `FIRST_BUILD` and `CHANGED` states.
+  - `src/learningfoundry/pipeline.py::run_preview` — imports `DepState` and `check_dep_state`; logs `Dependencies up to date — skipping pnpm install.` when the state is `UNCHANGED`.
+
+### Added (tests)
+
+- `tests/test_cli.py::TestBuildNextStepsPrompt` — 3 cases asserting the new build prompt wording for `FIRST_BUILD`, `UNCHANGED`, and `CHANGED` states (each must say `Next: learningfoundry preview`; only `CHANGED` mentions the dep-change warning).
+- `tests/test_pipeline.py::TestRunPreviewSkipsInstall` — 3 cases verifying that `run_preview` invokes `pnpm install` on `FIRST_BUILD` and `CHANGED` but not on `UNCHANGED`, while always invoking `pnpm run dev`.
+
 ## [0.35.0] - 2026-04-29
 
 ### Fixed

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learningfoundry
-Version: 0.35.0
+Version: 0.36.0
 Summary: A curriculum engine that turns a YAML curriculum definition into a deployable SvelteKit learning application.
 Project-URL: Homepage, https://github.com/pointmatic/learningfoundry
 Project-URL: Repository, https://github.com/pointmatic/learningfoundry
@@ -115,20 +115,17 @@ pip install "learningfoundry[quizazz]"
    # OK — curriculum is valid.
    ```
 
-3. **Build** the SvelteKit app:
-
-   ```bash
-   learningfoundry build
-   # Build complete → dist/
-   ```
-
-4. **Preview** locally (builds then starts a dev server):
+3. **Build and preview** locally:
 
    ```bash
    learningfoundry preview
    # Preview server started at http://localhost:5173
    ```
 
+   `learningfoundry preview` is the canonical "see your work" command — it builds the SvelteKit project, installs Node dependencies on first run (and again whenever they change), and starts a Vite dev server. On subsequent runs it skips the install step automatically.
+
+   `learningfoundry build` alone is also available if you want to generate the SvelteKit project without serving it (e.g. to inspect output, deploy a static export via `cd dist && pnpm build`, or wire into your own toolchain).
+
 ---
 
 ## CLI Reference
@@ -198,7 +195,9 @@ Options:
   --help                  Show this message and exit.
 ```
 
-Runs `pnpm install` and `pnpm run dev` in the generated project directory. Requires `pnpm` on `PATH`.
+Runs `learningfoundry build`, then `pnpm install` (skipped when every declared dependency is already present in `node_modules/`), then `pnpm run dev` in the generated project directory. Requires `pnpm` on `PATH`.
+
+This serves the SvelteKit project from source via Vite's dev server; it does **not** serve the static `pnpm build` output in `dist/build/`. For static deploys, use `cd dist && pnpm build` and host the resulting `dist/build/` directory on any static host.
 
 ---
 

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/README.md

@@ -86,20 +86,17 @@ pip install "learningfoundry[quizazz]"
    # OK — curriculum is valid.
    ```
 
-3. **Build** the SvelteKit app:
-
-   ```bash
-   learningfoundry build
-   # Build complete → dist/
-   ```
-
-4. **Preview** locally (builds then starts a dev server):
+3. **Build and preview** locally:
 
    ```bash
    learningfoundry preview
    # Preview server started at http://localhost:5173
    ```
 
+   `learningfoundry preview` is the canonical "see your work" command — it builds the SvelteKit project, installs Node dependencies on first run (and again whenever they change), and starts a Vite dev server. On subsequent runs it skips the install step automatically.
+
+   `learningfoundry build` alone is also available if you want to generate the SvelteKit project without serving it (e.g. to inspect output, deploy a static export via `cd dist && pnpm build`, or wire into your own toolchain).
+
 ---
 
 ## CLI Reference
@@ -169,7 +166,9 @@ Options:
   --help                  Show this message and exit.
 ```
 
-Runs `pnpm install` and `pnpm run dev` in the generated project directory. Requires `pnpm` on `PATH`.
+Runs `learningfoundry build`, then `pnpm install` (skipped when every declared dependency is already present in `node_modules/`), then `pnpm run dev` in the generated project directory. Requires `pnpm` on `PATH`.
+
+This serves the SvelteKit project from source via Vite's dev server; it does **not** serve the static `pnpm build` output in `dist/build/`. For static deploys, use `cd dist && pnpm build` and host the resulting `dist/build/` directory on any static host.
 
 ---
 

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "learningfoundry"
-version = "0.35.0"
+version = "0.36.0"
 description = "A curriculum engine that turns a YAML curriculum definition into a deployable SvelteKit learning application."
 readme = "README.md"
 license = "Apache-2.0"

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/src/learningfoundry/__init__.py

@@ -1,4 +1,4 @@
 # Copyright 2026 Pointmatic
 # SPDX-License-Identifier: Apache-2.0
 
-__version__ = "0.35.0"
+__version__ = "0.36.0"

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/src/learningfoundry/cli.py

@@ -113,21 +113,17 @@ def build(
     from learningfoundry.generator import DepState, check_dep_state
 
     state = check_dep_state(output_dir)
-    if state is DepState.FIRST_BUILD:
-        click.echo("")
-        click.echo(f"Next: cd {output_dir} && pnpm install && pnpm build")
-        click.echo("  (or `pnpm dev` for a live-reloading dev server)")
-    elif state is DepState.CHANGED:
-        click.echo("")
+    click.echo("")
+    if state is DepState.CHANGED:
         click.echo(
             "⚠️  Dependencies changed since last install "
-            "(new packages in package.json)."
+            "(new packages in package.json) — `learningfoundry preview` "
+            "will reinstall."
         )
-        click.echo(f"   Run: cd {output_dir} && pnpm install && pnpm build")
-    else:
-        click.echo("")
-        click.echo(f"Next: cd {output_dir} && pnpm build")
-        click.echo("  (or `pnpm dev` for a live-reloading dev server)")
+    click.echo("Next: learningfoundry preview")
+    click.echo(
+        f"  (or `cd {output_dir} && pnpm build` for a static export to deploy)"
+    )
 
 
 # ---------------------------------------------------------------------------

{learningfoundry-0.35.0 → learningfoundry-0.36.0}/src/learningfoundry/pipeline.py

@@ -133,8 +133,11 @@ def run_preview(
 ) -> None:
     """Build then launch a local preview server.
 
-    Runs ``run_build()``, then ``pnpm install`` and ``pnpm run dev --port``
-    in the generated project directory.
+    Runs ``run_build()``, then ``pnpm install`` (only when needed) and
+    ``pnpm run dev --port`` in the generated project directory. The install
+    step is skipped when ``check_dep_state(output_dir)`` reports
+    ``DepState.UNCHANGED`` — i.e. every dependency declared in the
+    generated ``package.json`` is already present in ``node_modules/``.
 
     Args:
         curriculum_path: Path to the curriculum YAML file.
@@ -150,6 +153,7 @@ def run_preview(
         GenerationError: If build or pnpm commands fail.
     """
     from learningfoundry.exceptions import GenerationError
+    from learningfoundry.generator import DepState, check_dep_state
 
     run_build(
         curriculum_path,
@@ -161,17 +165,21 @@ def run_preview(
         generator=generator,
     )
 
-    logger.info("Installing Node dependencies in %s", output_dir)
-    result = subprocess.run(
-        ["pnpm", "install"],
-        cwd=output_dir,
-        capture_output=True,
-        text=True,
-    )
-    if result.returncode != 0:
-        raise GenerationError(
-            f"`pnpm install` failed in `{output_dir}`:\n{result.stderr}"
+    state = check_dep_state(output_dir)
+    if state is DepState.UNCHANGED:
+        logger.info("Dependencies up to date — skipping pnpm install.")
+    else:
+        logger.info("Installing Node dependencies in %s", output_dir)
+        result = subprocess.run(
+            ["pnpm", "install"],
+            cwd=output_dir,
+            capture_output=True,
+            text=True,
         )
+        if result.returncode != 0:
+            raise GenerationError(
+                f"`pnpm install` failed in `{output_dir}`:\n{result.stderr}"
+            )
 
     logger.info("Starting dev server on port %d", port)
     subprocess.run(