fix: add lint and typing check

Author: liningping

.github/workflows/validate.yaml

@@ -1,8 +1,11 @@
-name: Validate
+---
+name: validate
 
 on:
   push:
+    branches: [main]
   pull_request:
+    branches: [main]
 
 env:
   PIP_DISABLE_PIP_VERSION_CHECK: true
@@ -11,57 +14,50 @@ env:
   PIP_ROOT_USER_ACTION: ignore
 
 jobs:
-  create-venv:
+  lint-yaml:
+    name: lint workflow yaml
     runs-on: ubuntu-latest
-    name: Setup Python + uv
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run yamllint
+        uses: karancode/yamllint-github-action@master
+        with:
+          yamllint_file_or_dir: .github/workflows
+
+  validate-and-lint:
+    name: Validate and Run Linters
+    runs-on: ubuntu-latest
+    needs: [lint-yaml]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.12
+      - name: set up python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: '3.12'
 
-      - name: Install uv and dependencies
-        run: |
-          pip install uv
-          uv venv
-          uv pip install --group bandit --group mypy --group ruff --group secret
-        env:
-          PIP_INDEX_URL: ${{ env.PIP_INDEX_URL }}
+      - name: set up uv
+        uses: astral-sh/setup-uv@v4
 
-      - name: Save env variable
-        run: echo "PYPI_MIRROR=${{ env.PIP_INDEX_URL }}" >> $GITHUB_ENV
+      - name: create virtual enviroment
+        run: uv venv
 
-  bandit:
-    runs-on: ubuntu-latest
-    needs: create-venv
-    steps:
-      - uses: actions/checkout@v4
-      - name: Run bandit
-        run: .venv/bin/bandit -c pyproject.toml -r .
+      - name: Install dependencies
+        run: uv sync --group dev --group lint --group security --group typing
+
+      - name: Run Bandit
+        run: uv run bandit -c pyproject.toml -r .
 
-  mypy:
-    runs-on: ubuntu-latest
-    needs: create-venv
-    steps:
-      - uses: actions/checkout@v4
       - name: Run mypy
-        run: .venv/bin/mypy .
+        run: uv run mypy .
 
-  ruff:
-    runs-on: ubuntu-latest
-    needs: create-venv
-    steps:
-      - uses: actions/checkout@v4
       - name: Run ruff
-        run: .venv/bin/ruff check .
+        run: uv run ruff check .
 
-  secrets:
-    runs-on: ubuntu-latest
-    needs: create-venv
-    steps:
-      - uses: actions/checkout@v4
       - name: Run detect-secrets
-        run: .venv/bin/detect-secrets-hook --baseline .secrets.baseline
+        run: |
+          FILES_TO_SCAN=$(git ls-files -z | xargs -0)
+          uv run detect-secrets-hook \
+            --baseline .secrets.baseline \
+            "${FILES_TO_SCAN}"

main.py

@@ -1,4 +1,4 @@
-def main():
+def main() -> None:
     print("Hello from mmdocparser!")
 
 

pyproject.toml

@@ -5,3 +5,66 @@ description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = []
+
+
+[dependency-groups]
+all-dev = [
+    {include-group = "dev"},
+    {include-group = "lint"},
+    {include-group = "security"},
+    {include-group = "typing"}
+]
+dev = [
+    "pytest>=8.4.1",
+    "pytest-cov>=6.2.1",
+]
+lint = [
+    "bandit>=1.8.6",
+    "ruff>=0.12.7",
+]
+security = [
+    "detect-secrets>=1.5.0",
+]
+typing = [
+    "mypy>=1.17.1",
+]
+
+[tool.bandit]
+exclude_dirs = [".venv", ".git", ".mypy_cache"]
+skips = ["B101", "B601"]
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "C901",  # too complex
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]