forked from jgm/pandoc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
259 lines (215 loc) · 8.01 KB
/
Makefile
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
version?=$(shell grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')
pandoc=$(shell find dist -name pandoc -type f -exec ls -t {} \; | head -1)
SOURCEFILES?=$(shell git ls-tree -r master --name-only src pandoc-cli pandoc-server pandoc-lua-engine | grep "\.hs$$")
PANDOCSOURCEFILES?=$(shell git ls-tree -r master --name-only src | grep "\.hs$$")
DOCKERIMAGE=registry.gitlab.b-data.ch/ghc/ghc4pandoc:9.4.3
TIMESTAMP=$(shell date "+%Y%m%d_%H%M")
LATESTBENCH=$(word 1,$(shell ls -t bench_*.csv 2>/dev/null))
BASELINE?=$(LATESTBENCH)
ROOT?=Text.Pandoc
ifeq ($(BASELINE),)
BASELINECMD=
else
BASELINECMD=--baseline $(BASELINE)
endif
GHCOPTS=-fwrite-ide-info -fdiagnostics-color=always -j4 +RTS -A8m -RTS
CABALOPTS?=--disable-optimization
WEBSITE=../../web/pandoc.org
REVISION?=1
BENCHARGS?=--csv bench_$(TIMESTAMP).csv $(BASELINECMD) --timeout=6 +RTS -T --nonmoving-gc -RTS $(if $(PATTERN),--pattern "$(PATTERN)",)
all: test build ## build executable and run tests
.PHONY: all
build: ## build executable
cabal build \
--ghc-options='$(GHCOPTS)' \
$(CABALOPTS) pandoc-cli
@cabal list-bin $(CABALOPTS) --ghc-options='$(GHCOPTS)' pandoc-cli
.PHONY: build
binpath: ## print path of built pandoc executable
@cabal list-bin $(CABALOPTS) pandoc-cli
.PHONY: binpath
ghcid: ## run ghcid
ghcid -c 'cabal repl pandoc'
.PHONY: ghcid
repl: ## run cabal repl
cabal repl $(CABALOPTS) pandoc
.PHONY: repl
linecounts: ## print line counts for each module
@wc -l $(SOURCEFILES) | sort -n
.PHONY: linecounts
# Note: to accept current results of golden tests,
# make test TESTARGS='--accept'
test: ## unoptimized build and run tests with cabal
cabal test \
--ghc-options='$(GHCOPTS)' \
$(CABALOPTS) \
--test-options="--hide-successes --ansi-tricks=false $(TESTARGS)" all
.PHONY: test
quick-stack: ## unoptimized build and tests with stack
stack install \
--ghc-options='$(GHCOPTS)' \
--system-ghc --flag 'pandoc:embed_data_files' \
--fast \
--test \
--test-arguments='-j4 --hide-successes --ansi-tricks=false $(TESTARGS)'
.PHONY: quick-stack
prerelease: README.md fix_spacing check-cabal check-stack checkdocs man uncommitted_changes ## prerelease checks
.PHONY: prerelease
uncommitted_changes:
! git diff | grep '.'
.PHONY: uncommitted_changes
authors: ## prints unique authors since LASTRELEASE (version)
git log --pretty=format:"%an" $(LASTRELEASE)..HEAD | sort | uniq
check-stack:
stack-lint-extra-deps # check that stack.yaml dependencies are up to date
! grep 'git:' stack.yaml # use only released versions
.PHONY: check-stack
check-cabal: git-files.txt sdist-files.txt
@echo "Checking to see if all committed test/data files are in sdist."
diff -u $^
@for pkg in . pandoc-lua-engine pandoc-server pandoc-cli; \
do \
pushd $$pkg ; \
cabal check ; \
cabal outdated ; \
popd ; \
done
! grep 'git:' cabal.project # use only released versions
.PHONY: check-cabal
checkdocs:
@echo "Checking for tabs in manual."
! grep -q -n -e "\t" \
MANUAL.txt changelog.md doc/pandoc-server.md doc/pandoc-lua.md
.PHONY: checkdocs
bench: ## build and run benchmarks
cabal bench --benchmark-options='$(BENCHARGS)' 2>&1 | tee "bench_$(TIMESTAMP).txt"
.PHONY: bench
reformat: ## reformat with stylish-haskell
for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done
.PHONY: reformat
lint: ## run hlint
hlint --report=hlint.html $(SOURCEFILES) || open hlint.html
.PHONY: lint
fix_spacing: ## fix trailing newlines and spaces
@ERRORS=0; echo "Checking for spacing errors..." && for f in $(SOURCEFILES); do printf '%s\n' "`cat $$f`" | sed -e 's/ *$$//' > $$f.tmp; diff -u $$f $$f.tmp || ERRORS=1; mv $$f.tmp $$f; done; [ $$ERRORS -eq 0 ] || echo "Spacing errors have been fixed; please commit the changes."; exit $$ERRORS
.PHONY: fix_spacing
changes_github: ## copy this release's changes in gfm
pandoc --lua-filter tools/extract-changes.lua changelog.md -t gfm --wrap=none --template tools/changes_template.html | sed -e 's/\\#/#/g' | pbcopy
.PHONY: changes_github
man: man/pandoc.1 man/pandoc-server.1 man/pandoc-lua.1 ## build man pages
.PHONY: man
latex-package-dependencies: ## print packages used by default latex template
pandoc lua tools=latex-package-dependencies.lua
.PHONY: latex-package-dependencies
coverage: ## code coverage information
cabal test \
--ghc-options='-fhpc $(GHCOPTS)' \
$(CABALOPTS) \
--test-options="--hide-successes --ansi-tricks=false $(TESTARGS)"
hpc markup --destdir=coverage test/test-pandoc.tix
open coverage/hpc_index.html
.PHONY: coverage
weeder: ## run weeder to find dead code
weeder
.PHONY: weeder
transitive-deps: ## print transitive dependencies
cabal-plan topo | sort | sed -e 's/-[0-9]\..*//'
.PHONY: transitive-deps
debpkg: ## create linux package
docker run -v `pwd`:/mnt \
-v `pwd`/linux/artifacts:/artifacts \
--user $(id -u):$(id -g) \
-e REVISION=$(REVISION) \
-w /mnt \
--memory=0 \
--rm \
$(DOCKERIMAGE) \
bash \
/mnt/linux/make_artifacts.sh
.PHONY: debpkg
man/pandoc.1: MANUAL.txt man/pandoc.1.before man/pandoc.1.after
pandoc $< -f markdown -t man -s \
--lua-filter man/manfilter.lua \
--include-before-body man/pandoc.1.before \
--include-after-body man/pandoc.1.after \
--metadata author="" \
--variable footer="pandoc $(version)" \
-o $@
man/pandoc-%.1: doc/pandoc-%.md
pandoc $< -f markdown -t man -s \
--lua-filter man/manfilter.lua \
--variable footer="pandoc-$* $(version)" \
-o $@
README.md: README.template MANUAL.txt tools/update-readme.lua
pandoc --lua-filter tools/update-readme.lua \
--reference-location=section -t gfm $< -o $@
doc/lua-filters.md: tools/update-lua-module-docs.lua ## update lua-filters.md module docs
cabal run pandoc -- --standalone \
--reference-links \
--lua-filter=$< \
--columns=66 \
--output=$@ \
$@
.PHONY: doc/lua-filters.md
download_stats: ## print download stats from GitHub releases
curl https://api.github.com/repos/jgm/pandoc/releases | \
jq -r '.[] | .assets | .[] | "\(.download_count)\t\(.name)"'
.PHONY: download_stats
pandoc-templates: ## update pandoc-templates repo
rm ../pandoc-templates/default.* ; \
cp data/templates/* ../pandoc-templates/ ; \
pushd ../pandoc-templates/ && \
git add * && \
git commit -m "Updated templates for pandoc $(version)" && \
popd
.PHONY: pandoc-templates
update-website: ## update website and upload
make -C $(WEBSITE) update
make -C $(WEBSITE)
make -C $(WEBSITE) upload
.PHONY: update-website
modules.csv: $(PANDOCSOURCEFILES)
@rg '^import.*Text\.Pandoc\.' --with-filename $^ \
| rg -v 'Text\.Pandoc\.(Definition|Builder|Walk|Generic)' \
| sort \
| uniq \
| sed -e 's/src\///' \
| sed -e 's/\//\./g' \
| sed -e 's/\.hs:import *\(qualified *\)*\([^ ]*\).*/,\2/' \
> $@
modules.dot: modules.csv
@echo "digraph G {" > $@
@echo "overlap=\"scale\"" >> $@
@sed -e 's/\([^,]*\),\(.*\)/ "\1" -> "\2";/' $< >> $@
@echo "}" >> $@
# To get the module dependencies of Text.Pandoc.Parsing:
# make modules.pdf ROOT=Text.Pandoc.Parsing
modules.pdf: modules.dot
gvpr -f tools/cliptree.gvpr -a '"$(ROOT)"' $< | dot -Tpdf > $@
# make moduledeps ROOT=Text.Pandoc.Parsing
moduledeps: modules.csv ## Print transitive dependencies of a module ROOT
@echo "$(ROOT)"
@lua tools/moduledeps.lua transitive $(ROOT) | sort
.PHONY: moduledeps
clean: ## clean up
cabal clean
.PHONY: clean
.PHONY: .FORCE
sdist-files.txt: .FORCE
cabal sdist --list-only | sed 's/\.\///' | grep '^\(test\|data\)\/' | sort > $@
git-files.txt: .FORCE
git ls-tree -r --name-only HEAD | grep '^\(test\|data\)\/' | sort > $@
help: ## display this help
@echo "Targets:"
@grep -E '^[ a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%-16s %s\n", $$1, $$2}'
@echo
@echo "Environment variables with default values:"
@printf "%-16s%s\n" "CABALOPTS" "$(CABALOPTS)"
@printf "%-16s%s\n" "GHCOPTS" "$(GHCOPTS)"
@printf "%-16s%s\n" "TESTARGS" "$(TESTARGS)"
@printf "%-16s%s\n" "BASELINE" "$(BASELINE)"
@printf "%-16s%s\n" "REVISION" "$(REVISION)"
.PHONY: help
hie.yaml: ## regenerate hie.yaml
gen-hie > $@
.PHONY: hie.yaml