2022-08-25 15:13:38 +00:00
|
|
|
;;; use-package-lint.el --- Attempt to find errors in use-package declarations -*- lexical-binding: t; -*-
|
|
|
|
|
2022-11-08 03:31:08 +00:00
|
|
|
;; Copyright (C) 2012-2022 Free Software Foundation, Inc.
|
2022-08-25 15:13:38 +00:00
|
|
|
|
|
|
|
;; Author: John Wiegley <johnw@newartisans.com>
|
|
|
|
;; Maintainer: John Wiegley <johnw@newartisans.com>
|
2023-07-27 19:42:55 +00:00
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
2022-08-25 15:13:38 +00:00
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
2023-07-27 19:42:55 +00:00
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2022-08-25 15:13:38 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Provides the command `M-x use-package-lint'.
|
2023-07-27 19:42:55 +00:00
|
|
|
;;
|
|
|
|
;; See the `use-package' info manual for more information.
|
2022-08-25 15:13:38 +00:00
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
(require 'cl-lib)
|
|
|
|
(require 'use-package-core)
|
|
|
|
|
|
|
|
(defun use-package-lint-declaration (name plist)
|
|
|
|
(dolist (path (plist-get plist :load-path))
|
|
|
|
(unless (file-exists-p path)
|
|
|
|
(display-warning
|
|
|
|
'use-package
|
|
|
|
(format "%s :load-path does not exist: %s"
|
|
|
|
name path) :error)))
|
|
|
|
|
|
|
|
(unless (or (plist-member plist :disabled)
|
|
|
|
(plist-get plist :no-require)
|
|
|
|
(locate-library (use-package-as-string name) nil
|
|
|
|
(plist-get plist :load-path)))
|
|
|
|
(display-warning
|
|
|
|
'use-package
|
|
|
|
(format "%s module cannot be located" name) :error))
|
|
|
|
|
|
|
|
;; (dolist (command (plist-get plist :commands))
|
|
|
|
;; (unless (string= (find-lisp-object-file-name command nil)
|
|
|
|
;; (locate-library (use-package-as-string name) nil
|
|
|
|
;; (plist-get plist :load-path)))
|
|
|
|
;; (display-warning
|
|
|
|
;; 'use-package
|
|
|
|
;; (format "%s :command is from different path: %s"
|
|
|
|
;; name (symbol-name command)) :error)))
|
|
|
|
)
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun use-package-lint ()
|
2023-07-27 19:42:55 +00:00
|
|
|
"Check for errors in `use-package' declarations.
|
2022-08-25 15:13:38 +00:00
|
|
|
For example, if the module's `:if' condition is met, but even
|
|
|
|
with the specified `:load-path' the module cannot be found."
|
|
|
|
(interactive)
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-min))
|
|
|
|
(let ((re (eval use-package-form-regexp-eval)))
|
|
|
|
(while (re-search-forward re nil t)
|
|
|
|
(goto-char (match-beginning 0))
|
|
|
|
(let ((decl (read (current-buffer))))
|
|
|
|
(when (eq (car decl) 'use-package)
|
|
|
|
(use-package-lint-declaration
|
|
|
|
(use-package-as-string (cadr decl))
|
|
|
|
(use-package-normalize-keywords
|
|
|
|
(cadr decl) (cddr decl)))))))))
|
|
|
|
|
|
|
|
(provide 'use-package-lint)
|
|
|
|
|
|
|
|
;;; use-package-lint.el ends here
|