Second steps

Author: DanielNoord

.github/workflows/primer.yaml

@@ -0,0 +1,55 @@
+name: Primer
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  primer-run:
+    name: Run
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code from GitHub
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: pip install -U -r requirements-test.txt
+      - name: Run primer
+        run: python pydocstringformatter/testutils/primer.py
+      - name: Post comment
+        id: post-comment
+        uses: actions/github-script@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('fs')
+            const data = fs.readFileSync('.pydocstringformatter_primer_tests/fulldiff.txt', { encoding: 'utf8' })
+            console.log("Diff from primer:")
+            console.log(data)
+            let body
+            if (data.trim()) {
+              body = 'Diff from the primer, showing the effect of this PR on the pylint source code:\n' + data
+            } else {
+              body = 'According to the primer, this change has no effect on the checked pylint source code. 🤖🎉'
+            }
+            await github.issues.createComment({
+              issue_number: ${{ github.event.pull_request.number }},
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body
+            })
+      - name: Hide old comments
+        # Taken from mypy primer
+        # v0.3.0
+        uses: kanga333/comment-hider@bbdf5b562fbec24e6f60572d8f712017428b92e0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          leave_visible: 1
+          issue_number: ${{ steps.post-comment.outputs.result }}

pydocstringformatter/testutils/primer/primer.py

@@ -0,0 +1,52 @@
+import subprocess
+import sys
+from pathlib import Path
+from typing import List
+
+from pydocstringformatter.testutils.primer.const import PRIMER_DIRECTORY_PATH
+from pydocstringformatter.testutils.primer.packages import PACKAGES
+
+
+def _fix_diff(output: str) -> str:
+    """Make the diff a lil' prettier."""
+    new_output: List[str] = []
+    for index, line in enumerate(output.splitlines()):
+        if line.startswith("--- "):
+            if index:
+                new_output.append("```\n")
+            new_output.append(
+                line.replace(
+                    "--- .pydocstringformatter_primer_tests/PyCQA/pylint/",
+                    "https://github.com/PyCQA/pylint/blob/main/",
+                )
+            )
+            new_output.append("```diff")
+        new_output.append(line)
+
+    return "\n".join(new_output)
+
+
+def _run_primer() -> None:
+    """Run the primer test."""
+    for package in PACKAGES.values():
+        package.lazy_clone()
+
+    for package in PACKAGES.values():
+        # Run the program
+        process = subprocess.run(
+            [sys.executable, "-m", "pydocstringformatter"] + package.paths_to_lint,
+            cwd=Path(__file__).parent.parent.parent,
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+
+    # Write file
+
+    with open(PRIMER_DIRECTORY_PATH / "fulldiff.txt", "w", encoding="utf-8") as file:
+        output = _fix_diff(process.stdout)
+        file.write(output)
+
+
+if __name__ == "__main__":
+    _run_primer()