selfdoc 0.4.1__tar.gz → 0.4.2__tar.gz

{selfdoc-0.4.1 → selfdoc-0.4.2}/.gitignore

@@ -38,4 +38,3 @@ docs/_build/
 .env
 .env.local
 *.local-only
-.rlsbl/changes/.validated

selfdoc-0.4.2/.rlsbl/changes/.validated

@@ -0,0 +1 @@
+13feaaa6579b99403184ebbc22dae7a207a0075d

selfdoc-0.4.2/.rlsbl/changes/0.4.2.jsonl

@@ -0,0 +1,7 @@
+{"commits":["c49c0921c49011c8644a6bc7ddd6b71a0f660060"],"user_facing":false}
+{"commits":["c5501cdc68770602dee65bf78614a6cb0262ab55"],"user_facing":false}
+{"commits":["a32257fd22f1531003ec60ee9c4f00cf0a521c9b"],"user_facing":false}
+{"commits":["1928ad226a3657c089941e017025ea49b846574e","bd31871260c794b8069521c1b8282c8648d2ecc1","f62fd7ba0ae9bb6d74e34222e00be481f6f86caf"],"user_facing":false}
+{"commits":["23795ad5b0a0460a9fd800cbaa01b352654bb5d7"],"user_facing":false}
+{"commits":["583c7fcfae40623860c9b3cdcfa32226fe30be3d"],"user_facing":true,"description":"Auto-commit prefers rlsbl commit when available, marking commits with Autogenerated trailer for changelog coverage exemption","type":"feature"}
+{"commits":["6de2021cc4e20bb17450a37412740a76332e701a"],"user_facing":false}

selfdoc-0.4.2/.rlsbl/changes/0.4.2.md

@@ -0,0 +1,5 @@
+## 0.4.2
+
+### Features
+
+- Auto-commit prefers rlsbl commit when available, marking commits with Autogenerated trailer for changelog coverage exemption

selfdoc-0.4.2/.rlsbl/version

@@ -0,0 +1 @@
+0.31.0

selfdoc-0.4.2/.selfdoc/hashes/hashes.json

@@ -0,0 +1,6 @@
+{
+  "index.md": {
+    "content": "bceb3fbd27e158d132823cb8543c6fb4f3bf94d1bbe26a9429b3dec40181218e",
+    "description": "38b00bed9f2aee5284aee36a1e9d04a60a04edd8e8bcc5f17df5aa856544799f"
+  }
+}

{selfdoc-0.4.1 → selfdoc-0.4.2}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 # Changelog
 
+## 0.4.2
+
+### Features
+
+- Auto-commit prefers rlsbl commit when available, marking commits with Autogenerated trailer for changelog coverage exemption
+
 ## 0.4.1
 
 - No user-facing changes.

{selfdoc-0.4.1 → selfdoc-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: selfdoc
-Version: 0.4.1
+Version: 0.4.2
 Summary: Code-aware static site generator with directive-based content extraction
 Project-URL: Repository, https://github.com/smm-h/selfdoc
 Author: smm-h

{selfdoc-0.4.1 → selfdoc-0.4.2}/docs/index.md

@@ -1,3 +1,7 @@
+---
+description: "selfdoc auto-generates API documentation from source code using inline directives. Supports Python, Go, and TypeScript extractors."
+---
+
 # selfdoc
 
 Auto-generate API documentation from source code using inline directives

selfdoc-0.4.2/package-lock.json

@@ -0,0 +1,19 @@
+{
+  "name": "selfdocumenting",
+  "version": "0.4.1",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "selfdocumenting",
+      "version": "0.4.1",
+      "license": "MIT",
+      "bin": {
+        "selfdoc": "bin/cli.js"
+      },
+      "engines": {
+        "node": ">=18"
+      }
+    }
+  }
+}

{selfdoc-0.4.1 → selfdoc-0.4.2}/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selfdocumenting",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Code-aware static site generator with directive-based content extraction",
   "bin": {
     "selfdoc": "bin/cli.js"

{selfdoc-0.4.1 → selfdoc-0.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "selfdoc"
-version = "0.4.1"
+version = "0.4.2"
 description = "Code-aware static site generator with directive-based content extraction"
 license = "MIT"
 authors = [{ name = "smm-h" }]

{selfdoc-0.4.1 → selfdoc-0.4.2}/selfdoc/git.py

@@ -104,8 +104,25 @@ def auto_commit(files: list[str], message: str, cwd: str) -> bool:
     env = os.environ.copy()
     env["SELFDOC_AUTO_COMMIT"] = "1"
 
-    # Try safegit first, fall back to plain git
-    if shutil.which("safegit"):
+    # Try rlsbl first, then safegit, fall back to plain git
+    if shutil.which("rlsbl"):
+        cmd = ["rlsbl", "commit", "-m", message, "--"] + committable
+        try:
+            result = subprocess.run(
+                cmd,
+                cwd=cwd,
+                capture_output=True,
+                env=env,
+                timeout=30,
+            )
+            return result.returncode == 0
+        except (OSError, subprocess.TimeoutExpired) as exc:
+            print(
+                f"selfdoc: auto-commit failed (rlsbl): {exc}",
+                file=sys.stderr,
+            )
+            return False
+    elif shutil.which("safegit"):
         cmd = ["safegit", "commit", "-m", message, "--"] + committable
         try:
             result = subprocess.run(

{selfdoc-0.4.1 → selfdoc-0.4.2}/tests/test_git.py

@@ -101,16 +101,43 @@ def test_auto_commit_loop_guard(tmp_path, monkeypatch):
     assert result is False
 
 
+def test_auto_commit_uses_rlsbl_when_available(tmp_path):
+    """auto_commit calls rlsbl commit when it is on PATH."""
+    _init_git_repo(tmp_path)
+    (tmp_path / "file.txt").write_text("data")
+
+    with mock.patch("shutil.which", return_value="/usr/bin/rlsbl"):
+        with mock.patch("subprocess.run") as mock_run:
+            mock_run.side_effect = [
+                mock.Mock(returncode=0),      # git rev-parse --git-dir
+                mock.Mock(returncode=1),       # git check-ignore (not ignored)
+                mock.Mock(returncode=0, stdout=""),  # git ls-files (untracked)
+                mock.Mock(returncode=0),       # rlsbl commit
+            ]
+
+            result = auto_commit(["file.txt"], "msg", str(tmp_path))
+
+        # Verify rlsbl was called
+        last_call = mock_run.call_args_list[-1]
+        assert last_call[0][0][0] == "rlsbl"
+        assert last_call[0][0][1] == "commit"
+        assert result is True
+
+
 def test_auto_commit_uses_safegit_when_available(tmp_path):
-    """auto_commit calls safegit when it is on PATH."""
+    """auto_commit calls safegit when rlsbl is not available."""
     _init_git_repo(tmp_path)
     (tmp_path / "file.txt").write_text("data")
 
-    with mock.patch("shutil.which", return_value="/usr/bin/safegit"):
+    def which_side_effect(cmd):
+        if cmd == "rlsbl":
+            return None
+        if cmd == "safegit":
+            return "/usr/bin/safegit"
+        return None
+
+    with mock.patch("shutil.which", side_effect=which_side_effect):
         with mock.patch("subprocess.run") as mock_run:
-            # First two calls: git rev-parse, git check-ignore
-            # Then: git ls-files, git diff (for untracked: ls-files returns empty)
-            # Then: safegit commit
             mock_run.side_effect = [
                 mock.Mock(returncode=0),      # git rev-parse --git-dir
                 mock.Mock(returncode=1),       # git check-ignore (not ignored)
@@ -120,14 +147,15 @@ def test_auto_commit_uses_safegit_when_available(tmp_path):
 
             result = auto_commit(["file.txt"], "msg", str(tmp_path))
 
-        # Verify safegit was called
+        # Verify safegit was called (not rlsbl)
         last_call = mock_run.call_args_list[-1]
-        assert "safegit" in last_call[0][0][0]
+        assert last_call[0][0][0] == "safegit"
+        assert last_call[0][0][1] == "commit"
         assert result is True
 
 
 def test_auto_commit_falls_back_to_git(tmp_path):
-    """auto_commit uses plain git when safegit is not available."""
+    """auto_commit uses plain git when neither rlsbl nor safegit is available."""
     _init_git_repo(tmp_path)
     (tmp_path / "file.txt").write_text("data")
 
@@ -143,7 +171,7 @@ def test_auto_commit_falls_back_to_git(tmp_path):
 
             result = auto_commit(["file.txt"], "msg", str(tmp_path))
 
-        # Verify git add and git commit were called (not safegit)
+        # Verify git add and git commit were called (not rlsbl or safegit)
         add_call = mock_run.call_args_list[-2]
         assert add_call[0][0][0] == "git"
         assert add_call[0][0][1] == "add"

selfdoc-0.4.2/todo/generate-claude-readme.md

@@ -0,0 +1,90 @@
+# Generate CLAUDE.md and README.md
+
+## Problem
+
+selfdoc generates full HTML documentation sites, but many projects also need:
+
+- **CLAUDE.md** -- instructions and architecture reference for AI coding agents (Claude Code, Cursor, etc.)
+- **README.md** -- user-facing project overview, setup, and usage
+
+These files currently must be written and maintained by hand, which causes them to drift from the actual codebase. selfdoc already has the machinery to extract structured information from source code (AST parsing, directive resolution, config reading). Extending it to produce these Markdown files would keep them in sync with the codebase automatically.
+
+## Proposed feature
+
+Add optional CLAUDE.md and README.md generation to `selfdoc build` (and possibly a dedicated `selfdoc gen-docs` subcommand).
+
+### Configuration
+
+In `selfdoc.json`:
+
+```json
+{
+  "generate": {
+    "claude_md": true,
+    "readme_md": true
+  }
+}
+```
+
+Both default to `true` (on by default). Set to `false` to opt out.
+
+### CLAUDE.md generation
+
+The generated CLAUDE.md should include:
+
+- Project name, description, and language
+- Directory structure (from `source` paths)
+- Key modules, classes, and functions (from existing AST extractors)
+- Architecture patterns (inferred from import graph, inheritance, protocol usage)
+- Entry points and CLI commands (from existing `code-help` directive machinery)
+- Configuration files and their schema (from existing `table-config` directive)
+- Dependencies and their purpose
+- Any content from `docs/claude.md` template if it exists (allowing projects to add custom sections like constraints, conventions, dangerous operations)
+
+The output should be a single flat Markdown file (no HTML, no directives) suitable for inclusion in `.claude/` or project root.
+
+### README.md generation
+
+The generated README.md should include:
+
+- Project name, description, badges
+- Installation / setup instructions
+- Usage examples (from docstrings, test files, or a `docs/readme.md` template)
+- API overview (from extracted symbols)
+- Configuration reference
+- License
+
+### Template override
+
+Projects can provide `docs/claude.md` and `docs/readme.md` as templates. These would support the same directive syntax as regular selfdoc pages, but the output would be plain Markdown (directives resolved, but no HTML conversion). This lets projects mix auto-extracted content with hand-written sections.
+
+### Monorepo support
+
+For monorepo workspaces (detected by `pyproject.toml` `[tool.uv.workspace]`, `pnpm-workspace.yaml`, or Go `go.work`):
+
+- Generate a root CLAUDE.md and README.md for the workspace
+- Optionally generate per-package CLAUDE.md and README.md if the package has its own `selfdoc.json` or is listed in a workspace-level config
+
+## Affected files
+
+- `selfdoc/config.py` -- new `generate` config fields
+- `selfdoc/build.py` -- hook generation into build pipeline
+- `selfdoc/gen.py` or new `selfdoc/gen_docs.py` -- generation logic
+- `selfdoc/resolver.py` -- Markdown-output mode (resolve directives but skip HTML conversion)
+- `selfdoc/extractors/*.py` -- may need to expose higher-level summaries (not just per-symbol details)
+
+## Effort estimate
+
+Medium-large. The extraction machinery exists; the main work is:
+
+1. Designing the Markdown output format for each section
+2. Adding a "resolve directives to Markdown" mode (currently directives resolve to HTML)
+3. Architecture inference heuristics (import graph analysis, pattern detection)
+4. Monorepo workspace detection and per-package orchestration
+5. Template override support with directive resolution
+
+## Alternatives considered
+
+- **Keep manual**: Works but drifts. Every project with a CLAUDE.md has this problem.
+- **Separate tool**: Could build a standalone `claudegen` tool, but it would duplicate selfdoc's extraction machinery.
+- **AI-based generation**: Use an LLM to read the codebase and generate docs. Nondeterministic, expensive, and hard to keep in sync. selfdoc's deterministic extraction is a better foundation.

selfdoc-0.4.1/.rlsbl/version

@@ -1 +0,0 @@
-0.27.0

selfdoc-0.4.1/.selfdoc/hashes/hashes.json

@@ -1 +0,0 @@
-{}