esys-gitlog 0.1.0__tar.gz → 0.2.0__tar.gz

{esys_gitlog-0.1.0/src/esys_gitlog.egg-info → esys_gitlog-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esys-gitlog
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python implementation of git elog
 Author: Project maintainers
 License-Expression: MIT
@@ -22,7 +22,7 @@ Dynamic: license-file
 
 # esys-gitlog
 
-Python implementation of `git elog`. The distribution name is `esys-gitlog`. The import package is `esys_gitlog`. The installed command is `git-elog`, so Git can run `git elog`.
+Python implementation of `git elog`. The distribution name is `esys-gitlog`. The import package is `esys_gitlog`. Installed commands: `git-elog` (so Git can run `git elog`) and the shorter alias `elog`. Prefer `elog --help` — `git elog --help` is handled by Git's own help path, not the Typer CLI.
 
 The shared contract lives in `esys-gitlog-spec`. This repository carries that contract in Python. It does not define a second one.
 
@@ -30,8 +30,8 @@ The shared contract lives in `esys-gitlog-spec`. This repository carries that co
 
 ```bash
 pip install .
-git elog --help
-git elog --json
+elog --help
+elog --json
 ```
 
 `--json` writes one QA report document to stdout. The first skeleton returns an empty `commits` array.
@@ -52,15 +52,15 @@ Layered tool preferences (user → `.tools/esys/esys-gitlog/` → `.tools_local/
 and named profiles follow root SADR-0009 / SADR-0010 and contract CADR-0012.
 
 ```bash
-git-elog --preferences path.json   # preference overlay
-git-elog --profile acme            # built-in or profiles/acme.json
-git-elog --config path/profile.json  # one-off profile file
-git-elog preferences detect        # probe jira/gh/glab/git remote; write missing user keys
+elog --preferences path.json   # preference overlay
+elog --profile acme            # built-in or profiles/acme.json
+elog --config path/profile.json  # one-off profile file
+elog preferences detect        # probe jira/gh/glab/git remote; write missing user keys
 ```
 
 ## Standalone binary (optional)
 
-The primary install remains the wheel + `git-elog` console script. For a
+The primary install remains the wheel + `git-elog` / `elog` console scripts. For a
 frozen one-file binary (for example Cursor `esysGitlog.executablePath` without
 a Python env on PATH):
 

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/README.md

@@ -1,6 +1,6 @@
 # esys-gitlog
 
-Python implementation of `git elog`. The distribution name is `esys-gitlog`. The import package is `esys_gitlog`. The installed command is `git-elog`, so Git can run `git elog`.
+Python implementation of `git elog`. The distribution name is `esys-gitlog`. The import package is `esys_gitlog`. Installed commands: `git-elog` (so Git can run `git elog`) and the shorter alias `elog`. Prefer `elog --help` — `git elog --help` is handled by Git's own help path, not the Typer CLI.
 
 The shared contract lives in `esys-gitlog-spec`. This repository carries that contract in Python. It does not define a second one.
 
@@ -8,8 +8,8 @@ The shared contract lives in `esys-gitlog-spec`. This repository carries that co
 
 ```bash
 pip install .
-git elog --help
-git elog --json
+elog --help
+elog --json
 ```
 
 `--json` writes one QA report document to stdout. The first skeleton returns an empty `commits` array.
@@ -30,15 +30,15 @@ Layered tool preferences (user → `.tools/esys/esys-gitlog/` → `.tools_local/
 and named profiles follow root SADR-0009 / SADR-0010 and contract CADR-0012.
 
 ```bash
-git-elog --preferences path.json   # preference overlay
-git-elog --profile acme            # built-in or profiles/acme.json
-git-elog --config path/profile.json  # one-off profile file
-git-elog preferences detect        # probe jira/gh/glab/git remote; write missing user keys
+elog --preferences path.json   # preference overlay
+elog --profile acme            # built-in or profiles/acme.json
+elog --config path/profile.json  # one-off profile file
+elog preferences detect        # probe jira/gh/glab/git remote; write missing user keys
 ```
 
 ## Standalone binary (optional)
 
-The primary install remains the wheel + `git-elog` console script. For a
+The primary install remains the wheel + `git-elog` / `elog` console scripts. For a
 frozen one-file binary (for example Cursor `esysGitlog.executablePath` without
 a Python env on PATH):
 

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "esys-gitlog"
-version = "0.1.0"
+version = "0.2.0"
 description = "Python implementation of git elog"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -30,6 +30,7 @@ standalone = [
 
 [project.scripts]
 git-elog = "esys_gitlog.cli:main"
+elog = "esys_gitlog.cli:main"
 
 [tool.setuptools]
 package-dir = { "" = "src" }

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/__init__.py

@@ -1,3 +1,3 @@
 """esys_gitlog — installable package."""
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/cli.py

@@ -1,4 +1,4 @@
-"""Thin Typer command boundary for ``git-elog`` / ``git elog``."""
+"""Thin Typer command boundary for ``git-elog`` / ``elog`` / ``git elog``."""
 
 from __future__ import annotations
 
@@ -316,7 +316,11 @@ def preferences_detect(
 
 def main() -> None:
     """Console script entry point."""
-    app(args=prepare_argv(sys.argv[1:]), prog_name="git-elog")
+    invoked = Path(sys.argv[0]).name
+    if invoked.lower().endswith(".exe"):
+        invoked = invoked[:-4]
+    prog_name = invoked or "git-elog"
+    app(args=prepare_argv(sys.argv[1:]), prog_name=prog_name)
 
 
 if __name__ == "__main__":

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/config.py

@@ -49,9 +49,9 @@ class ProfileRules:
 
     name: str
     conventional: bool = True
-    conventional_locations: tuple[str, ...] = ("title",)
+    conventional_locations: tuple[str, ...] = ("title", "trailer")
     references: bool = True
-    reference_locations: tuple[str, ...] = ("refs",)
+    reference_locations: tuple[str, ...] = ("prefix", "suffix", "refs")
     identifier_family: str = "jira-id"
     signed_off_by: bool = True
     types: tuple[str, ...] = DEFAULT_TYPES
@@ -70,7 +70,7 @@ class AnalysisConfig:
     display: DisplayMode = "subject-precedence"
     preferences: Preferences = field(default_factory=empty_preferences)
     # Human history: fixed-width refs / minimum Type(Scope) columns.
-    ref_id_width: int = 10
+    ref_id_width: int = 14
     type_width: int = 10
     show_author: bool = False
     show_date: bool = False
@@ -87,6 +87,7 @@ def _trailer_profile() -> ProfileRules:
     return ProfileRules(
         name="trailer",
         conventional_locations=("trailer",),
+        reference_locations=("refs",),
     )
 
 
@@ -97,8 +98,14 @@ KNOWN_PROFILES: dict[str, ProfileRules] = {
 
 
 def _profile_from_object(data: dict[str, Any], *, name: str = "custom") -> ProfileRules:
-    conventional_locations = data.get("conventionalLocations", ["title"])
-    reference_locations = data.get("referenceLocations", ["refs"])
+    conventional_locations = data.get(
+        "conventionalLocations",
+        ["title", "trailer"],
+    )
+    reference_locations = data.get(
+        "referenceLocations",
+        ["prefix", "suffix", "refs"],
+    )
     types = data.get("types", list(DEFAULT_TYPES))
     reference_keys = data.get("referenceKeys", ["Refs"])
     # Legacy profile link keys are ignored (CADR-0012); prefer preference files.

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/display.py

@@ -2,17 +2,16 @@
 
 from __future__ import annotations
 
-import re
-
 from esys_gitlog.config import AnalysisConfig
-from esys_gitlog.identifiers import matches_family, ref_identity_key
+from esys_gitlog.identifiers import (
+    matches_family,
+    ref_identity_key,
+    strip_subject_edge_refs,
+)
 from esys_gitlog.interpret import title_pattern
 from esys_gitlog.links import resolve_ref_url
 from esys_gitlog.model import CommitResult, DisplayRef, DisplaySelection
 
-_SUFFIX_REF = re.compile(r"(?:\s+|\[)(?P<token>[A-Za-z][A-Za-z0-9._-]*-\d+)\]?\s*$")
-_PREFIX_REF = re.compile(r"^(?:\[)?(?P<token>[A-Za-z][A-Za-z0-9._-]*-\d+)(?:\])?(?::|\s+)\s*")
-
 
 def _pick_single(
     result: CommitResult,
@@ -38,14 +37,25 @@ def _pick_single(
 def _cleaned_title(subject: str, config: AnalysisConfig) -> str:
     line = subject.splitlines()[0] if subject else ""
     rules = config.profile
+    strip_prefix = rules.references and "prefix" in rules.reference_locations
+    strip_suffix = rules.references and "suffix" in rules.reference_locations
     if rules.conventional and "title" in rules.conventional_locations:
         match = title_pattern(rules.types).fullmatch(line)
         if match is not None:
-            return match.group("description")
-    if rules.references:
-        stripped = _PREFIX_REF.sub("", line, count=1)
-        stripped = _SUFFIX_REF.sub("", stripped)
-        return stripped.strip() or line
+            description = match.group("description")
+            cleaned = strip_subject_edge_refs(
+                description,
+                strip_prefix=strip_prefix,
+                strip_suffix=strip_suffix,
+            )
+            return cleaned or description
+    if rules.references and (strip_prefix or strip_suffix):
+        stripped = strip_subject_edge_refs(
+            line,
+            strip_prefix=strip_prefix,
+            strip_suffix=strip_suffix,
+        )
+        return stripped or line
     return line
 
 

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/identifiers.py

@@ -7,6 +7,11 @@ import re
 # Jira key and the same shape used by YouTrack / Linear.
 _JIRA_KEY = re.compile(r"^[A-Za-z][A-Za-z0-9_]*-\d+$")
 
+# Subject-edge reference tokens (CADR-0005): bare id or optional square brackets.
+# Prefix may use a trailing colon instead of whitespace.
+_SUBJECT_PREFIX_REF = re.compile(r"^(?:\[)?(?P<token>[A-Za-z][A-Za-z0-9_]*-\d+)(?:\])?(?::|\s+)\s*")
+_SUBJECT_SUFFIX_REF = re.compile(r"(?:\s+|\[)(?P<token>[A-Za-z][A-Za-z0-9_]*-\d+)\]?\s*$")
+
 # Shapes from references.md that any-id accepts beyond the Jira key.
 _ANY_EXTRA = (
     re.compile(r"^#\d+$"),
@@ -44,3 +49,28 @@ def matches_family(token: str, family: str) -> bool:
 def ref_identity_key(token: str) -> str:
     """Letter case does not make a different id."""
     return token.casefold()
+
+
+def match_subject_prefix_ref(subject_line: str) -> re.Match[str] | None:
+    """Match a leading subject-edge reference, if any."""
+    return _SUBJECT_PREFIX_REF.match(subject_line)
+
+
+def match_subject_suffix_ref(subject_line: str) -> re.Match[str] | None:
+    """Match a trailing subject-edge reference, if any."""
+    return _SUBJECT_SUFFIX_REF.search(subject_line)
+
+
+def strip_subject_edge_refs(
+    subject_line: str,
+    *,
+    strip_prefix: bool,
+    strip_suffix: bool,
+) -> str:
+    """Remove enabled edge references from a subject (or description) line."""
+    text = subject_line
+    if strip_prefix:
+        text = _SUBJECT_PREFIX_REF.sub("", text, count=1)
+    if strip_suffix:
+        text = _SUBJECT_SUFFIX_REF.sub("", text)
+    return text.strip()

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/interpret.py

@@ -5,11 +5,14 @@ from __future__ import annotations
 import re
 
 from esys_gitlog.config import AnalysisConfig, ProfileRules
-from esys_gitlog.identifiers import matches_family
+from esys_gitlog.identifiers import (
+    match_subject_prefix_ref,
+    match_subject_suffix_ref,
+    matches_family,
+)
 from esys_gitlog.model import Claim, CommitResult
 
 _TRAILER_LINE = re.compile(r"^(?P<key>[A-Za-z0-9][A-Za-z0-9 -]*):\s?(?P<value>.*)$")
-_PREFIX_REF = re.compile(r"^(?P<token>[A-Za-z][A-Za-z0-9._-]*-\d+)\b")
 _BREAKING_KEYS = frozenset({"breaking change", "breaking"})
 
 
@@ -117,6 +120,8 @@ def interpret_commit(subject: str, body: str, config: AnalysisConfig) -> CommitR
 
     if rules.references and "prefix" in rules.reference_locations:
         _interpret_prefix_refs(subject_line, rules, result)
+    if rules.references and "suffix" in rules.reference_locations:
+        _interpret_suffix_refs(subject_line, rules, result)
 
     trailer_type_ok = False
     for key, value, line, column, empty in _parse_trailers(body_lines):
@@ -265,7 +270,7 @@ def _interpret_title(subject_line: str, rules: ProfileRules, result: CommitResul
 
 
 def _interpret_prefix_refs(subject_line: str, rules: ProfileRules, result: CommitResult) -> None:
-    match = _PREFIX_REF.match(subject_line)
+    match = match_subject_prefix_ref(subject_line)
     if match is None:
         return
     token = match.group("token")
@@ -275,7 +280,7 @@ def _interpret_prefix_refs(subject_line: str, rules: ProfileRules, result: Commi
             value=token,
             source="subject",
             line=1,
-            column=1,
+            column=match.start("token") + 1,
             key="prefix",
         )
     )
@@ -283,6 +288,25 @@ def _interpret_prefix_refs(subject_line: str, rules: ProfileRules, result: Commi
         result.references_matched = True
 
 
+def _interpret_suffix_refs(subject_line: str, rules: ProfileRules, result: CommitResult) -> None:
+    match = match_subject_suffix_ref(subject_line)
+    if match is None:
+        return
+    token = match.group("token")
+    result.claims.append(
+        Claim(
+            field="refs",
+            value=token,
+            source="subject",
+            line=1,
+            column=match.start("token") + 1,
+            key="suffix",
+        )
+    )
+    if matches_family(token, rules.identifier_family):
+        result.references_matched = True
+
+
 def _interpret_refs(
     key: str,
     value: str,

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog/preferences.py

@@ -22,7 +22,7 @@ class LinkPreferences:
     commit_link: str | None = None
 
 
-DEFAULT_REF_ID_WIDTH = 10
+DEFAULT_REF_ID_WIDTH = 14
 DEFAULT_TYPE_WIDTH = 10
 
 

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0/src/esys_gitlog.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esys-gitlog
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python implementation of git elog
 Author: Project maintainers
 License-Expression: MIT
@@ -22,7 +22,7 @@ Dynamic: license-file
 
 # esys-gitlog
 
-Python implementation of `git elog`. The distribution name is `esys-gitlog`. The import package is `esys_gitlog`. The installed command is `git-elog`, so Git can run `git elog`.
+Python implementation of `git elog`. The distribution name is `esys-gitlog`. The import package is `esys_gitlog`. Installed commands: `git-elog` (so Git can run `git elog`) and the shorter alias `elog`. Prefer `elog --help` — `git elog --help` is handled by Git's own help path, not the Typer CLI.
 
 The shared contract lives in `esys-gitlog-spec`. This repository carries that contract in Python. It does not define a second one.
 
@@ -30,8 +30,8 @@ The shared contract lives in `esys-gitlog-spec`. This repository carries that co
 
 ```bash
 pip install .
-git elog --help
-git elog --json
+elog --help
+elog --json
 ```
 
 `--json` writes one QA report document to stdout. The first skeleton returns an empty `commits` array.
@@ -52,15 +52,15 @@ Layered tool preferences (user → `.tools/esys/esys-gitlog/` → `.tools_local/
 and named profiles follow root SADR-0009 / SADR-0010 and contract CADR-0012.
 
 ```bash
-git-elog --preferences path.json   # preference overlay
-git-elog --profile acme            # built-in or profiles/acme.json
-git-elog --config path/profile.json  # one-off profile file
-git-elog preferences detect        # probe jira/gh/glab/git remote; write missing user keys
+elog --preferences path.json   # preference overlay
+elog --profile acme            # built-in or profiles/acme.json
+elog --config path/profile.json  # one-off profile file
+elog preferences detect        # probe jira/gh/glab/git remote; write missing user keys
 ```
 
 ## Standalone binary (optional)
 
-The primary install remains the wheel + `git-elog` console script. For a
+The primary install remains the wheel + `git-elog` / `elog` console scripts. For a
 frozen one-file binary (for example Cursor `esysGitlog.executablePath` without
 a Python env on PATH):
 

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/src/esys_gitlog.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
+elog = esys_gitlog.cli:main
 git-elog = esys_gitlog.cli:main

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/tests/test_browser_display.py

@@ -13,7 +13,8 @@ def test_cleaned_title_strips_conventional_prefix() -> None:
     assert result.display.type == "feat"
     assert result.display.scope == "api"
     assert result.display.breaking is True
-    assert result.display.title == "add login PROJ-1"
+    assert result.display.title == "add login"
+    assert [ref.id for ref in result.display.refs] == ["PROJ-1"]
 
 
 def test_display_refs_from_trailer() -> None:

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/tests/test_installed_launcher.py

@@ -19,10 +19,10 @@ def _venv_paths(venv: Path) -> tuple[Path, Path]:
     return venv / "bin" / "python", venv / "bin"
 
 
-def _git_elog_executable(scripts: Path) -> Path:
+def _console_script(scripts: Path, name: str) -> Path:
     if sys.platform == "win32":
-        return scripts / "git-elog.exe"
-    return scripts / "git-elog"
+        return scripts / f"{name}.exe"
+    return scripts / name
 
 
 @pytest.fixture(scope="module")
@@ -45,8 +45,10 @@ def installed_env(
         check=True,
         cwd=elsewhere,
     )
-    launcher = _git_elog_executable(scripts)
-    assert launcher.is_file(), f"missing installed launcher: {launcher}"
+    git_elog = _console_script(scripts, "git-elog")
+    elog = _console_script(scripts, "elog")
+    assert git_elog.is_file(), f"missing installed launcher: {git_elog}"
+    assert elog.is_file(), f"missing installed alias: {elog}"
     # Empty repo so --json is a finished walk with no commits (exit 0).
     subprocess.run(["git", "init"], cwd=elsewhere, check=True, capture_output=True)
     subprocess.run(
@@ -63,13 +65,13 @@ def installed_env(
     )
     env = os.environ.copy()
     env["PATH"] = str(scripts) + os.pathsep + env.get("PATH", "")
-    return elsewhere, launcher, env
+    return elsewhere, git_elog, elog, env
 
 
 def test_git_elog_help_from_outside_source(
-    installed_env: tuple[Path, Path, dict[str, str]],
+    installed_env: tuple[Path, Path, Path, dict[str, str]],
 ) -> None:
-    cwd, launcher, env = installed_env
+    cwd, launcher, _elog, env = installed_env
     completed = subprocess.run(
         [str(launcher), "--help"],
         cwd=cwd,
@@ -82,10 +84,27 @@ def test_git_elog_help_from_outside_source(
     assert "--json" in completed.stdout
 
 
+def test_elog_alias_help_from_outside_source(
+    installed_env: tuple[Path, Path, Path, dict[str, str]],
+) -> None:
+    cwd, _git_elog, elog, env = installed_env
+    completed = subprocess.run(
+        [str(elog), "--help"],
+        cwd=cwd,
+        env=env,
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    assert completed.returncode == 0, completed.stderr
+    assert "--json" in completed.stdout
+    assert "Usage: elog" in completed.stdout
+
+
 def test_git_elog_json_from_outside_source(
-    installed_env: tuple[Path, Path, dict[str, str]],
+    installed_env: tuple[Path, Path, Path, dict[str, str]],
 ) -> None:
-    cwd, launcher, env = installed_env
+    cwd, launcher, _elog, env = installed_env
     completed = subprocess.run(
         [str(launcher), "--json"],
         cwd=cwd,
@@ -102,9 +121,9 @@ def test_git_elog_json_from_outside_source(
 
 
 def test_git_elog_subcommand_when_git_available(
-    installed_env: tuple[Path, Path, dict[str, str]],
+    installed_env: tuple[Path, Path, Path, dict[str, str]],
 ) -> None:
-    cwd, _launcher, env = installed_env
+    cwd, _launcher, _elog, env = installed_env
     git = subprocess.run(
         ["git", "--version"],
         cwd=cwd,

{esys_gitlog-0.1.0 → esys_gitlog-0.2.0}/tests/test_semantic_p4.py

@@ -99,6 +99,32 @@ def test_custom_config_prefix_refs(tmp_path: Path) -> None:
     assert "metadata.profile.partial" in _codes(result)
 
 
+def test_custom_config_suffix_bracket_refs(tmp_path: Path) -> None:
+    path = tmp_path / "profile.json"
+    path.write_text(
+        json.dumps(
+            {
+                "conventional": True,
+                "conventionalLocations": ["title"],
+                "references": True,
+                "referenceLocations": ["suffix", "refs"],
+                "identifierFamily": "jira-id",
+            }
+        ),
+        encoding="utf-8",
+    )
+    result = analyze_commit(
+        "feat: Add a narrated video of the UI panel [PD10020-1284]",
+        "",
+        config_path=path,
+    )
+    assert result.references_matched
+    assert [claim.value for claim in result.claims_for("refs")] == ["PD10020-1284"]
+    assert result.display is not None
+    assert result.display.title == "Add a narrated video of the UI panel"
+    assert [ref.id for ref in result.display.refs] == ["PD10020-1284"]
+
+
 def test_resolve_trailer_default_display() -> None:
     config = resolve_config(profile="trailer")
     assert config.display == "trailer-precedence"