Makefile

all: test-before-build build test-after-build
production: clean all production-test

## If we call git in our tests without using the --no-pager option
## or redirecting stdout to another command, fail unconditionally.
## This addresses an issue where `make` can't be run within an IDE because
## it tries to paginate the output, see:
## https://github.com/bitcoinops/bitcoinops.github.io/pull/494#discussion_r546376335
export GIT_PAGER='_contrib/kill0'
JEKYLL_FLAGS = --future --drafts --unpublished --incremental

## Expected filenames in output directory
compatibility_validation = $(wildcard _compat/en/*.md)
compatibility_validation := $(patsubst _compat/en/%.md,_site/en/compatibility/%/index.html,$(compatibility_validation))
topic_validation = $(wildcard _topics/en/*.md)
topic_validation := $(patsubst _topics/en/%.md,_site/en/topics/%/index.html,$(topic_validation))

clean:
	bundle exec jekyll clean

preview:
	## Don't do a full rebuild (to save time), but always rebuild index pages.
	rm -f _site/index.html \
	      _site/*/blog/index.html \
	      _site/*/newsletters/index.html \
	      _site/*/publications/index.html \
	      _site/*/topics/categories/index.html \
	      _site/*/topics/dates/index.html \
	      _site/*/topics/index.html
	bundle exec jekyll serve --host 0.0.0.0 $(JEKYLL_FLAGS)

build:
	@# Tiny sleep for when running concurrently to ensure output
	@# files aren't created before changed input files are marked
	@# for schema validation.
	@sleep 0.1

	bundle exec jekyll build $(JEKYLL_FLAGS)


test-before-build: $(compatibility_validation) $(topic_validation)
	## Check for Markdown formatting problems
	@ ## - MD009: trailing spaces (can lead to extraneous <br> tags
	bundle exec mdl -g -r MD009 .

	## Hugo will end a paragraph if a line within it starts an HTML comment; we don't want that
	! git grep -l '^ *<!--' '*.md' | xargs perl -0777 -ne 'print "$$ARGV\n" if /.+\n^ *<!--/m' | grep .

	## Check that posts declare certain fields, see issue #155 and PR #156
	! git --no-pager grep -L "^slug: " _posts
	! git --no-pager grep -L "^title: " _posts
	! git --no-pager grep -L "^permalink: " _posts
	! git --no-pager grep -L "^name: " _posts
	## Check that all slugs are unique
	! git --no-pager grep -h "^slug: " _posts | sort | uniq -d | grep .
	## Check that all post titles are unique (per language)
	! git --no-pager grep -h "^title: " _posts/en | sort | uniq -d | grep .
	! git --no-pager grep -h "^title: " _posts/es | sort | uniq -d | grep .
	! git --no-pager grep -h "^title: " _posts/ja | sort | uniq -d | grep .
	## Check for things that should probably all be on one line
	@ ## Note: double $$ in a makefile produces a single literal $
	! git --no-pager grep -- '^ *- \*\*[^*]*$$'
	! git --no-pager grep -- '^ *- \[[^]]*$$'
	## Check for unnecessarily fully qualified URLs (breaks local previews and internal link checking)
	! git --no-pager grep -- '^\[.*]: https://bitcoinops.org' | grep -v skip-test | grep .
	! git --no-pager grep -- '](https://bitcoinops.org' | grep -v skip-test | grep .
	## Check for duplicate words
	@ ## Only applies to *.md files
	@ ## Add <!-- skip-duplicate-words-test --> to same line to skip this test
	@ ## Ignores any strings with non alphabetical characters
	export LC_ALL=C ; ! git ls-files '*.md' | grep -v /podcast/ | while read file ; do \
	    cat $$file \
	      | sed '/skip-duplicate-words-test/d' \
	      | sed '/^#/d' \
	      | tr ' ' '\n' \
	      | sed 's/ *//g;' \
	      | sed 's/^.*[^a-zA-Z].*/ /; /^$$/d;' \
	      | uniq -d \
	      | sed '/^ $$/d' \
	      | sed "s|.*|Duplicate word in $$file: &|" ; \
	done | grep .

	## Check that newly added or modifyed PNGs are optimized
	_contrib/travis-check-png-optimized.sh

	## Check for duplicate links in any particular topic file
	! git grep url:  _topics/ | sed 's/ \+/ /g' | sort | uniq -d | grep .

	## Check for mistakes typical spell checkers can't catch
	! git --no-pager grep -i '[d]iscrete log contract'
	! git --no-pager grep -i '[r]eplaca' # e.g., replaceability
	! git --no-pager grep -i '[h]tlc expiry delta' # instead use: CLTV expiry delta

	## Check for indentation that's forward incompatible with Hugo
	! git ls-files '*.md' | xargs -i _contrib/find-bad-indentation '{}' | grep .

test-after-build: build
	## Check for broken Markdown reference-style links that are displayed in text unchanged, e.g. [broken][broken link]
	! find _site/ -name '*.html' | xargs grep ']\[' | grep -v skip-test | grep .
	! find _site/ -name '*.html' | xargs grep '\[^' | grep .
	! find _site/ -name '*.html' | xargs grep '\[\]' | grep -v skip-test | grep .
	! find _site/ -name '*.html' | xargs grep 'timestamp=' | grep -v skip-test | grep .

	## Check for duplicate anchors
	! find _site/ -name '*.html' | while read file ; do \
	  cat $$file \
	  | egrep -o "(id|name)=[\"'][^\"']*[\"']" \
	  | sed -E "s/^(id|name)=//; s/[\"']//g" \
	  | sort | uniq -d \
	  | sed "s|.*|Duplicate anchor in $$file: #&|" ; \
	done | grep .

	## Check for broken links
	bundle exec htmlproofer --check-html --disable-external --url-ignore '/^\/bin/.*/' ./_site

## Tests to run last because they identify problems that may not be fixable during initial commit review.
## However, these should not be still failing when the site goes to production
production-test:
	## Fail if there are any FIXMEs in site source code; add "skip-test" to the same line of source code to skip
	! git --no-pager grep FIXME | grep -v skip-test | grep .

new-topic:
	_contrib/new-topic

email: clean
	@ echo
	@ echo "[NOTICE] Latest Newsletter: http://localhost:4000/en/newsletters/$$(ls _posts/en/newsletters/ | tail -1 | tr "-" "/" | sed 's/newsletter.md//')"
	@ echo
	$(MAKE) preview JEKYLL_ENV=email

## Path-based rules
_site/en/compatibility/%/index.html : _compat/en/%.md
	bundle exec _contrib/schema-validator.rb _data/schemas/compatibility.yaml $<

_site/en/topics/%/index.html : _topics/en/%.md
	bundle exec _contrib/schema-validator.rb _data/schemas/topics.yaml $<