sloplint 0.1.0__tar.gz

sloplint-0.1.0/.github/workflows/deploy.yml

@@ -0,0 +1,44 @@
+name: Deploy
+on:
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build Site
+        run: make
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '.'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

sloplint-0.1.0/.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+name: Lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v5
+      - run: make lint

sloplint-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,24 @@
+name: PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  PyPI:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish

sloplint-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  Release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.tar.gz
+            dist/*.whl

sloplint-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,15 @@
+name: Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v5
+      - run: make test

sloplint-0.1.0/.gitignore

@@ -0,0 +1,2 @@
+uv.lock
+**/__pycache__

sloplint-0.1.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: sloplint
+Version: 0.1.0
+Summary: A linter to detect AI-generated markdown prose
+Author-email: Jon Craton <jncraton@gmail.com>
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# sloplint
+
+A linter to detect AI-generated markdown prose
+
+## Installation
+
+```sh
+pip install sloplint
+```
+
+## Usage
+
+```sh
+sloplint myfile.md
+```
+
+Or run without installation as:
+
+```sh
+uxv sloplint readme.md
+```
+
+If AI-generated text issues are identified, sloplint will exit with a failure code reporting each issue it discovered just like a linter would.
+
+## Triggers
+
+- em-dash
+- emojis
+- bold text

sloplint-0.1.0/makefile

@@ -0,0 +1,13 @@
+all: test
+
+lint:
+	uv run --with black==24.1.0 python -m black --check sloplint tests
+
+format:
+	uv run --with black==24.1.0 python -m black sloplint tests
+
+test:
+	uv run --with pytest==7.4.0 python -m pytest
+
+clean:
+	rm -rf .pytest_cache **/__pycache__ build dist *.egg-info

sloplint-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sloplint"
+version = "0.1.0"
+description = "A linter to detect AI-generated markdown prose"
+readme = "readme.md"
+authors = [
+    { name = "Jon Craton", email = "jncraton@gmail.com" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.10"
+dependencies = []
+
+[project.scripts]
+sloplint = "sloplint.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["sloplint"]

sloplint-0.1.0/readme.md

@@ -0,0 +1,29 @@
+# sloplint
+
+A linter to detect AI-generated markdown prose
+
+## Installation
+
+```sh
+pip install sloplint
+```
+
+## Usage
+
+```sh
+sloplint myfile.md
+```
+
+Or run without installation as:
+
+```sh
+uxv sloplint readme.md
+```
+
+If AI-generated text issues are identified, sloplint will exit with a failure code reporting each issue it discovered just like a linter would.
+
+## Triggers
+
+- em-dash
+- emojis
+- bold text

sloplint-0.1.0/sloplint/__init__.py

@@ -0,0 +1,3 @@
+from .lint import find_markdown_issues
+
+__all__ = ["find_markdown_issues"]

sloplint-0.1.0/sloplint/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

sloplint-0.1.0/sloplint/cli.py

@@ -0,0 +1,43 @@
+import argparse
+from pathlib import Path
+from typing import Sequence
+
+from .lint import find_markdown_issues
+
+
+def _parse_args(args: Sequence[str] | None = None) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        prog="sloplint",
+        description="A linter to detect AI-generated markdown prose",
+    )
+    parser.add_argument("paths", nargs="+", help="Markdown file paths to lint")
+    return parser.parse_args(args)
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    args = _parse_args(argv)
+    messages: list[str] = []
+
+    for path_text in args.paths:
+        path = Path(path_text)
+        if not path.exists():
+            print(f"{path}: file not found")
+            return 2
+        if not path.is_file():
+            print(f"{path}: not a file")
+            return 2
+
+        content = path.read_text(encoding="utf-8")
+        issues = find_markdown_issues(content)
+        for issue in issues:
+            messages.append(f"{path}:{issue}")
+
+    if messages:
+        print("\n".join(messages))
+        return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

sloplint-0.1.0/sloplint/lint.py

@@ -0,0 +1,35 @@
+import re
+from typing import Iterable
+
+EM_DASH_RE = re.compile(r"—")
+BOLD_RE = re.compile(r"(?:\*\*[^*\n]+\*\*|__[^_\n]+__)")
+EMOJI_RE = re.compile(
+    r"["
+    r"\U0001F300-\U0001F5FF"
+    r"\U0001F600-\U0001F64F"
+    r"\U0001F680-\U0001F6FF"
+    r"\U0001F700-\U0001F77F"
+    r"\U0001F780-\U0001F7FF"
+    r"\U0001F800-\U0001F8FF"
+    r"\U0001F900-\U0001F9FF"
+    r"\U0001FA00-\U0001FA6F"
+    r"\U0001FA70-\U0001FAFF"
+    r"\u2600-\u26FF"
+    r"\u2700-\u27BF"
+    r"]"
+)
+
+
+def find_markdown_issues(content: str) -> list[str]:
+    """Return a list of markdown issues detected in the content."""
+    issues: list[str] = []
+
+    for line_number, line in enumerate(content.splitlines(), start=1):
+        if EM_DASH_RE.search(line):
+            issues.append(f"{line_number}: em-dash detected")
+        if EMOJI_RE.search(line):
+            issues.append(f"{line_number}: emoji detected")
+        if BOLD_RE.search(line):
+            issues.append(f"{line_number}: bold markdown detected")
+
+    return issues

sloplint-0.1.0/tests/test_sloplint.py

@@ -0,0 +1,41 @@
+from sloplint.cli import main
+from sloplint.lint import find_markdown_issues
+
+
+def test_find_markdown_issues():
+    content = "First line — with em dash\nSecond line **bold**\nThird line 😊\n"
+    issues = find_markdown_issues(content)
+
+    assert "1: em-dash detected" in issues
+    assert "2: bold markdown detected" in issues
+    assert "3: emoji detected" in issues
+
+
+def test_main_returns_non_zero_for_issues(tmp_path, capsys):
+    path = tmp_path / "sample.md"
+    path.write_text("This is **bold**\n", encoding="utf-8")
+
+    exit_code = main([str(path)])
+    captured = capsys.readouterr()
+
+    assert exit_code == 1
+    assert f"{path}:1: bold markdown detected" in captured.out
+
+
+def test_main_returns_zero_for_clean_file(tmp_path):
+    path = tmp_path / "clean.md"
+    path.write_text("This is plain markdown\n", encoding="utf-8")
+
+    exit_code = main([str(path)])
+
+    assert exit_code == 0
+
+
+def test_main_reports_missing_file(tmp_path, capsys):
+    path = tmp_path / "missing.md"
+
+    exit_code = main([str(path)])
+    captured = capsys.readouterr()
+
+    assert exit_code == 2
+    assert "file not found" in captured.out