Merge pull request #216 from yamap55/add/ruff

change linter from flake8 to Ruff

Author: yamap55

.devcontainer/devcontainer.json

@@ -23,8 +23,7 @@
         "python.pythonPath": "/project/.venv/bin/python",
         "python.linting.pylintEnabled": false,
         "python.linting.enabled": true,
-        "python.linting.flake8Enabled": true,
-        "python.linting.flake8Args": ["--config=.flake8"],
+        "python.linting.flake8Enabled": false,
         "python.linting.lintOnSave": true,
         "python.formatting.provider": "black",
         "python.formatting.blackArgs": ["--line-length", "100"],
@@ -35,15 +34,18 @@
         "python.jediEnabled": false,
         "python.languageServer": "Pylance",
         "python.analysis.typeCheckingMode": "basic",
+        "ruff.showNotifications": "always",
         "vsintellicode.python.completionsEnabled": true,
         "vsintellicode.features.python.deepLearning": "enabled",
         "vsintellicode.modify.editor.suggestSelection": "enabled",
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
-          "source.organizeImports": true
+          "source.organizeImports": false,
+          "source.fixAll": true
         },
         "[python]": {
-          "editor.tabSize": 4
+          "editor.tabSize": 4,
+          "editor.formatOnPaste": false
         },
         "[json]": {
           "editor.tabSize": 2
@@ -63,7 +65,8 @@
         "VisualStudioExptTeam.vscodeintellicode",
         "exiasr.hadolint",
         "bungcip.better-toml",
-        "usernamehw.errorlens"
+        "usernamehw.errorlens",
+        "charliermarsh.ruff"
       ]
     }
   },

.flake8

@@ -0,0 +1,6 @@
+runner:
+  ruff:
+    cmd: poetry run ruff check . 2> /dev/null
+    errorformat:
+      - "%f:%l:%c: %m"
+      - "%-G%.%#"

.github/actions/ruff.yml

@@ -0,0 +1,19 @@
+name: ruff
+
+on: [push]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: set up python
+        uses: ./.github/actions/python_setup
+      - name: set up poetry
+        uses: ./.github/actions/poetry_setup
+      - name: Setup reviewdog
+        uses: reviewdog/action-setup@v1.0.3
+      - name: run analyze(use reviewdog)
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: reviewdog -conf=./.github/actions/ruff.yml -reporter=github-check -filter-mode=nofilter -fail-on-error

.github/workflows/flake8.yml

@@ -145,3 +145,6 @@ Thumbs.db
 # log
 *.log.*
 *.log
+
+# ruff
+.ruff_cache

.github/workflows/ruff.yml

@@ -8,7 +8,7 @@ GitHub のリポジトリページの「Use this template」を押下して使
 
 - [devcontainer](https://code.visualstudio.com/docs/remote/containers)
 - lint
-  - [flake8](https://flake8.pycqa.org/en/latest/)
+  - [ruff](https://beta.ruff.rs/docs/)
   - [black](https://black.readthedocs.io/en/stable/)
   - [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance), [pyright](https://github.com/microsoft/pyright)
   - [hadolint](https://github.com/hadolint/hadolint)

.gitignore

@@ -10,11 +10,8 @@ python = "^3.7"
 
 [tool.poetry.dev-dependencies]
 # lint
-flake8 = "5.0.4"
 black = "23.1.0"
-flake8-docstrings = "1.7.0"
-flake8-quotes = "3.3.2"
-flake8-bugbear = "23.3.12"
+ruff = "^0.0.254"
 
 # test
 pytest = "7.2.2"
@@ -29,3 +26,29 @@ addopts = "--verbose --cov --showlocals --durations=5"
 
 [tool.coverage.run]
 omit = ["*/tests/*", "*/site-packages/*"]
+
+[tool.ruff]
+line-length = 100
+select = ["E", "F", "W", "C90", "I", "D", "UP", "B", "Q"]
+# Rules to ignore:
+# D200 One-line docstring should fit on one line with quotes
+# D203 1 blank line required before class docstring
+# D212 Multi-line docstring summary should start at the first line
+# D400 First line should end with a period
+# D401 First line should be in imperative mood
+# D403 First word of the first line should be properly capitalized
+# D413 Missing blank line after last section
+# D415 First line should end with a period, question mark, or exclamation point
+ignore = ["D200", "D203", "D212", "D400", "D401", "D403", "D413", "D415"]
+exclude = ["__init__.py", "work", ".venv", ".git"]
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["D"]
+
+[tool.ruff.mccabe]
+max-complexity = 10
+
+[tool.ruff.flake8-quotes]
+inline-quotes = "double"
+multiline-quotes = "double"
+docstring-quotes = "double"