Add and satisfy linting (#551)

Fixes #550

Author: vemv

.circleci/config.yml

@@ -45,8 +45,13 @@ commands:
   lint:
     steps:
       - run:
-          name: Run regression tests
-          command: eldev -dtT compile
+          name: Lint
+          command: eldev lint
+  compile:
+    steps:
+      - run:
+          name: Check for byte-compilation errors
+          command: eldev -dtT compile --warnings-as-errors
 
 jobs:
   test-ubuntu-emacs-26:
@@ -57,6 +62,7 @@ jobs:
       - setup
       - test
       - lint
+      - compile
   test-ubuntu-emacs-27:
     docker:
       - image: silex/emacs:27-ci
@@ -65,6 +71,7 @@ jobs:
       - setup
       - test
       - lint
+      - compile
   test-ubuntu-emacs-28:
     docker:
       - image: silex/emacs:28-ci
@@ -73,6 +80,7 @@ jobs:
       - setup
       - test
       - lint
+      - compile
   test-ubuntu-emacs-29:
     docker:
       - image: silex/emacs:29-ci
@@ -81,6 +89,7 @@ jobs:
       - setup
       - test
       - lint
+      - compile
   test-ubuntu-emacs-master:
     docker:
       - image: silex/emacs:master-ci
@@ -89,13 +98,15 @@ jobs:
       - setup
       - test
       - lint
+      - compile
   test-macos-emacs-latest:
     macos:
       xcode: "14.0.0"
     steps:
       - setup-macos
       - test
       - lint
+      - compile
   test-windows-emacs-latest:
     executor: win/default
     steps:
@@ -106,6 +117,7 @@ jobs:
       - setup-windows
       - test
       - lint
+      - compile
 
 workflows:
   version: 2.1

.dir-locals.el

@@ -0,0 +1,36 @@
+;;; Directory Local Variables
+;;; For more information see (info "(emacs) Directory Variables")
+
+((emacs-lisp-mode
+  (bug-reference-url-format . "https://github.com/clojure-emacs/clj-refactor.el/issues/%s")
+  (bug-reference-bug-regexp . "#\\(?2:[[:digit:]]+\\)")
+  (indent-tabs-mode . nil)
+  (fill-column . 80)
+  (sentence-end-double-space . t)
+  (emacs-lisp-docstring-fill-column . 75)
+  (checkdoc-symbol-words . ("top-level" "major-mode" "macroexpand-all" "print-level" "print-length"))
+  (checkdoc-package-keywords-flag)
+  (byte-compile-docstring-max-column 240)
+  (checkdoc-force-docstrings-flag nil)
+  (checkdoc-arguments-in-order-flag)
+  (checkdoc-verb-check-experimental-flag)
+  (elisp-lint-indent-specs . ((if-let* . 2)
+                              (when-let* . 1)
+                              (let* . defun)
+                              (nrepl-dbind-response . 2)
+                              ;; need better solution for indenting cl-flet bindings
+                              (insert-label . defun)              ;; cl-flet
+                              (insert-align-label . defun)        ;; cl-flet
+                              (insert-rect . defun)               ;; cl-flet
+                              (cl-defun . 2)
+                              (cljr--update-file . 1)
+                              (cljr--with-string-content . 1)
+                              (with-parsed-tramp-file-name . 2)
+                              (thread-first . 0)
+                              (thread-last . 0)
+                              (transient-define-prefix . defmacro)
+                              (transient-define-suffix . defmacro)))))
+
+;; To use the bug-reference stuff, do:
+;;     (add-hook 'text-mode-hook #'bug-reference-mode)
+;;     (add-hook 'prog-mode-hook #'bug-reference-prog-mode)

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+* Internal: avoid the use of deprecated Elisp functions.
+
 ## 3.9.2
 
 * [#523](https://github.com/clojure-emacs/clj-refactor.el/issues/523): Increase `js/` namespace detection accuracy for .cljc files. 

Eldev

@@ -13,8 +13,13 @@
 ;; CIDER cannot be compiled otherwise.
 (setf eldev-build-load-before-byte-compiling t)
 
+(setq byte-compile-docstring-max-column 240)
+(setq checkdoc-force-docstrings-flag nil)
+(setq checkdoc-permit-comma-termination-flag t)
+(setq checkdoc--interactive-docstring-flag nil)
+
 (setf eldev-lint-default '(elisp))
 (with-eval-after-load 'elisp-lint
   ;; We will byte-compile with Eldev.
-  (setf elisp-lint-ignored-validators '("package-lint" "fill-column" "byte-compile")
+  (setf elisp-lint-ignored-validators '("package-lint" "fill-column" "byte-compile" "checkdoc")
         enable-local-variables        :safe))