ondivi

Ondivi（違反のみ）

これは、GITリポジトリで変更された行のみについて、コーディング違反（おそらく静的アナライザーによって識別される可能性が高い）をフィルタリングするように設計された単純なPythonスクリプトです。

このツールは、次のものを含むがこれらに限定されない、リナーまたは静的コードアナライザーで動作します。

• flake8
• ラフ
• ピリント
• マイピー
• eslint
• ルボコップ
• stylelint

前提条件：

• Python 3.9以上
• git

インストール

pip install ondivi

使用法

GITリポジトリのルートディレクトリにいることを確認してください。

スクリプトを実行します：

flake8 script.py | ondivi
# with ruff:
ruff check file.py --output-format=concise | ondivi

または：

flake8 script.py > violations.txt
ondivi --fromfile=violations.txt

 $ ondivi --help
Usage: ondivi [OPTIONS]

  Ondivi (Only diff violations).

  Python script filtering coding violations, identified by static analysis,
  only for changed lines in a Git repo. Usage example:

  flake8 script.py | ondivi

Options:
  --baseline TEXT    Commit or branch which will contain legacy code. Program
                     filter out violations on baseline (default: "master")
  --fromfile TEXT    Path to file with violations. Expected "utf-8" encoding
  --format TEXT      Template for parsing linter messages. The template should
                     include the following named parts:

                     {filename}   The name of the file with the error/warning
                     {line_num}   The line number with the error/warning
                     (integer)

                     Example usage:

                     --format "{filename}:{line_num:d}{other}"

                     In this example, the linter message

                     "src/app_types/listable.py:23:1: UP035 Import from
                     collections.abc instead: Sequence"

                     will be recognized and parsed into the following
                     components:

                      - filename: "src/app_types/listable.py"
                      - line_num: 23
                      - other: :1: "UP035 Import from collections.abc instead:
                      Sequence"

                     Ensure that the template matches the format of the
                     messages generated by your linter.
                     (default: "{filename}:{line_num:d}{other}")
  --only-violations  Show only violations
  --help             Show this message and exit.

それがどのように機能するか

スクリプトは、git diff出力を解析して、各ファイルの変更された行を識別します。

次に、指定されたコーディング違反をフィルタリングして、変更された行に対応する違反のみを含めます。

FlakeheavenとFlakehellは、内部Flake8 APIに依存しているため、サポートされていません。対照的に、Ondiviは違反のテキスト出力とGITリポジトリの状態のみを使用して、より堅牢でメンテナンスを容易にします。

ファイル上のflake8：

$ flake8 file.py
file.py:3:1: E302 expected 2 blank lines, found 1
file.py:9:1: E302 expected 2 blank lines, found 1
file.py:10:121: E501 line too long (123 > 120 characters)
file.py:14:1: E305 expected 2 blank lines after class or function definition, found 1

変更の例：

 from dataclasses import dataclass

 @dataclass
 class User(object):

     name: str
     age: int

 def greet(user: User):
     print('Long string in initial commit ################################################################################')
     print(f'Hello, {user.name}!')
+    print('Long string in new commit ################################################################################')

 if __name__ == '__main__':
     greet(User(345, 23))
+    greet(User('Bob', '23'))

Git Diffによって、2つの新しい行が追加されたことがわかります（12と16）：

Ondiviは違反をフィルタリングし、12行目の1つだけを示します。

$ flake8 script.py | ondivi
file.py:12:80: E501 line too long (119 > 79 characters)

ライセンス

このプロジェクトは、MITライセンスの下でライセンスされています。詳細については、ライセンスファイルを参照してください。