Make the CI setup closer to that of clojure-mode

Author: bbatsov

.circleci/config.yml

@@ -7,7 +7,11 @@ default: &default-steps
     - run: apt-get update && apt-get install make
     - run: make elpa
     - run: emacs --version
-    - run: ./run-tests-ci.sh
+    - run: make test
+    # Make sure to run test-checks before test-bytecomp, as test-bytecomp autogenerates
+    # files which won't pass test-checks.
+    - run: make test-checks
+    - run: make test-bytecomp
 
 # Enumerated list of Emacs versions
 jobs:

Makefile

@@ -0,0 +1,42 @@
+CASK = cask
+export EMACS ?= emacs
+EMACSFLAGS =
+
+PKGDIR := $(shell EMACS=$(EMACS) $(CASK) package-directory)
+
+SRCS = $(wildcard *.el)
+OBJS = $(SRCS:.el=.elc)
+
+.PHONY: compile test clean elpa
+
+all: compile
+
+elpa-$(EMACS):
+	$(CASK) install
+	$(CASK) update
+	touch $@
+
+elpa: elpa-$(EMACS)
+
+elpaclean:
+	rm -f elpa*
+	rm -rf .cask # Clean packages installed for development
+
+compile: elpa
+	$(CASK) build
+
+clean:
+	rm -f $(OBJS)
+
+test: $(PKGDIR)
+	$(CASK) ecukes "$@" --no-win
+
+test-checks:
+	$(CASK) exec $(EMACS) --no-site-file --no-site-lisp --batch \
+		-l test/test-checks.el ./
+
+test-bytecomp: $(SRCS:.el=.elc-test)
+
+%.elc-test: %.el elpa
+	$(CASK) exec $(EMACS) --no-site-file --no-site-lisp --batch \
+		-l test/clojure-mode-bytecomp-warnings.el $

test/clj-refactor-bytecomp-warnings.el

@@ -0,0 +1,40 @@
+;;; clj-refactor-bytecomp-warnings.el --- Check for byte-compilation problems
+
+;; Copyright © 2012-2020 Bozhidar Batsov and contributors
+;;
+;; 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
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program 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.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+;; This file is not part of GNU Emacs.
+
+;;; Commentary:
+
+;; This is a script to be loaded while visiting a `clj-refactor' source file.
+;; It will prepare all requirements and then byte-compile the file and signal an
+;; error on any warning.  For example:
+;;
+;;    emacs -Q --batch -l test/clj-refactor-bytecomp-warnings.el clj-refactor.el
+
+;; This assumes that all `clj-refactor' dependencies are already on the package
+;; dir (probably from running `cask install').
+
+(setq load-prefer-newer t)
+(add-to-list 'load-path (expand-file-name "./"))
+(require 'package)
+(package-generate-autoloads 'clj-refactor default-directory)
+(package-initialize)
+(load-file "clj-refactor-autoloads.el")
+(setq byte-compile-error-on-warn t)
+(batch-byte-compile)
+
+;;; clj-refactor-bytecomp-warnings.el ends here

test/test-checks.el

@@ -0,0 +1,30 @@
+;; This is a script to be loaded from the root `clj-refactor' directory. It will
+;; prepare all requirements and then run `check-declare-directory' on
+;; `default-directory'. For example: emacs -Q --batch -l test/test-checkdoc.el
+
+;; This assumes that all `clj-refactor' dependencies are already on the package
+;; dir (probably from running `cask install').
+
+(add-to-list 'load-path (expand-file-name "./"))
+(require 'package)
+(require 'check-declare)
+(package-initialize)
+
+;; disable some annoying (or non-applicable) checkdoc checks
+(setq checkdoc-package-keywords-flag nil)
+(setq checkdoc-arguments-in-order-flag nil)
+(setq checkdoc-verb-check-experimental-flag nil)
+
+(let ((files (directory-files default-directory t
+                              "\\`[^.].*\\.el\\'" t)))
+
+  ;; `checkdoc-file' was introduced in Emacs 25
+  (when (fboundp 'checkdoc-file)
+    (dolist (file files)
+      (checkdoc-file file))
+    (when (get-buffer "*Warnings*")
+      (message "Failing due to checkdoc warnings...")
+      (kill-emacs 1)))
+
+  (when (apply #'check-declare-files files)
+    (kill-emacs 1)))