Merge pull request #2 from project-fifo/copy-elvis

Copy in the elvis files
inaka · Nov 25, 2015 · c5e813e · c5e813e
2 parents d5cf013 + 7773bf7
commit c5e813e
Show file tree

Hide file tree

Showing 73 changed files with 7,036 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,13 @@
 .eunit
+.rebar
 deps
+ebin
 *.o
 *.beam
 *.plt
 erl_crash.dump
-ebin
-rel/example_project
-.concrete/DEV_MODE
-.rebar
+log*/
+.erlang.mk.packages.*
+_build
+# Ignore elvis escript
+elvis
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+# Contribute
+
+Before anything else... Thank you for your time and contributions!
+
+## Issues (New Features, Rules & Bug Reports)
+
+If you have a feature or rule you want to see added to Elvis, please create an
+[issue](https://github.com/inaka/elvis/issues) before doing any work, so that we can discuss it and figure
+out what to do about it.
+
+In the case of rules, keep in mind you can always create your [User Defined Rules](https://github.com/inaka/elvis#user-defined-rules), in order to run them locally.
+
+When you find a bug in one of Elvis's rules or the way Elvis itself work, please provide detailed steps
+that show how to reproduce the problem.
+
+## Rules
+
+When an issue is already marked with the `rule` label and you are interested in working on it, first check
+there is no existing [branch](https://github.com/inaka/elvis/branches) with the issue's number, If so, you
+can go ahead and start working on it.
+
+The following is a checklist you can follow when implementing a new Elvis rule:
+
+- [ ] Write both test cases that fail and that pass the rule.
+- [ ] Edit the [Rules](https://github.com/inaka/elvis/wiki/Rules) wiki page, by adding the rule to the list.
+- [ ] When the issue has the label `default rule`, add the rule to [Default Rules in Elvis Webhook](https://github.com/inaka/elvis/wiki/Default-Rules-in-Elvis-Webhook) and in the [`config/elvis.config`](https://github.com/inaka/elvis/blob/master/config/elvis.config) file.
+
+## Questions?
+
+If you have any questions or general comments regarding how to contribute, please use our public [hipchat room](http://inaka.net/hipchat).
diff --git a/Makefile b/Makefile
@@ -0,0 +1,46 @@
+PROJECT = elvis
+
+DEPS = lager zipper katana
+
+dep_lager = git https://github.com/basho/lager.git 3.0.2
+dep_zipper = git https://github.com/inaka/zipper 0.1.2
+dep_katana =  git https://github.com/inaka/erlang-katana 0.2.13
+
+TEST_DEPS = meck
+
+dep_meck = git https://github.com/eproxus/meck 0.8.3
+
+include erlang.mk
+
+ERLC_OPTS += +'{parse_transform, lager_transform}'
+ERLC_OPTS += +warn_unused_vars +warn_export_all +warn_shadow_vars +warn_unused_import +warn_unused_function
+ERLC_OPTS += +warn_bif_clash +warn_unused_record +warn_deprecated_function +warn_obsolete_guard +strict_validation
+ERLC_OPTS += +warn_export_vars +warn_exported_vars +warn_missing_spec +warn_untyped_record +debug_info
+
+# Commont Test Config
+
+TEST_ERLC_OPTS += +'{parse_transform, lager_transform}'
+CT_OPTS = -cover test/elvis.coverspec -erl_args -config config/test.config
+
+# Builds the elvis escript.
+escript: all
+	rebar escriptize
+	./elvis help
+
+shell: app
+	erl -pa ebin -pa deps/*/ebin -name elvis@`hostname` -s sync -s elvis -s lager -config config/elvis.config
+
+test-shell: build-ct-suites app
+	erl -pa ebin -pa deps/*/ebin -name elvis-test@`hostname` -pa test -s sync -s elvis -s lager -config config/test.config
+
+install: escript
+	cp elvis /usr/local/bin
+
+quicktests: ERLC_OPTS = $(TEST_ERLC_OPTS)
+quicktests: clean app build-ct-suites
+	@if [ -d "test" ] ; \
+	then \
+		mkdir -p logs/ ; \
+		$(CT_RUN) -suite $(addsuffix _SUITE,$(CT_SUITES)) $(CT_OPTS) ; \
+	fi
+	$(gen_verbose) rm -f test/*.beam
diff --git a/config/elvis-test-pa.config b/config/elvis-test-pa.config
@@ -0,0 +1,14 @@
+[
+ {
+   elvis,
+   [
+    {config,
+     [#{dirs => ["../../test/examples"],
+        filter => "user_defined_rules.erl",
+        rules => [{user_defined_rules, rule}]
+       }
+     ]
+    }
+   ]
+ }
+].
diff --git a/config/elvis-test.config b/config/elvis-test.config
@@ -0,0 +1,50 @@
+[
+ {
+   elvis,
+   [
+    {config,
+     [#{dirs => ["../../src"],
+        filter => "*.erl",
+        rules => [{elvis_style, line_length, #{limit => 80,
+                                               skip_comments => false}},
+                  {elvis_style, no_tabs},
+                  {elvis_style, macro_names},
+                  {elvis_style, macro_module_names},
+                  {elvis_style, operator_spaces, #{rules => [{right, ","},
+                                                             {right, "++"},
+                                                             {left, "++"}]}},
+                  {elvis_style, nesting_level, #{level => 3}},
+                  {elvis_style, god_modules, #{limit => 25}},
+                  {elvis_style, no_if_expression},
+                  {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
+                  {elvis_style, used_ignored_variable},
+                  {elvis_style, no_behavior_info},
+                  {
+                    elvis_style,
+                    module_naming_convention,
+                    #{regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$",
+                      ignore => []}
+                  },
+                  {elvis_style, state_record_and_type},
+                  {elvis_style, no_spec_with_records}
+                 ]
+       },
+      #{dirs => ["."],
+        filter => "Makefile",
+        rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
+       },
+      #{dirs => ["."],
+        filter => "rebar.config",
+        rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
+       },
+      #{dirs => ["."],
+        filter => "elvis.config",
+        rules => [{elvis_project, old_configuration_format}]
+       }
+     ]
+    }
+   ]
+ }
+].
diff --git a/config/elvis.config b/config/elvis.config
@@ -0,0 +1,59 @@
+[
+ {
+   elvis,
+   [
+    {config,
+     [#{dirs => ["src"],
+        filter => "*.erl",
+        rules => [{elvis_style, line_length, #{limit => 80,
+                                               skip_comments => false}},
+                  {elvis_style, no_tabs},
+                  {elvis_style, no_trailing_whitespace},
+                  {elvis_style, macro_names},
+                  {elvis_style, macro_module_names},
+                  {elvis_style, operator_spaces, #{rules => [{right, ","},
+                                                             {right, "++"},
+                                                             {left, "++"}]}},
+                  {elvis_style, nesting_level, #{level => 3}},
+                  {elvis_style, god_modules, #{limit => 25}},
+                  {elvis_style, no_if_expression},
+                  {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
+                  {elvis_style, used_ignored_variable},
+                  {elvis_style, no_behavior_info},
+                  {
+                    elvis_style,
+                    module_naming_convention,
+                    #{regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$",
+                      ignore => []}
+                  },
+                  {
+                    elvis_style,
+                    function_naming_convention,
+                    #{regex => "^([a-z][a-z0-9]*_?)*$"}
+                  },
+                  {elvis_style, state_record_and_type},
+                  {elvis_style, no_spec_with_records},
+                  {elvis_style, dont_repeat_yourself, #{min_complexity => 10}},
+                  {elvis_style, no_debug_call, #{ignore => [elvis,
+                                                            elvis_utils]}}
+                 ]
+       },
+      #{dirs => ["."],
+        filter => "Makefile",
+        rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
+       },
+      #{dirs => ["."],
+        filter => "rebar.config",
+        rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
+       },
+      #{dirs => ["."],
+        filter => "elvis.config",
+        rules => [{elvis_project, old_configuration_format}]
+       }
+     ]
+    }
+   ]
+ }
+].
diff --git a/config/old/elvis-test-rule-config-list.config b/config/old/elvis-test-rule-config-list.config
@@ -0,0 +1,48 @@
+[
+ {
+   elvis,
+   [
+    {config,
+     [#{dirs => ["../../test/examples"],
+        filter => "*.erl",
+        rules => [{elvis_style, line_length, [80]},
+                  {elvis_style, no_tabs, []},
+                  {elvis_style, macro_names, []},
+                  {elvis_style, macro_module_names, []},
+                  {elvis_style, operator_spaces, [{right, ","},
+                                                  {right, "++"},
+                                                  {left, "++"}]},
+                  {elvis_style, nesting_level, [3]},
+                  {elvis_style, god_modules, [25]},
+                  {elvis_style, no_if_expression, []},
+                  {elvis_style, invalid_dynamic_call, [elvis]},
+                  {elvis_style, used_ignored_variable, []},
+                  {elvis_style, no_behavior_info, []},
+                  {
+                    elvis_style,
+                    module_naming_convention,
+                    ["^([a-z][a-z0-9]*_?)*(_SUITE)?$", []]
+                  },
+                  {elvis_style, state_record_and_type, []},
+                  {elvis_style, no_spec_with_records, []}
+                 ]
+       },
+      #{dirs => ["."],
+        filter => "Makefile",
+        rules => [{elvis_project, no_deps_master_erlang_mk, []},
+                  {elvis_project, protocol_for_deps_erlang_mk, []}]
+       },
+      #{dirs => ["."],
+        filter => "rebar.config",
+        rules => [{elvis_project, no_deps_master_rebar, []},
+                  {elvis_project, protocol_for_deps_rebar, []}]
+       },
+      #{dirs => ["."],
+        filter => "elvis.config",
+        rules => [{elvis_project, old_configuration_format, []}]
+       }
+     ]
+    }
+   ]
+ }
+].
diff --git a/config/old/elvis-test.config b/config/old/elvis-test.config
@@ -0,0 +1,32 @@
+[
+ {
+   elvis,
+   [
+    {config,
+     #{src_dirs => ["../../src"],
+       rules => [{elvis_style, line_length, [80]},
+                 {elvis_style, no_tabs, []},
+                 {elvis_style, macro_names, []},
+                 {elvis_style, macro_module_names, []},
+                 {elvis_style, operator_spaces, [{right, ","},
+                                                 {right, "++"},
+                                                 {left, "++"}]},
+                 {elvis_style, nesting_level, [3]},
+                 {elvis_style, god_modules, [25]},
+                 {elvis_style, no_if_expression, []},
+                 {elvis_style, invalid_dynamic_call, [elvis]},
+                 {elvis_style, used_ignored_variable, []},
+                 {elvis_style, no_behavior_info, []},
+                 {
+                   elvis_style,
+                   module_naming_convention,
+                   ["^([a-z][a-z0-9]*_?)*(_SUITE)?$", []]
+                 },
+                 {elvis_style, state_record_and_type, []},
+                 {elvis_style, no_spec_with_records, []}
+                ]
+      }
+    }
+   ]
+ }
+].
diff --git a/config/old/elvis.config b/config/old/elvis.config
@@ -0,0 +1,32 @@
+[
+ {
+   elvis,
+   [
+    {config,
+      #{src_dirs => ["src"],
+        rules    => [{elvis_style, line_length, [80]},
+                     {elvis_style, no_tabs, []},
+                     {elvis_style, macro_names, []},
+                     {elvis_style, macro_module_names, []},
+                     {elvis_style, operator_spaces, [{right, ","},
+                                                     {right, "++"},
+                                                     {left, "++"}]},
+                     {elvis_style, nesting_level, [3]},
+                     {elvis_style, god_modules, [25]},
+                     {elvis_style, no_if_expression, []},
+                     {elvis_style, invalid_dynamic_call, [elvis]},
+                     {elvis_style, used_ignored_variable, []},
+                     {elvis_style, no_behavior_info, []},
+                     {
+                       elvis_style,
+                       module_naming_convention,
+                       ["^([a-z][a-z0-9]*_?)*(_SUITE)?$", []]
+                     },
+                     {elvis_style, state_record_and_type, []},
+                     {elvis_style, no_spec_with_records, []}
+                    ]
+       }
+    }
+   ]
+ }
+].
diff --git a/config/test.config b/config/test.config
@@ -0,0 +1,52 @@
+[
+ {
+   elvis,
+   [
+    {config,
+     [#{dirs => ["../../test/examples"],
+        filter => "**.erl",
+        rules => [{elvis_style, line_length, #{limit => 80,
+                                               skip_comments => false}},
+                  {elvis_style, no_tabs},
+                  {elvis_style, no_trailing_whitespace},
+                  {elvis_style, macro_names},
+                  {elvis_style, macro_module_names},
+                  {elvis_style, operator_spaces, #{rules => [{right, ","},
+                                                             {right, "++"},
+                                                             {left, "++"}]}},
+                  {elvis_style, nesting_level, #{level => 3}},
+                  {elvis_style, god_modules, #{limit => 25}},
+                  {elvis_style, no_if_expression},
+                  {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
+                  {elvis_style, used_ignored_variable},
+                  {elvis_style, no_behavior_info},
+                  {
+                    elvis_style,
+                    module_naming_convention,
+                    #{regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$",
+                      ignore => []}
+                  },
+                  {elvis_style, state_record_and_type},
+                  {elvis_style, no_spec_with_records}
+                 ]
+       },
+      #{dirs => ["."],
+        filter => "Makefile",
+        rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}},
+                  {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}]
+       },
+      #{dirs => ["."],
+        filter => "rebar.config",
+        rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}},
+                  {elvis_project, protocol_for_deps_rebar, #{ignore => []}}]
+       },
+      #{dirs => ["."],
+        filter => "elvis.config",
+        rules => [{elvis_project, old_configuration_format}]
+       }
+     ]
+    },
+    {output_format, plain}
+   ]
+ }
+].