Makefile

# HTTP root path (MUST be / terminated (at least if not /?))
ROOT :=

# Path to a local zm-data/
ZM_DATA := ../zm-data

# Timestamp to force browser cache update on .js/.css files.
VERSION := $(shell /bin/date '+%s')

# dev site HTTP port
port = 8001

GOFILES = backend.go data.go types.go config.go db.go db-user.go utils.go

LIBFILES = lib/enums.js lib/assert.js lib/attrs.js lib/bookmark.js \
	lib/classes.js lib/config.js lib/cut.js lib/db.js lib/fields.js lib/dom.js \
	lib/links.js lib/log.js lib/main.js lib/move.js lib/stack.js \
	lib/tests.js lib/user.js lib/utils.js lib/view.js lib/view/help.js \
	lib/data/dict.js lib/view/book.js lib/view/books.js lib/view/index.js \
	lib/view/account.js lib/rpc.js lib/account.js \
	lib/view/trbook.js lib/data/big5/big5.js lib/data/book/markdown.js \
	lib/data/book/wikisource.js lib/data/decomp/chise.js \
	lib/data/decomp/wmdecomp.js lib/data/dict/cedict.js \
	lib/data/dict/simpledict.js lib/data/dict/swmarkdown.js lib/data.js \
	lib/view/about.js lib/spa.js

# Clumsy, but for typechecking, we don't want to have lib/enums.js
# alongside lib.d.ts, as it'll generate useless conflicts.
LIBFILESNOENUMS = lib/assert.js lib/attrs.js lib/bookmark.js \
	lib/classes.js lib/config.js lib/cut.js lib/db.js lib/fields.js lib/dom.js \
	lib/links.js lib/log.js lib/main.js lib/move.js lib/stack.js \
	lib/tests.js lib/user.js lib/utils.js lib/view.js lib/view/help.js \
	lib/data/dict.js lib/view/book.js lib/view/books.js lib/view/index.js \
	lib/view/account.js lib/rpc.js lib/account.js \
	lib/view/trbook.js lib/data/big5/big5.js lib/data/book/markdown.js \
	lib/data/book/wikisource.js lib/data/decomp/chise.js \
	lib/data/decomp/wmdecomp.js lib/data/dict/cedict.js \
	lib/data/dict/simpledict.js lib/data/dict/swmarkdown.js lib/data.js \
	lib/view/about.js lib/spa.js

# tsc(1) options for JS.
#
# 	* --downlevelIteration is for spread operator on string to get
# 	individual unicode characters.
#	* es2019 for []string.flat()
TSC_OPTS = -downlevelIteration -lib es6,dom,es2019 -allowJs
TSC_CHECK_OPTS = ${TSC_OPTS} -strict -alwaysStrict -checkJs -noEmit # -noUnusedLocals -noUnusedParameters
TSC_GEN_OPTS = ${TSC_OPTS} --removeComments --module amd

# (re)start the backend on site-ready directory.
.PHONY: dev
dev:
	@echo "Re(starting) local dev server on http://localhost:${port}..."
	@lsof -i -P -n|awk '/TCP.*'${port}'.*LISTEN/ { print "kill " $$2 }' | sh
	@#nohup python3 -m http.server ${port} -d ./site-ready/ &
	@nohup go run ${GOFILES} &
	@$(eval ROOT := )

.PHONY: help
help:
	@echo "checkdeps      : check dependencies (curl, node, etc.)"
	@echo "site           : re(create) site-ready/ website"
	@echo "dev-site       : re(create) site-ready/ website for local tests"
	@echo "quick-dev-site : re(create) site-ready/ website for local tests (quick mode)"
	@echo "config         : re(create) lib/config.js"
	@echo "js-tests       : run JS tests"
	@echo "go-tests       : run Go tests"
	@echo "tests          : run both JS & Go tests"
	@echo "typecheck      : run static typechecking via tsc(1)"
	@echo "data           : update data/* files"

.PHONY: checkdeps
checkdeps: ./bin/checkdeps.sh
	@echo "Looking for dependencies..."
	@sh ./bin/checkdeps.sh
	@echo All dependencies found

.PHONY: typecheck
typecheck: lib.d.ts ./bin/mkshuowen.js ./bin/check-data.js \
		./tests/*.js ./tests/*/*.js ./tests/*/*/*.js \
		${LIBFILESNOENUMS}
	@# fd dance and sed(1) to get "clickable" error messages/proper exit status
	@t=/tmp/zmt.tmp; x=1; tsc ${TSC_CHECK_OPTS} $? 2>&1 > $$t && x=0; sed 's/(/:/;s/,/:/' $$t;  rm $$t; exit $$x

# Mind the quotes: ${ROOT} may be empty, which would shift the
# CLI arguments.
.PHONY: config
config: ./bin/mkconfigjs.sh
	@echo "Re(creating) lib/config.js..."
	@sh ./bin/mkconfigjs.sh "${ROOT}" "${VERSION}"

.PHONY: js-tests
js-tests: typecheck ./bin/tests.js ./lib/enums.js
	@echo Running JS tests...
	@node ./bin/tests.js

# TODO: this is broken because we use stuff from db_test.go in data_test.go
.PHONY: go-data-tests
go-data-tests: data_test.go ${GOFILES}
	@echo Running Go tests...
	@go test -v data_test.go ${GOFILES}

.PHONY: go-tests
go-tests: *_test.go ${GOFILES}
	@echo Running Go tests...
	@go test -v .

.PHONY: tests
tests: js-tests go-tests

# Like site, but without site-data/data; typechecking sometimes
# manually lifted.
.PHONY: quick-site
quick-site: typecheck config site/base/pako.min.js ./lib/enums.js \
		site/content/about.html site/base/full.js backend db-prod.sqlite
	@echo "Re(creating) website..."
	@rm -rf ./site-ready/
	@mkdir ./site-ready/
	@cp -rf ./site/base/* ./site-ready/
	@cp backend  ./site-ready/
	@cp config.json ./site-ready/

.PHONY: site
site: typecheck check-data config site/base/pako.min.js  \
		./lib/enums.js site-data \
		site/content/about.html site/base/full.js \
		quick-site

backend:
	@echo Building backend...
	@go build -o $@ .

.PHONY: zm-data
zm-data: ./bin/setupzmdata.sh
	@echo Setup data/...
	@sh ./bin/setupzmdata.sh ./data "${ZM_DATA}"

.PHONY: site-data
site-data: data bin/mksitedata.sh
	@echo Creating gziped files for site...
	@bin/mksitedata.sh

.PHONY: data
data: zm-data data/dict/cc-cedict.csv data/dict/cc-cedict-singles.csv \
	data/dict/cfdict-singles.csv data/dict/handedict-singles.csv \
	data/big5/big5.csv data/decomp/wm-decomp.csv data/decomp/chise.csv \
	data/dict/cfdict.csv data/dict/handedict.csv data/dict/openrussian.csv

check-data: ./lib/db.js ./lib/enums.js data ./bin/check-data.js data
	@echo Ensure data files are loadable...
	@node ./bin/check-data.js

dev-site: ./db-dev.sqlite dev site
quick-dev-site: ./db-dev.sqlite dev quick-site

${ZM_DATA}/LICENSE.md: ./site/base/full.js
	@echo "Re(creating) ${ZM_DATA}/LICENSE.md..."
	@node bin/mklicense.js > $@

./site/base/full.js: lib/*.js lib/*/*.js lib/*/*/*.js
	@#cat lib/enums.js $^ > $@
	@cat ${LIBFILES}  > $@

./site/base/full-tests.js: tests/*.js tests/*/*.js tests/*/*/*.js
	@cat $^ > $@

./lib/enums.js: ./bin/mkenumsjs.sh ./lib.d.ts
	@echo Creating $@...
	@sh ./bin/mkenumsjs.sh ./lib.d.ts > $@

./db-prod.sqlite: ./schema.sql ./schema-user-prod.sql ./schema-values.sql
	@echo Creating $@...
	@rm -rf $@
	@cat $^ | sqlite3 $@

./db-dev.sqlite: ./schema.sql ./schema-user-dev.sql ./schema-values.sql
	@echo Creating $@...
	@rm -rf $@
	@cat $^ | sqlite3 $@

./db-json-export.sql: ./schema.sql ./schema-user-dev.sql ./schema-values.sql ./schema-json-export.sql
	@echo Creating $@...
	@cat $^ > $@

./lib/db.js: ./db-json-export.sql ./bin/mkdbjs.sh
	@echo Creating $@...
	@sh ./bin/mkdbjs.sh $< > $@

./bin/tests.js: ./bin/mktestsjs.sh ./site/base/full.js ./site/base/full-tests.js
	@echo Creating $@...
	@sh ./bin/mktestsjs.sh > $@

site/base/pako.min.js:
	@echo Getting pako...
	@curl -s https://rawgit.com/nodeca/pako/master/dist/pako.min.js > $@

data/dict/cc-cedict.csv: ./bin/fetch-cc-cedict.sh
	@echo Fetching cc-cedict dictionary...
	@sh ./bin/fetch-cc-cedict.sh > $@

data/dict/cfdict.csv: ./bin/fetch-cfdict.sh
	@echo Fetching CFDICT...
	@sh ./bin/fetch-cfdict.sh > $@

data/dict/handedict.csv: ./bin/fetch-handedict.sh
	@echo Fetching HanDeDict...
	@sh ./bin/fetch-handedict.sh > $@

data/dict/openrussian.csv: ./bin/fetch-openrussian-dict.sh
	@echo Fetching and formatting OpenRussian...
	@sh ./bin/fetch-openrussian-dict.sh > $@

data/big5/big5.csv: ./bin/fetch-unicode-big5.sh
	@echo Fetching big5/utf8 mapping table...
	@sh ./bin/fetch-unicode-big5.sh > $@

data/decomp/wm-decomp.csv: ./bin/fetch-wm-decomp.sh
	@echo Fetching and formatting WikiMedia decomposition table...
	@sh ./bin/fetch-wm-decomp.sh > $@

data/decomp/chise.csv: ./bin/fetch-chise-decomp.sh
	@echo Fetching CHISE project decomposition tables...
	@sh ./bin/fetch-chise-decomp.sh > $@

data/dict/cc-cedict-singles.csv: ./bin/fetch-cc-cedict-singles.sh data/dict/cc-cedict.csv
	@echo Computing cc-cedict single entries patch...
	@sh ./bin/fetch-cc-cedict-singles.sh data/dict/cc-cedict.csv > $@

data/dict/cfdict-singles.csv: ./bin/fetch-cc-cedict-singles.sh data/dict/cfdict.csv
	@echo Computing CFDICT single entries patch...
	@sh ./bin/fetch-cc-cedict-singles.sh data/dict/cfdict.csv > $@

data/dict/handedict-singles.csv: ./bin/fetch-cc-cedict-singles.sh data/dict/handedict.csv
	@echo Computing HanDeDict single entries patch...
	@sh ./bin/fetch-cc-cedict-singles.sh data/dict/handedict.csv > $@