Including strict warnings

Author: aweiker

config/.credo.exs

@@ -0,0 +1,91 @@
+# This file contains the configuration for Credo.
+#
+# If you find anything wrong or unclear in this file, please report an
+# issue on GitHub: https://github.com/rrrene/credo/issues
+%{
+  #
+  # You can have as many configs as you like in the `configs:` field.
+  configs: [
+    %{
+      #
+      # Run any config using `mix credo -C <name>`. If no config name is given
+      # "default" is used.
+      name: "default",
+      #
+      # these are the files included in the analysis
+      files: %{
+        #
+        # you can give explicit globs or simply directories
+        # in the latter case `**/*.{ex,exs}` will be used
+        included: ["lib/", "src/", "web/", "apps/"],
+        excluded: []
+      },
+      #
+      # The `checks:` field contains all the checks that are run. You can
+      # customize the parameters of any given check by adding a second element
+      # to the tuple.
+      #
+      # There are two ways of deactivating a check:
+      # 1. deleting the check from this list
+      # 2. putting `false` as second element (to quickly "comment it out"):
+      #
+      #      {Credo.Check.Consistency.ExceptionNames, false}
+      #
+      checks: [
+        {Credo.Check.Consistency.ExceptionNames},
+        {Credo.Check.Consistency.LineEndings},
+        {Credo.Check.Consistency.SpaceAroundOperators},
+        {Credo.Check.Consistency.SpaceInParentheses},
+        {Credo.Check.Consistency.TabsOrSpaces},
+
+        # For some checks, like AliasUsage, you can only customize the priority
+        # Priority values are: `low, normal, high, higher`
+        {Credo.Check.Design.AliasUsage, priority: :low},
+        # For others you can set parameters
+        {Credo.Check.Design.DuplicatedCode, mass_threshold: 16, nodes_threshold: 2},
+
+        # You can also customize the exit_status of each check.
+        # If you don't want TODO comments to cause `mix credo` to fail, just
+        # set this value to 0 (zero).
+        {Credo.Check.Design.TagTODO, false},
+        {Credo.Check.Design.TagFIXME},
+
+        {Credo.Check.Readability.FunctionNames},
+        {Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 120},
+        {Credo.Check.Readability.ModuleAttributeNames},
+        {Credo.Check.Readability.ModuleDoc},
+        {Credo.Check.Readability.ModuleNames},
+        {Credo.Check.Readability.PredicateFunctionNames},
+        {Credo.Check.Readability.TrailingBlankLine},
+        {Credo.Check.Readability.TrailingWhiteSpace},
+        {Credo.Check.Readability.VariableNames},
+
+        {Credo.Check.Refactor.ABCSize},
+        {Credo.Check.Refactor.CaseTrivialMatches},
+        {Credo.Check.Refactor.CondStatements},
+        {Credo.Check.Refactor.FunctionArity},
+        {Credo.Check.Refactor.MatchInCondition},
+        {Credo.Check.Refactor.PipeChainStart},
+        {Credo.Check.Refactor.CyclomaticComplexity},
+        {Credo.Check.Refactor.NegatedConditionsInUnless},
+        {Credo.Check.Refactor.NegatedConditionsWithElse},
+        {Credo.Check.Refactor.Nesting},
+        {Credo.Check.Refactor.UnlessWithElse},
+
+        {Credo.Check.Warning.IExPry},
+        {Credo.Check.Warning.IoInspect},
+        {Credo.Check.Warning.NameRedeclarationByAssignment},
+        {Credo.Check.Warning.NameRedeclarationByCase},
+        {Credo.Check.Warning.NameRedeclarationByDef},
+        {Credo.Check.Warning.NameRedeclarationByFn},
+        {Credo.Check.Warning.OperationOnSameValues},
+        {Credo.Check.Warning.UnusedEnumOperation},
+        {Credo.Check.Warning.UnusedKeywordOperation},
+        {Credo.Check.Warning.UnusedListOperation},
+        {Credo.Check.Warning.UnusedStringOperation},
+        {Credo.Check.Warning.UnusedTupleOperation},
+        {Credo.Check.Warning.OperationWithConstantResult},
+      ]
+    }
+  ]
+}

lib/graphql/plug.ex

@@ -18,25 +18,28 @@ defmodule GraphQL.Plug do
   """
 
   use Plug.Builder
+  alias GraphQL.Schema
+  alias GraphQL.Plug.{GraphiQL, Endpoint}
+  alias Plug.Parsers
 
   require Logger
 
-  plug Plug.Parsers,
+  plug Parsers,
     parsers: [:graphql, :urlencoded, :multipart, :json],
     pass: ["*/*"],
     json_decoder: Poison
 
   @type init :: %{
-    schema: GraphQL.Schema.t,
+    schema: Schema.t,
     root_value: ConfigurableValue.t,
     query:  ConfigurableValue.t,
     allow_graphiql?: true | false
   }
 
   @spec init(Map) :: init
   def init(opts) do
-    graphiql = GraphQL.Plug.GraphiQL.init(opts)
-    endpoint = GraphQL.Plug.Endpoint.init(opts)
+    graphiql = GraphiQL.init(opts)
+    endpoint = Endpoint.init(opts)
 
     opts = Keyword.merge(graphiql, endpoint)
     Enum.dedup(opts)
@@ -45,10 +48,10 @@ defmodule GraphQL.Plug do
   def call(conn, opts) do
     conn = super(conn, opts)
 
-    conn = if GraphQL.Plug.GraphiQL.use_graphiql?(conn, opts) do
-      GraphQL.Plug.GraphiQL.call(conn, opts)
+    conn = if GraphiQL.use_graphiql?(conn, opts) do
+      GraphiQL.call(conn, opts)
     else
-      GraphQL.Plug.Endpoint.call(conn, opts)
+      Endpoint.call(conn, opts)
     end
 
     # TODO consider not logging instrospection queries

lib/graphql/plug/configurable_value.ex

@@ -9,8 +9,10 @@ defmodule GraphQL.Plug.ConfigurableValue do
   an arity of 1 accepting a `Plug.Conn`.
   """
 
-  @type t :: {module, atom} | (Plug.Conn.t -> Map) | Map | nil
-  @spec evaluate(Plug.Conn.t, t, any) :: Map
+  alias Plug.Conn
+
+  @type t :: {module, atom} | (Conn.t -> Map) | Map | nil
+  @spec evaluate(Conn.t, t, any) :: Map
 
   @error_msg "Configured function must only be arity of 1 that accepts a value of Plug.Conn"
 

lib/graphql/plug/parameter.ex

@@ -4,21 +4,23 @@ defmodule GraphQL.Plug.Parameter do
   value from `Plug.Conn`
   """
 
-  @spec operation_name(Plug.Conn.t) :: String.t
+  alias Plug.Conn
+
+  @spec operation_name(Conn.t) :: String.t
   def operation_name(conn) do
     conn
     |> operation_name_params
     |> cleanup_string
   end
 
-  @spec query(Plug.Conn.t) :: String.t | nil
+  @spec query(Conn.t) :: String.t | nil
   def query(conn) do
     conn.params
     |> Map.get("query")
     |> cleanup_string
   end
 
-  @spec variables(Plug.Conn.t) :: Map
+  @spec variables(Conn.t) :: Map
   def variables(conn) do
     decode_variables(Map.get(conn.params, "variables", %{}))
   end