gitlint-rai 0.0.0__tar.gz

gitlint_rai-0.0.0/LICENSE

@@ -0,0 +1,30 @@
+Polyform Shield License 1.0.0
+
+Copyright (c) 2025 ChecKMarK DevTools / Ashley Childress
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to use,
+copy, modify, and/or distribute the Software for any purpose—including personal, professional, or commercial use—subject to the following conditions:
+
+1. **No Profit or Monetization.**
+   The Software may not be sold, rebranded, licensed, hosted as a paid SaaS, or used as the basis of any product or service from which you or your organization earns revenue or profit, without explicit written permission from Ashley Childress.
+
+   - **You CAN** use, copy, fork, or adapt this for your own workflows, inside your company, for client projects, demos, education, or anything else—as long as you’re not selling the code, charging for it, or making money from the project itself.
+   - **You CANNOT** resell, offer as a paid service, or monetize this project or its derivatives without prior written approval.
+
+2. **Endorsement.**
+   Neither the name of ChecKMarK DevTools / Ashley Childress nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+3. **Attribution.**
+   Any public fork, copy, or substantial reuse must include this LICENSE and a clear statement in your documentation or README:
+   “Based on original work by ChecKMarK DevTools / Ashley Childress – see \[original repo link\].”
+
+4. **No Warranty.**
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+Full license text: https://polyformproject.org/licenses/shield/1.0.0/
+
+---
+
+This project is licensed under Polyform Shield License 1.0.0.
+For exceptions or monetization/commercialization questions, contact Ashley Childress at [human@checkmarkdevtools.dev](mailto:human@checkmarkdevtools.dev).

gitlint_rai-0.0.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: gitlint-rai
+Version: 0.0.0
+Summary: Gitlint plugin for RAI footer validation
+Author-email: Ashley Childress <human@checkmarkdevtools.dev>
+License-Expression: LicenseRef-PolyForm-Shield-1.0.0
+Project-URL: Homepage, https://github.com/ChecKMarKDevTools/rai-lint
+Project-URL: Repository, https://github.com/ChecKMarKDevTools/rai-lint
+Project-URL: Issues, https://github.com/ChecKMarKDevTools/rai-lint/issues
+Keywords: gitlint,rai,ai-attribution,commit-validation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>=3.11
+License-File: LICENSE
+Requires-Dist: gitlint>=0.19.1
+Dynamic: license-file

gitlint_rai-0.0.0/README.md

@@ -0,0 +1,67 @@
+# gitlint-rai
+
+Gitlint plugin for enforcing AI attribution in commit messages using Git commit message trailers.
+
+## Installation
+
+```bash
+pip install gitlint-rai
+```
+
+or with uv:
+
+```bash
+uv add gitlint-rai
+```
+
+## Usage
+
+Add to `.gitlint`:
+
+```ini
+[general]
+extra-path=gitlint_rai
+```
+
+Then run:
+
+```bash
+gitlint
+```
+
+Or use the standalone wrapper:
+
+```bash
+gitlint-rai
+```
+
+Verify the rule loaded:
+
+```bash
+gitlint --list-rules | grep rai-footer-exists
+```
+
+Expected output:
+
+```
+rai-footer-exists  Commit message must include a valid RAI footer
+```
+
+## Valid Footer Formats
+
+1. **`Authored-by: [Human] <email>`** - Human only, no AI involvement
+2. **`Commit-generated-by: [AI Tool] <email>`** - Trivial AI (docs, commit msg, reviews, advice, etc)
+3. **`Assisted-by: [AI Tool] <email>`** - AI helped, but primarily human code
+4. **`Co-authored-by: [AI Tool] <email>`** - Roughly half is AI generated and half human-authored content
+5. **`Generated-by: [AI Tool] <email>`** - Majority of code was AI generated
+
+All patterns are case-insensitive.
+
+## Requirements
+
+- Python >= 3.11, < 3.13
+- gitlint >= 0.19.1
+
+## License
+
+PolyForm Shield License 1.0.0

gitlint_rai-0.0.0/gitlint_rai/__init__.py

@@ -0,0 +1,3 @@
+from gitlint_rai.rules import RaiFooterExists
+
+__all__ = ["RaiFooterExists"]

gitlint_rai-0.0.0/gitlint_rai/__main__.py

@@ -0,0 +1,14 @@
+import sys
+
+from gitlint.cli import cli
+
+
+def main():
+    if "--extra-path" not in sys.argv:
+        sys.argv.insert(1, "--extra-path")
+        sys.argv.insert(2, "gitlint_rai")
+    sys.exit(cli())
+
+
+if __name__ == "__main__":
+    main()

gitlint_rai-0.0.0/gitlint_rai/rules.py

@@ -0,0 +1,80 @@
+import re
+
+from gitlint.rules import CommitRule, RuleViolation
+
+
+class RaiFooterExists(CommitRule):
+    name = "rai-footer-exists"
+    id = "UC1"
+    target = "commit"
+
+    AI_ATTRIBUTION_KEYS = {
+        "Authored-by",
+        "Commit-generated-by",
+        "Assisted-by",
+        "Co-authored-by",
+        "Generated-by",
+    }
+
+    AI_ATTRIBUTION_VALUE_PATTERN = re.compile(r"^[^<]+ <[^>]+>$")
+    TRAILER_PATTERN = re.compile(r"^([A-Za-z][\w-]*)\s*:\s*(.+)$")
+
+    def _parse_trailers(self, message_body):
+        if not message_body:
+            return {}
+
+        lines = message_body if isinstance(message_body, list) else message_body.split("\n")
+        trailers = {}
+        in_trailer_block = False
+        trailer_lines = []
+
+        for i in range(len(lines) - 1, -1, -1):
+            line = lines[i].strip()
+            if not line:
+                if in_trailer_block:
+                    break
+                continue
+
+            match = self.TRAILER_PATTERN.match(line)
+            if match:
+                in_trailer_block = True
+                trailer_lines.insert(0, (match.group(1), match.group(2)))
+            elif in_trailer_block:
+                break
+
+        for key, value in trailer_lines:
+            normalized_key = key.lower()
+            if normalized_key not in trailers:
+                trailers[normalized_key] = []
+            trailers[normalized_key].append(value.strip())
+
+        return trailers
+
+    def validate(self, commit):
+        trailers = self._parse_trailers(commit.message.body)
+
+        for key in self.AI_ATTRIBUTION_KEYS:
+            normalized_key = key.lower()
+            if normalized_key in trailers:
+                for value in trailers[normalized_key]:
+                    if self.AI_ATTRIBUTION_VALUE_PATTERN.match(value):
+                        return []
+
+        return [
+            RuleViolation(
+                self.id,
+                "Commit message must include AI attribution footer:\n"
+                '  1. "Authored-by: [Human] <contact>" - Human only, no AI\n'
+                '  2. "Commit-generated-by: [AI Tool] <contact>" - Trivial AI (docs, commit msg, advice)\n'
+                '  3. "Assisted-by: [AI Tool] <contact>" - AI helped, but primarily human code\n'
+                '  4. "Co-authored-by: [AI Tool] <contact>" - Roughly 50/50 AI and human (40-60 leeway)\n'
+                '  5. "Generated-by: [AI Tool] <contact>" - Majority of code was AI generated\n'
+                "\n"
+                "Examples:\n"
+                '  - "Authored-by: Jane Doe <jane@example.com>"\n'
+                '  - "Commit-generated-by: ChatGPT <chatgpt@openai.com>"\n'
+                '  - "Assisted-by: GitHub Copilot <copilot@github.com>"\n'
+                '  - "Co-authored-by: Verdent AI <verdent@verdent.ai>"\n'
+                '  - "Generated-by: GitHub Copilot <copilot@github.com>"',
+            )
+        ]

gitlint_rai-0.0.0/gitlint_rai.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: gitlint-rai
+Version: 0.0.0
+Summary: Gitlint plugin for RAI footer validation
+Author-email: Ashley Childress <human@checkmarkdevtools.dev>
+License-Expression: LicenseRef-PolyForm-Shield-1.0.0
+Project-URL: Homepage, https://github.com/ChecKMarKDevTools/rai-lint
+Project-URL: Repository, https://github.com/ChecKMarKDevTools/rai-lint
+Project-URL: Issues, https://github.com/ChecKMarKDevTools/rai-lint/issues
+Keywords: gitlint,rai,ai-attribution,commit-validation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>=3.11
+License-File: LICENSE
+Requires-Dist: gitlint>=0.19.1
+Dynamic: license-file

gitlint_rai-0.0.0/gitlint_rai.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+gitlint_rai/__init__.py
+gitlint_rai/__main__.py
+gitlint_rai/rules.py
+gitlint_rai.egg-info/PKG-INFO
+gitlint_rai.egg-info/SOURCES.txt
+gitlint_rai.egg-info/dependency_links.txt
+gitlint_rai.egg-info/entry_points.txt
+gitlint_rai.egg-info/requires.txt
+gitlint_rai.egg-info/top_level.txt
+tests/test_integration.py
+tests/test_rules.py

gitlint_rai-0.0.0/gitlint_rai.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gitlint_rai-0.0.0/gitlint_rai.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+gitlint-rai = gitlint_rai.__main__:main
+
+[gitlint.plugins]
+rai-footer-exists = gitlint_rai.rules:RaiFooterExists

gitlint_rai-0.0.0/gitlint_rai.egg-info/requires.txt

@@ -0,0 +1 @@
+gitlint>=0.19.1

gitlint_rai-0.0.0/gitlint_rai.egg-info/top_level.txt

@@ -0,0 +1 @@
+gitlint_rai

gitlint_rai-0.0.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["setuptools>=80.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gitlint-rai"
+version = "0.0.0"
+authors = [
+  { name="Ashley Childress", email="human@checkmarkdevtools.dev" },
+]
+description = "Gitlint plugin for RAI footer validation"
+requires-python = ">=3.11,<3.13"
+keywords = ["gitlint", "rai", "ai-attribution", "commit-validation"]
+dependencies = ["gitlint>=0.19.1"]
+license = "LicenseRef-PolyForm-Shield-1.0.0"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Version Control :: Git",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/ChecKMarKDevTools/rai-lint"
+Repository = "https://github.com/ChecKMarKDevTools/rai-lint"
+Issues = "https://github.com/ChecKMarKDevTools/rai-lint/issues"
+
+[project.optional-dependencies]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.0",
+    "pytest-cov>=4.0.0",
+    "black>=25.9.0",
+    "isort>=7.0.0",
+    "coverage>=7.0.0",
+    "build>=0.10.0",
+    "wheel",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["gitlint_rai*"]
+
+[project.entry-points."gitlint.plugins"]
+rai-footer-exists = "gitlint_rai.rules:RaiFooterExists"
+
+[project.scripts]
+gitlint-rai = "gitlint_rai.__main__:main"
+
+[tool.coverage.run]
+source = ["gitlint_rai"]
+omit = [
+    "tests/*",
+    "*/test_*",
+    "*/__pycache__/*",
+    ".venv/*",
+    "venv/*",
+    "gitlint_rai/__main__.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == '__main__':",
+]
+show_missing = true
+precision = 2
+fail_under = 80
+
+[tool.coverage.xml]
+output = "reports/coverage.xml"
+
+[tool.pytest.ini_options]
+addopts = "--junitxml=reports/junit-py.xml"
+testpaths = ["tests"]
+
+[tool.black]
+line-length = 100
+target-version = ['py311', 'py312']
+
+[tool.isort]
+profile = "black"
+line_length = 100

gitlint_rai-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gitlint_rai-0.0.0/tests/test_integration.py

@@ -0,0 +1,66 @@
+from unittest.mock import Mock
+
+from gitlint_rai.rules import RaiFooterExists
+
+
+def create_commit(message: str):
+    commit = Mock()
+    commit.message.full = message
+
+    lines = message.split("\n")
+    commit.message.title = lines[0] if lines else ""
+    commit.message.body = lines[1:] if len(lines) > 1 else []
+
+    return commit
+
+
+def test_valid_generated_by():
+    rule = RaiFooterExists()
+    commit = create_commit("feat: add feature\n\nGenerated-by: GitHub Copilot <copilot@github.com>")
+    violations = rule.validate(commit)
+    assert len(violations) == 0, f"Expected no violations but got: {violations}"
+
+
+def test_valid_assisted_by():
+    rule = RaiFooterExists()
+    commit = create_commit("fix: resolve bug\n\nAssisted-by: Verdent AI <verdent@verdent.ai>")
+    violations = rule.validate(commit)
+    assert len(violations) == 0
+
+
+def test_valid_verdent_ai():
+    rule = RaiFooterExists()
+    commit = create_commit("chore: update\n\nGenerated-by: Verdent AI <verdent@verdent.ai>")
+    violations = rule.validate(commit)
+    assert len(violations) == 0
+
+
+def test_invalid_no_footer():
+    rule = RaiFooterExists()
+    commit = create_commit("feat: add feature\n\nNo footer")
+    violations = rule.validate(commit)
+    assert len(violations) == 1
+    assert "AI attribution" in violations[0].message
+
+
+def test_invalid_malformed():
+    rule = RaiFooterExists()
+    commit = create_commit("feat: add feature\n\nGenerated-by: Invalid Format")
+    violations = rule.validate(commit)
+    assert len(violations) == 1
+
+
+def test_case_insensitive():
+    rule = RaiFooterExists()
+    commit = create_commit("feat: add feature\n\ngenerated-by: GitHub Copilot <copilot@github.com>")
+    violations = rule.validate(commit)
+    assert len(violations) == 0
+
+
+def test_with_additional_footers():
+    rule = RaiFooterExists()
+    commit = create_commit(
+        "feat: add feature\n\nDescription\n\nCloses #123\n\nAssisted-by: GitHub Copilot <copilot@github.com>"
+    )
+    violations = rule.validate(commit)
+    assert len(violations) == 0

gitlint_rai-0.0.0/tests/test_rules.py

@@ -0,0 +1,105 @@
+from unittest.mock import Mock
+
+import pytest
+
+from gitlint_rai.rules import RaiFooterExists
+
+
+def create_commit(message: str):
+    commit = Mock()
+    commit.message.full = message
+
+    lines = message.split("\n")
+    commit.message.title = lines[0] if lines else ""
+    commit.message.body = lines[1:] if len(lines) > 1 else []
+
+    return commit
+
+
+class TestRaiFooterExists:
+    def test_generated_by_footer(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "feat: add new feature\n\nGenerated-by: GitHub Copilot <copilot@github.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_generated_by_footer_no_email(self):
+        rule = RaiFooterExists()
+        commit = create_commit("feat: add new feature\n\nGenerated-by: GitHub Copilot")
+        violations = rule.validate(commit)
+        assert len(violations) == 1
+
+    def test_assisted_by_footer(self):
+        rule = RaiFooterExists()
+        commit = create_commit("fix: resolve bug\n\nAssisted-by: Verdent AI <verdent@verdent.ai>")
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_co_authored_by_footer(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "refactor: improve code\n\nCo-authored-by: GitHub Copilot <copilot@github.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_commit_generated_by_footer(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "chore: update dependencies\n\nCommit-generated-by: Claude AI <claude@anthropic.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_authored_by_footer(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "feat: implement feature\n\nAuthored-by: Jane Doe <jane@example.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_missing_ai_attribution(self):
+        rule = RaiFooterExists()
+        commit = create_commit("feat: add new feature\n\nSome other footer")
+        violations = rule.validate(commit)
+        assert len(violations) == 1
+        assert "AI attribution" in violations[0].message
+
+    def test_case_insensitive_footer(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "feat: add feature\n\ngenerated-by: GitHub Copilot <copilot@github.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_malformed_footer(self):
+        # With the new rule, almost any non-empty string is valid if the key is correct.
+        # So "Generated-by: Invalid Format" is actually valid now as "Invalid Format" is a name.
+        # We should test for empty value if that's possible, or just remove this test if any string is valid.
+        # Let's assume empty value is invalid.
+        rule = RaiFooterExists()
+        commit = create_commit("feat: add feature\n\nGenerated-by: ")
+        # The simple parser might parse empty string.
+        # If regex is ^.+$ then empty string fails.
+        violations = rule.validate(commit)
+        assert len(violations) == 1
+
+    def test_multiple_ai_tools(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "feat: complex feature\n\nGenerated-by: ChatGPT <chatgpt@openai.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0
+
+    def test_guidance_percentages(self):
+        rule = RaiFooterExists()
+        commit = create_commit(
+            "feat: add feature\n\nAssisted-by: GitHub Copilot <copilot@github.com>"
+        )
+        violations = rule.validate(commit)
+        assert len(violations) == 0