flycheck-ruff.el

;;; flycheck-ruff.el --- Flycheck syntax checker using ruff

;; Copyright © 2023, by https://github.com/mhvk

;; Author: mhvk <https://github.com/mhvk>
;; Maintainer: ed9w2in6
;; Version: 0.1
;; Package-Requires: ((flycheck "33-cvs"))
;; Created: 26 Oct 2023
;; Keywords: convenience, languages, tools
;; Homepage: None


;; This file is not part of GNU Emacs.

;;; License:

;; You can redistribute this program and/or modify it under the terms of the GNU General Public License version 2.

;;; Commentary:

;; Custom syntax checker for using ruff within flycheck

;; This is taken from: https://gist.github.com/abo-abo/277d1fe1e86f0e46d3161345f26e8f3a
;; It is indirectly from: https://github.com/flycheck/flycheck/issues/1974#issuecomment-1343495202

;;; Code:

(require 'flycheck)

;; From https://github.com/flycheck/flycheck/issues/1974#issuecomment-1343495202
(flycheck-define-checker python-ruff
  "A Python syntax and style checker using the ruff utility.
To override the path to the ruff executable, set
`flycheck-python-ruff-executable'.
See URL `http://pypi.python.org/pypi/ruff'."
  :command ("ruff"
            "check"
            "--output-format=text"
            (eval (when buffer-file-name
                    (concat "--stdin-filename=" buffer-file-name)))
            "-")
  :standard-input t
  :error-filter (lambda (errors)
                  (let ((errors (flycheck-sanitize-errors errors)))
                    (seq-map #'flycheck-flake8-fix-error-level errors)))
  :error-patterns
  ((warning line-start
            (file-name) ":" line ":" (optional column ":") " "
            (id (one-or-more (any alpha)) (one-or-more digit)) " "
            (message (one-or-more not-newline))
            line-end))
  :modes (python-mode python-ts-mode))

;; ;; Use something adapted to your config to add `python-ruff' to `flycheck-checkers'
;; ;; This is an MVP example:
;; (setq python-mode-hook
;;       (list (defun my-python-hook ()
;;               (unless (bound-and-true-p org-src-mode)
;;                 (when (buffer-file-name)
;;                   (setq-local flycheck-checkers '(python-ruff))
;;                   (flycheck-mode))))))

(provide 'flycheck-ruff)

;;; flycheck-ruff.el ends here