convert linting to pre-commit & Ruff (#43)

* convert linting to pre-commit & Ruff

* apply linter

* manual

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the bug**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,11 +4,10 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\]
 
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.

.github/workflows/unittest.yml

@@ -6,11 +6,7 @@ on:
   - workflow_call
 
 jobs:
-  lint:
-    uses: ./.github/workflows/linter.yml
-
   test:
-    needs: [lint]
     name: Test on ${{ matrix.os }}, ${{ matrix.install_from }}
     runs-on: ${{ matrix.os }}
     strategy:
@@ -37,4 +33,4 @@ jobs:
           pip install "${source_file}[tests]"
 
       - name: Run test cases
-        run: cd tests && pytest --cov=faster_coco_eval .
+        run: cd tests && pytest --cov=faster_coco_eval .

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+# Copyright The Lightning team.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+default_language_version:
+  python: python3
+
+ci:
+  autofix_prs: true
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit suggestions"
+  autoupdate_schedule: quarterly
+  # submodules: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      # - id: check-json # skip for incompatibility with .devcontainer/devcontainer.json
+      - id: check-yaml
+      - id: check-toml
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-case-conflict
+      # - id: check-added-large-files
+      #   args: ["--maxkb=100", "--enforce-all"]
+      - id: detect-private-key
+
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: ["--in-place"]
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.17
+    hooks:
+      - id: mdformat
+        args: ["--number"]
+        additional_dependencies:
+          - mdformat-gfm
+          - mdformat-black
+          - mdformat_frontmatter
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.0
+    hooks:
+      # try to fix what is possible
+      - id: ruff
+        args: ["--fix"]
+      # perform formatting updates
+      - id: ruff-format
+      # validate if all is fine with preview mode
+      - id: ruff

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -121,8 +121,8 @@ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
-
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
 https://www.contributor-covenant.org/translations.
+
+[homepage]: https://www.contributor-covenant.org

MANIFEST.in

@@ -1 +1 @@
-graft csrc
+graft csrc

Makefile

@@ -9,27 +9,21 @@ sdist:
 
 whl_file = $(shell ls dist/*.whl)
 
-install: clean wheel 
+install: clean wheel
 	pip3 install "$(whl_file)[tests]"
 
 FORMAT_DIRS = ./faster_coco_eval ./tests setup.py
 LINE_LENGTH = 80
 BLACK_CONFIG = --preview --enable-unstable-feature string_processing
 
 format:
-	python3 -m docformatter --in-place --recursive --blank $(FORMAT_DIRS)
-	python3 -m black $(BLACK_CONFIG) --line-length $(LINE_LENGTH) $(FORMAT_DIRS)
-	python3 -m isort --line-length $(LINE_LENGTH) --profile black $(FORMAT_DIRS)
-	$(MAKE) linter
+	pre-commit run --all-files
 
 linter:
-	python3 -m docformatter --check --recursive --blank $(FORMAT_DIRS)
-	python3 -m black $(BLACK_CONFIG) --line-length $(LINE_LENGTH) $(FORMAT_DIRS) --check --diff
-	python3 -m isort --line-length $(LINE_LENGTH) --profile black $(FORMAT_DIRS) --check --diff
-	flake8 --max-line-length $(LINE_LENGTH) $(FORMAT_DIRS) --ignore=E203,W503 --exclude "*/model/*"
+	pre-commit check --all-files
 
 clean:
 	rm -rf build
 	rm -rf *.egg-info
 	rm -rf dist
-	pip3 uninstall faster-coco-eval -y
+	pip3 uninstall faster-coco-eval -y