1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
# Copyright (c) 2018 Flycheck contributors
# Copyright (c) 2012-2016 Sebastian Wiesner and Flycheck 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/>.
# Programs
CASK = cask
EMACS = emacs
GIT = git
INKSCAPE = inkscape
CONVERT = convert
OPTIPNG = optipng
# Program options
EMACSOPTS =
PATTERN = .*
LANGUAGE =
ifdef LANGUAGE
SELECTOR = (language $(LANGUAGE))
endif
# Internal variables
EMACSBATCH = $(EMACS) -Q --batch -L . $(EMACSOPTS)
RUNEMACS =
# Program availability
ifdef CASK
RUNEMACS = $(CASK) exec $(EMACSBATCH)
HAVE_CASK := $(shell sh -c "command -v $(CASK)")
ifndef HAVE_CASK
$(warning "$(CASK) is not available. Please run make help")
endif
else
RUNEMACS = $(EMACSBATCH)
endif
HAVE_INKSCAPE := $(shell sh -c "command -v $(INKSCAPE)")
HAVE_CONVERT := $(shell sh -c "command -v $(CONVERT)")
HAVE_OPTIPNG := $(shell sh -c "command -v $(OPTIPNG)")
RUNTEST = $(RUNEMACS) --load test/flycheck-test --load test/run.el \
-f flycheck-run-tests-main
# Export Emacs to goals, mainly for CASK
CASK_EMACS = $(EMACS)
export EMACS
export CASK_EMACS
# Run make help by default
.DEFAULT_GOAL = help
# File lists
SRCS = flycheck.el flycheck-ert.el
OBJS = $(SRCS:.el=.elc)
IMGS = doc/_static/logo.png
TEST_SRCS = flycheck.el flycheck-ert.el test/flycheck-test.el
# File rules
flycheck-ert.elc: flycheck.elc
flycheck-buttercup.elc: flycheck.elc
$(OBJS): %.elc: %.el
$(RUNEMACS) -l maint/flycheck-compile.el -f flycheck/batch-byte-compile $<
doc/_static/logo.png: flycheck.svg
ifndef HAVE_CONVERT
$(error "$(CONVERT) not available. Please run make help.")
endif
ifndef HAVE_INKSCAPE
$(error "$(INKSCAPE) not available. Please run make help.")
endif
ifndef HAVE_OPTIPNG
$(error "$(OPTIPNG) not available. Please run make help.")
endif
$(CONVERT) $< -trim -background white -bordercolor white \
-border 5 $@
$(OPTIPNG) $@
# Public targets
.PHONY: init
init:
$(CASK) install
$(CASK) update
.PHONY: clean
clean:
rm -rf $(OBJS)
$(MAKE) -C doc clean
.PHONY: purge
purge:
$(GIT) clean -xfd
.PHONY: format
format:
$(RUNEMACS) -l maint/flycheck-format.el -f flycheck/batch-format
.PHONY: check-format
check-format:
$(RUNEMACS) -l maint/flycheck-format.el -f flycheck/batch-check-format
.PHONY: checkdoc
checkdoc:
$(RUNEMACS) -l maint/flycheck-checkdoc.el -f flycheck/batch-checkdoc
.PHONY: check
check: check-format checkdoc
.PHONY: compile
compile: $(OBJS)
.PHONY: specs
specs: compile
$(CASK) exec buttercup -L . --pattern '$(PATTERN)' test/specs
.PHONY: unit
unit: compile
$(RUNTEST) '(and (not (tag external-tool)) $(SELECTOR))'
.PHONY: integ
integ: compile
$(RUNTEST) '(and (tag external-tool) $(SELECTOR))'
.PHONY: images
images: $(IMGS)
.PHONY: help
help:
@echo 'Run `make init` first to install and update all local dependencies.'
@echo ''
@echo 'Available targets:'
@echo ' init: Initialise the project. RUN FIRST!'
@echo ' check: Check all Emacs Lisp sources (needs Emacs 25)'
@echo ' compile: Byte-compile Emacs Lisp sources'
@echo ' format: Format all Emacs Lisp sources'
@echo ' specs: Run all buttercup specs for Flycheck'
@echo ' unit: Run all ERT unit tests for Flycheck (legacy)'
@echo ' integ: Run all integration tests for Flycheck'
@echo ' images: Generate PNG images from SVG sources'
@echo ' clean: Clean compiled files'
@echo ' purge: Clean everything'
@echo ''
@echo 'Available make variables:'
@echo ' PATTERN: A regular expression matching spec names to run with `specs`'
@echo ' SELECTOR: An ERT selector expression for `unit` and `integ`'
@echo ' LANGUAGE: The name of a language for `integ`. Overrides `SELECTOR`'
@echo ' EMACSOPTS: Additional options to pass to `emacs`'
@echo ' EMACS: The path or name of the Emacs to use for tests and compilation'
@echo ''
@echo 'Available programs:'
@echo ' $(CASK): $(if $(HAVE_CASK),yes,no)'
@echo ''
@echo 'You need $(CASK) to develop Flycheck.'
@echo 'See http://cask.readthedocs.io/ for more information.'
|
