chore/ci: linter with reviewdog (#625)

* chore/ci: linter with reviewdog

- add separate linter github actions
- add reviewdog installer shell
- update .gitignore fir ./bin folder

* chore: revert condition

Signed-off-by: Hiroshi Miura <miurahr@linux.com>

* chore: control reviewdog with config

- Add .reviewdog.yml
- Update github actions script

---------

Signed-off-by: Hiroshi Miura <miurahr@linux.com>

.github/workflows/run-linter.yml

@@ -0,0 +1,46 @@
+name: Run linter
+
+on:
+  pull_request:
+
+jobs:
+  linter:
+    name: Linter
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          architecture: x64
+      - name: Setup reviewdog
+        run: |
+          /usr/bin/sh utils/reviewdog_install.sh -b ./bin/ v0.20.3
+      - name: Install dependencies
+        run: |
+          pip install -U pip tox wheel setuptools setuptools_scm[toml]
+          pip install .[check]
+      - name: run reviewdog
+        run: |
+          ./bin/reviewdog -runners=flake8,mypy,pylint -reporter=github-pr-check -conf=.reviewdog.yml
+        env:
+          REVIEWDOG_TOKEN: ${{ secrets.REVIEWDOG_TOKEN }}
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  docs:
+    name: Document checks
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          architecture: x64
+      - name: Install dependencies
+        run: |
+          pip install -U pip tox wheel setuptools setuptools_scm[toml]
+      - name: docs build and link check
+        run: |
+          tox -e docs

.github/workflows/run-tox-tests.yml

@@ -11,7 +11,6 @@ on:
       - synchronize
       - reopened
 
-
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -23,7 +22,7 @@ jobs:
             "3.10",
             "3.11",
             "3.12",
-            "3.13-dev", # Not yet released, so we need to use -dev to get the release candidate
+            "3.13",
             "pypy-3.9",
         ]
         include:
@@ -101,7 +100,7 @@ jobs:
           PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
 
   test_slow_tests:
-    name: Test slow test cases
+    name: Test slow cases
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -19,3 +19,5 @@ type_info.json
 coverage.xml
 py7zr/version.py
 prof
+cmake-build-debug
+bin/

.reviewdog.yml

@@ -0,0 +1,19 @@
+runner:
+  flake8:
+    name: flake8
+    cmd: flake8 py7zr tests
+    format: flake8
+    level: error
+
+  mypy:
+    name: mypy
+    cmd: mypy --strict --show-column-numbers -p py7zr
+    errorformat:
+      - "%f:%l:%c: %m"
+    level: error
+
+  pylint:
+    name: pylint
+    cmd: pylint **/*.py -j 0
+    errorformat:
+      - "%f:%l:%c: %t%n: %m"

MANIFEST.in

@@ -26,6 +26,7 @@ recursive-include docs *.pdf
 recursive-include docs *.svg
 recursive-include docs Makefile
 prune .github
+exclude utils/reviewdog_install.sh
 exclude .gitignore
 exclude .readthedocs.yml
 exclude codecov.yml

py7zr/py7zr.py

@@ -74,7 +74,6 @@
 FILE_ATTRIBUTE_UNIX_EXTENSION = 0x8000
 FILE_ATTRIBUTE_WINDOWS_MASK = 0x07FFF
 
-
 class ArchiveFile:
     """Represent each files metadata inside archive file.
     It holds file properties; filename, permissions, and type whether

pyproject.toml

@@ -87,6 +87,7 @@ check = [
       "readme-renderer",
       "twine",
       "black>=24.8.0",
+      "pylint",
 ]
 debug = [
       "pytest",
@@ -169,7 +170,7 @@ markers = [
 legacy_tox_ini = """
 [tox]
 isolated_build = True
-envlist = mypy, check, pypy{39,310}, py{39,310,311,312,313}, py39d, docs, mprof
+envlist = mypy, check, pypy{39,310}, py{39,310,311,312,313}, py39d, docs, mprof, distcheck
 
 [testenv]
 passenv =
@@ -180,8 +181,6 @@ passenv =
 extras = test
 commands =
     python -m pytest -vv
-depends =
-    pypy{39,310},py{39,310,311,312,313}: clean, check
 
 [testenv:py39]
 extras = test, test_compat
@@ -213,12 +212,15 @@ deps =
 
 [testenv:check]
 extras = check
-ignore_errors=true
 commands =
+    check-manifest {toxinidir}
     flake8 py7zr tests
+
+[testenv:distcheck]
+extras = check
+commands =
     python -m build --sdist
     twine check dist/*
-    check-manifest {toxinidir}
 
 [testenv:clean]
 deps = coverage[toml]>=5.2
@@ -240,7 +242,7 @@ commands =
 
 [gh-actions]
 python =
-    3.9: py39, check, docs, mypy
+    3.9: py39
     3.10: py310
     3.11: py311
     3.12: py312