public
Last active

Universal drop in Makefile for Erlang projects that use rebar

  • Download Gist
Makefile
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
# Copyright 2012 Erlware, LLC. All Rights Reserved.
#
# This file is provided to you under the Apache License,
# Version 2.0 (the "License"); you may not use this file
# except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
 
ERLFLAGS= -pa $(CURDIR)/.eunit -pa $(CURDIR)/ebin -pa $(CURDIR)/deps/*/ebin
 
DEPS_PLT=$(CURDIR)/.deps_plt
DEPS=erts kernel stdlib
 
# =============================================================================
# Verify that the programs we need to run are installed on this system
# =============================================================================
ERL = $(shell which erl)
 
ifeq ($(ERL),)
$(error "Erlang not available on this system")
endif
 
REBAR=$(shell which rebar)
 
ifeq ($(REBAR),)
$(error "Rebar not available on this system")
endif
 
.PHONY: all compile doc clean test dialyzer typer shell distclean pdf \
update-deps clean-common-test-data rebuild
 
all: deps compile dialyzer test
 
# =============================================================================
# Rules to build the system
# =============================================================================
 
deps:
$(REBAR) get-deps
$(REBAR) compile
 
update-deps:
$(REBAR) update-deps
$(REBAR) compile
 
compile:
$(REBAR) skip_deps=true compile
 
doc:
$(REBAR) skip_deps=true doc
 
eunit: compile clean-common-test-data
$(REBAR) skip_deps=true eunit
 
test: compile eunit
 
$(DEPS_PLT):
@echo Building local plt at $(DEPS_PLT)
@echo
dialyzer --output_plt $(DEPS_PLT) --build_plt \
--apps $(DEPS) -r deps
 
dialyzer: $(DEPS_PLT)
dialyzer --fullpath --plt $(DEPS_PLT) -Wrace_conditions -r ./ebin
 
typer:
typer --plt $(DEPS_PLT) -r ./src
 
shell: deps compile
# You often want *rebuilt* rebar tests to be available to the
# shell you have to call eunit (to get the tests
# rebuilt). However, eunit runs the tests, which probably
# fails (thats probably why You want them in the shell). This
# runs eunit but tells make to ignore the result.
- @$(REBAR) skip_deps=true eunit
@$(ERL) $(ERLFLAGS)
 
pdf:
pandoc README.md -o README.pdf
 
clean:
- rm -rf $(CURDIR)/test/*.beam
- rm -rf $(CURDIR)/logs
- rm -rf $(CURDIR)/ebin
$(REBAR) skip_deps=true clean
 
distclean: clean
- rm -rf $(DEPS_PLT)
- rm -rvf $(CURDIR)/deps
 
rebuild: distclean deps compile escript dialyzer test

Very cool. Is part of the makefile missing? I don't see a target for clean-common-test-data.

  • @$(REBAR) skip_deps=true eunit

In newer version of rebar, you can also pass in compile_only=true to not actually run the tests.

I don't see target escript either. Typo maybe?

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.