Browse Source

List third party plugins; remove Elvis

This is a breaking change for Elvis users, who should now
use the external plugin available at https://github.com/inaka/elvis.mk
Loïc Hoguin 9 years ago
parent
commit
fd32ae501b
4 changed files with 27 additions and 40 deletions
  1. 0 1
      build.config
  2. 2 0
      doc/src/guide/book.asciidoc
  3. 25 0
      doc/src/guide/external_plugins_list.asciidoc
  4. 0 39
      plugins/elvis.mk

+ 0 - 1
build.config

@@ -28,7 +28,6 @@ plugins/ci
 plugins/ct
 plugins/dialyzer
 plugins/edoc
-plugins/elvis
 plugins/escript
 plugins/eunit
 plugins/relx

+ 2 - 0
doc/src/guide/book.asciidoc

@@ -61,6 +61,8 @@ include::xref.asciidoc[Xref]
 
 include::external_plugins.asciidoc[External plugins]
 
+include::external_plugins_list.asciidoc[List of plugins]
+
 [[about]]
 = About Erlang.mk
 

+ 25 - 0
doc/src/guide/external_plugins_list.asciidoc

@@ -0,0 +1,25 @@
+[[plugins_list]]
+== List of plugins
+
+This is a non-exhaustive list of Erlang.mk plugins, sorted
+alphabetically.
+
+=== elvis.mk
+
+An https://github.com/inaka/elvis.mk[Elvis plugin] for Erlang.mk.
+Elvis is an https://github.com/inaka/elvis[Erlang style reviewer].
+
+=== geas
+
+https://github.com/crownedgrouse/geas[Geas] gives aggregated
+information on a project and its dependencies, and is available
+as an Erlang.mk plugin.
+
+=== hexer.mk
+
+An https://github.com/inaka/hexer.mk[Hex plugin] for Erlang.mk.
+Hex is a https://hex.pm/[package manager for the Elixir ecosystem].
+
+=== reload.mk
+
+A https://github.com/bullno1/reload.mk[live reload plugin] for Erlang.mk.

+ 0 - 39
plugins/elvis.mk

@@ -1,39 +0,0 @@
-# Copyright (c) 2015, Erlang Solutions Ltd.
-# This file is part of erlang.mk and subject to the terms of the ISC License.
-
-.PHONY: elvis distclean-elvis
-
-# Configuration.
-
-ELVIS_CONFIG ?= $(CURDIR)/elvis.config
-
-ELVIS ?= $(CURDIR)/elvis
-export ELVIS
-
-ELVIS_URL ?= https://github.com/inaka/elvis/releases/download/0.2.5/elvis
-ELVIS_CONFIG_URL ?= https://github.com/inaka/elvis/releases/download/0.2.5/elvis.config
-ELVIS_OPTS ?=
-
-# Core targets.
-
-help::
-	$(verbose) printf "%s\n" "" \
-		"Elvis targets:" \
-		"  elvis       Run Elvis using the local elvis.config or download the default otherwise"
-
-distclean:: distclean-elvis
-
-# Plugin-specific targets.
-
-$(ELVIS):
-	$(gen_verbose) $(call core_http_get,$(ELVIS),$(ELVIS_URL))
-	$(verbose) chmod +x $(ELVIS)
-
-$(ELVIS_CONFIG):
-	$(verbose) $(call core_http_get,$(ELVIS_CONFIG),$(ELVIS_CONFIG_URL))
-
-elvis: $(ELVIS) $(ELVIS_CONFIG)
-	$(verbose) $(ELVIS) rock -c $(ELVIS_CONFIG) $(ELVIS_OPTS)
-
-distclean-elvis:
-	$(gen_verbose) rm -rf $(ELVIS)