Lint using `package-lint'

mkcms · mkcms · commit d98f72787ce7 · 2025-10-20T22:04:46.000+02:00
* Makefile (INSTALL_DEPENDENCIES): Install `package-lint' from added
melpa archive.
(IGNORED_LINT_WARNINGS): New variable.
(%.lint-checkdoc):
(%.lint-long-lines): New targets split from old `lint'.
(%.lint-package): New target.
(lint): Depend on the created lint targets.
* asm-data.el:
* asm-jump.el:
* asm-x86.el:
* asm2src.el:
* bdx.el:
* binfile.el:
* compdb.el:
* emacs-binary-utils.el:
* untemplatize-cxx.el: Address newly found linter warnings.
diff --git a/Makefile b/Makefile
@@ -19,23 +19,30 @@ ELC := $(FILES:.el=.elc)
 
 PACKAGE_INIT := -f package-initialize
 
-INSTALL_DEPENDENCIES := ${PACKAGE_INIT} --eval '(progn                        \
-	(load "seq" nil t)                                                    \
-	(load "project" nil t)                                                \
-	(unless (and (fboundp `seq-contains-p) (fboundp `project-name))       \
-	  (package-refresh-contents)                                          \
-	  (package-install (cadr (assoc `project package-archive-contents)))  \
-	  (package-install (cadr (assoc `map package-archive-contents)))      \
-	  (package-install (cadr (assoc `seq package-archive-contents))))     \
-	(unless (package-installed-p `ivy)                                    \
-	  (package-refresh-contents)                                          \
+INSTALL_DEPENDENCIES := ${PACKAGE_INIT} --eval '(progn                             \
+	(load "seq" nil t)                                                         \
+	(load "project" nil t)                                                     \
+	(unless (and (fboundp `seq-contains-p)                                     \
+	             (fboundp `project-name)                                       \
+	             (package-installed-p (quote package-lint)))                   \
+	  (push (quote ("melpa" . "https://melpa.org/packages/")) package-archives)\
+	  (package-refresh-contents)                                               \
+	  (package-install (quote package-lint))                                   \
+	  (package-install (cadr (assoc `project package-archive-contents)))       \
+	  (package-install (cadr (assoc `map package-archive-contents)))           \
+	  (package-install (cadr (assoc `seq package-archive-contents))))          \
+	(unless (package-installed-p `ivy)                                         \
+	  (package-refresh-contents)                                               \
 	  (package-install `ivy)))'
 
+IGNORED_LINT_WARNINGS := \
+	-e "You should depend on (emacs \"29\\.1\") or the compat package if you need \`take'\\." \
+	-e "warning: \`with-eval-after-load' is for use in configurations," \
+
 LIBS := $(patsubst %.el,-l %,${FILES})
 
 SELECTOR ?= .*
 
-.PHONY: deps
 deps:
 	${emacs} -Q --batch ${INSTALL_DEPENDENCIES}
 
@@ -50,28 +57,28 @@ check: compile
 	    --eval '(setq byte-compile-error-on-warn t)'                      \
 	    -f batch-byte-compile $<
 
-lint:
-	set -e;                                                               \
-	files=(                                                               \
-	  asm-data.el                                                         \
-	  asm-jump.el                                                         \
-	  asm-x86.el                                                          \
-	  asm2src.el                                                          \
-	  bdx.el                                                              \
-	  binfile.el                                                          \
-	  compdb.el                                                           \
-	  untemplatize-cxx.el                                                 \
-	);                                                                    \
-	for f in $${files[@]}; do                                             \
-	    lint=$$(mktemp)                                                   \
-	    && ${emacs} -Q --batch $$f                                        \
+%.lint-checkdoc: %.el
+	@lint=$$(mktemp);                                                     \
+	${emacs} -Q --batch $<                                                \
 		--eval '(checkdoc-file (buffer-file-name))' 2>&1 | tee $$lint \
-	    && test -z "$$(cat $$lint)";                                      \
-	done;                                                                 \
-	for f in $${files[@]}; do                                             \
-	    sed '1{s/.*//}' $$f | grep -n -E "^.{80,}" `# Catch long lines`   \
-	    | sed  -r 's/^([0-9]+).*/'$$f':\1: Too long/;q1';                 \
-	done
+        && test -z "$$(cat $$lint)"
+
+%.lint-long-lines: %.el
+	@sed '1{s/.*//}' $< | grep -n -E "^.{80,}" `# Catch long lines`       \
+	    | sed  -r 's/^([0-9]+).*/'$<':\1: Too long/;q1';
+
+%.lint-package: %.el
+	@file=$$(mktemp);result=$$(mktemp);                              \
+	${emacs} -Q --batch ${PACKAGE_INIT}                              \
+	  -f 'package-lint-batch-and-exit' $<  2>$$file || true          \
+	&& sed -i "/^Entering directory/d" $$file                        \
+	&& grep -v ${IGNORED_LINT_WARNINGS} $$file | tee $$result        \
+	&& test -z "$$(cat $$result)"
+
+%.lint: %.el %.lint-checkdoc %.lint-long-lines %.lint-package
+	@true
+
+lint: $(patsubst %.el,%.lint,$(filter-out %-test.el,$(FILES)))
 
 clean:
 	rm -f *.elc
diff --git a/asm-data.el b/asm-data.el
@@ -4,6 +4,9 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: languages, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
+;; Package-Requires: ((emacs "27") (seq "2.24"))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -82,9 +85,7 @@
               ".single" ".float"        ; 32 bit float
               ".double"                 ; 64 bit float
 
-              ".zero"
-
-              )))
+              ".zero")))
     (unless asm-data--big-values-support
       (setq val (delete ".8byte" val))
       (setq val (delete ".octa" val)))
@@ -97,8 +98,7 @@
     (".long" . ".int")
     (".short" . ".2byte")
     (".hword" . ".short")
-    (".float" . ".single")
-    )
+    (".float" . ".single"))
   "Alist of directive aliases.  Keys are aliases, values are directives.")
 
 (defcustom asm-data-endianness 'little
diff --git a/asm-jump.el b/asm-jump.el
@@ -4,6 +4,8 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: languages, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
 ;; Package-Requires: ((emacs "27"))
 
 ;; This program is free software; you can redistribute it and/or modify
diff --git a/asm-x86.el b/asm-x86.el
@@ -4,6 +4,8 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: languages, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
 ;; Package-Requires: ((emacs "27"))
 
 ;; This program is free software; you can redistribute it and/or modify
@@ -21,6 +23,7 @@
 
 ;;; Commentary:
 ;;
+;; This package provides x86 handlers for the binfile package.
 
 ;;; Code:
 
diff --git a/asm2src.el b/asm2src.el
@@ -4,6 +4,8 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: languages, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
 ;; Package-Requires: ((emacs "27"))
 
 ;; This program is free software; you can redistribute it and/or modify
@@ -97,8 +99,7 @@
                          `(
                            asm2src-file ,file
                            asm2src-line ,line
-                           asm2src-id   ,(gensym)
-                           ))))
+                           asm2src-id   ,(gensym)))))
 
 (defun asm2src-process-buffer ()
   "Process source mappings in current buffer.
diff --git a/bdx.el b/bdx.el
@@ -4,6 +4,9 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: tools, c
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
+;; Package-Requires: ((emacs "29.1"))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -496,8 +499,7 @@ This will error if `bdx-demangle-names' is nil."
         (pcase-let (((map (:outdated (map (:binary binary-outdated)
                                           (:symbol symbol-outdated)))
                           :demangled :name :path
-                          :size :section :address :type
-                          )
+                          :size :section :address :type)
                      (bdx-data cand)))
           (insert (propertize (or demangled name "(ERROR: No name)")
                               'face 'font-lock-constant-face)
diff --git a/binfile.el b/binfile.el
@@ -4,6 +4,8 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: languages, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
 ;; Package-Requires: ((emacs "27"))
 
 ;; This program is free software; you can redistribute it and/or modify
@@ -59,8 +61,7 @@
     binfile-postprocess-boring-comments
     binfile-postprocess-numeric-to-symbolic-references
     binfile-postprocess-unused-symbolic-local-references
-    binfile-postprocess-add-relocation-buttons
-    )
+    binfile-postprocess-add-relocation-buttons)
   "List of functions that postprocess ASM regions.
 Each function is called with three arguments (BEG END NAME),
 where BEG and END are region bounds and NAME is the name of the
@@ -189,8 +190,7 @@ The groups are:
           ?<
           ,function-name
           (optional "+0x" (+ hex-digit))
-          ?>
-          )))
+          ?>)))
 
 (defun binfile-postprocess-local-jumps (_beg _end function-name)
   "Labelize FUNCTION-NAME and rewrite jumps to symbolic jumps to those labels."
diff --git a/compdb.el b/compdb.el
@@ -4,6 +4,9 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: c, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
+;; Package-Requires: ((emacs "27.1"))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
diff --git a/emacs-binary-utils.el b/emacs-binary-utils.el
@@ -4,7 +4,7 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: languages, tools
-;; Package-Requires: ((emacs "27") (seq "2.24") (project "0.10.0") (map "3.3.1"))
+;; Package-Requires: ((emacs "29.1") (seq "2.24") (project "0.10.0") (map "3.3.1"))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
diff --git a/untemplatize-cxx.el b/untemplatize-cxx.el
@@ -4,6 +4,9 @@
 
 ;; Author: Michał Krzywkowski <k.michal@zoho.com>
 ;; Keywords: c, tools
+;; Version: 0.1.0
+;; Homepage: https://github.com/mkcms/emacs-binary-utils
+;; Package-Requires: ((emacs "27"))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
