Add clean subcommand to remove stale files from public dir.

Author: yaph

logya/commands.py

@@ -1,12 +1,35 @@
 import shutil
 import sys
 from importlib import resources
+from pathlib import Path
 
 from logya.content import write_collection, write_page
 from logya.core import Logya
 from logya.util import paths
 
 
+def clean(dir_site: str, **kwargs) -> None:
+    L = Logya(dir_site=dir_site, verbose=kwargs.get('verbose'))
+    L.build()
+
+    search_index = L.collection_index.copy()
+    search_index.update(L.doc_index)
+
+    for root, _, files in L.paths.public.walk():
+        for f in files:
+            rel_file = root.relative_to(L.paths.public).joinpath(f)
+            url = '/' + rel_file.as_posix()
+
+            if url in search_index or url.replace('index.html', '') in search_index:
+                continue
+            if L.paths.static.joinpath(rel_file).exists():
+                continue
+
+            stale_file = Path(root, f)
+            L.info(f'Remove: {stale_file} - {url}')
+            stale_file.unlink()
+
+
 def create(dir_site: str, name: str, site: str, **_kwargs) -> None:
     """Create a new site in the specified directory."""
 
@@ -23,10 +46,10 @@ def create(dir_site: str, name: str, site: str, **_kwargs) -> None:
     print(f'Site created in "{target}".')
 
 
-def generate(dir_site: str, verbose: bool, keep: bool, **_kwargs):
+def generate(dir_site: str, keep: bool, **kwargs):
     """Generate a site in the public directory."""
 
-    L = Logya(dir_site=dir_site, verbose=verbose)
+    L = Logya(dir_site=dir_site, verbose=kwargs.get('verbose'))
     L.build()
 
     mtime_templates = None

logya/main.py

@@ -18,6 +18,10 @@ def main():
     parser.add_argument('--version', '-V', action='version', version=__version__)
     subparsers = parser.add_subparsers()
 
+    # clean up public directory
+    p_clean = subparsers.add_parser('clean', parents=[parent], help='Remove stale files and directories from public directory. Use when deploying a site.')
+    p_clean.set_defaults(func=commands.clean)
+
     # create a basic site with the given name
     p_create = subparsers.add_parser(
         'create', parents=[parent], help='Create a starter site in the specified directory.'

pyproject.toml

@@ -54,6 +54,9 @@ path = "logya/__init__.py"
 [tool.hatch.envs.logya-dev]
 extra-dependencies = ["flake8", "ipdb", "mypy>=1.0.0", "pytest"]
 
+[tool.hatch.envs.logya-dev.env-vars]
+PYTHONBREAKPOINT = "ipdb.set_trace"
+
 [tool.hatch.envs.logya-dev.scripts]
 type_check = "mypy --install-types --non-interactive {args:logya tests}"
 qa = [