Update logger to use context of the package name

Author: miry

src/cli.cr

@@ -177,17 +177,18 @@ begin
   Shards.run
 rescue ex : OptionParser::InvalidOption
   Shards::Log.fatal(exception: ex) { ex.message }
+  Shards::Log.trace { ex.inspect_with_backtrace }
   exit 1
 rescue ex : Shards::ParseError
   ex.to_s(STDERR)
   exit 1
 rescue ex : Shards::Package::Error
   package = ex.package
   Shards::Log.error(exception: ex) { "Failed to install `#{package.name}`: #{ex.message}" }
-  Shards::Log.debug { ex.inspect_with_backtrace }
+  Shards::Log.trace { ex.inspect_with_backtrace }
   exit 1
 rescue ex : Shards::Error
   Shards::Log.error(exception: ex) { ex.message }
-  Shards::Log.debug { ex.inspect_with_backtrace }
+  Shards::Log.trace { ex.inspect_with_backtrace }
   exit 1
 end

src/commands/install.cr

@@ -65,19 +65,16 @@ module Shards
         # packages are returned by the solver in reverse topological order,
         # so transitive dependencies are installed first
         packages.each do |package|
-          Log.with_context do
-            Log.context.set package: package.name
-            # first install the dependency:
-            next unless install(package)
-
-            # then execute the postinstall script
-            # (with access to all transitive dependencies):
-            package.postinstall
-
-            # always install executables because the path resolver never actually
-            # installs dependencies:
-            package.install_executables
-          end
+          # first install the dependency:
+          next unless install(package)
+
+          # then execute the postinstall script
+          # (with access to all transitive dependencies):
+          package.postinstall
+
+          # always install executables because the path resolver never actually
+          # installs dependencies:
+          package.install_executables
         end
       end
 

src/logger.cr

@@ -30,8 +30,9 @@ module Shards
 
   FORMATTER = ::Log::Formatter.new do |entry, io|
     message = entry.message
-
+    package_name = entry.context[:package]?
     if @@colors
+      io << "[" << package_name.colorize(:blue).to_s << "] " if package_name && entry.severity <= ::Log::Severity::Debug
       io << if color = LOGGER_COLORS[entry.severity]?
         if idx = message.index(' ')
           message[0...idx].colorize(color).to_s + message[idx..-1]
@@ -42,7 +43,9 @@ module Shards
         message
       end
     else
-      io << entry.severity.label[0] << ": " << message
+      io << entry.severity.label[0] << ": "
+      io << "[" << package_name << "] " if package_name && entry.severity <= ::Log::Severity::Debug
+      io << message
     end
   end
 end

src/molinillo_solver.cr

@@ -61,7 +61,9 @@ module Shards
         end
         spawn do
           begin
-            dep.resolver.update_local_cache if dep.resolver.is_a? GitResolver
+            Log.with_context(package: dep.name) do
+              dep.resolver.update_local_cache if dep.resolver.is_a? GitResolver
+            end
             ch.send(nil)
           rescue ex : Exception
             ch.send(ex)

src/package.cr

@@ -66,15 +66,17 @@ module Shards
     end
 
     def install
-      cleanup_install_directory
+      Log.with_context(package: name, version: report_version) do
+        cleanup_install_directory
 
-      # install the shard:
-      resolver.install_sources(version, install_path)
+        # install the shard:
+        resolver.install_sources(version, install_path)
 
-      # link the project's lib path as the shard's lib path, so the dependency
-      # can access transitive dependencies:
-      unless resolver.is_a?(PathResolver)
-        install_lib_path
+        # link the project's lib path as the shard's lib path, so the dependency
+        # can access transitive dependencies:
+        unless resolver.is_a?(PathResolver)
+          install_lib_path
+        end
       end
 
       Shards.info.installed[name] = self

src/resolvers/git.cr

@@ -363,7 +363,9 @@ module Shards
 
     private def valid_repository?
       command = "git config --get remote.origin.mirror"
-      Log.debug { command }
+      Log.with_context(package: name) do
+        Log.debug { command }
+      end
 
       output = Process.run(command, shell: true, output: :pipe, chdir: local_path) do |process|
         process.output.gets_to_end
@@ -437,7 +439,9 @@ module Shards
         raise Error.new("Error missing git command line tool. Please install Git first!")
       end
 
-      Log.debug { command }
+      Log.with_context(package: name) do
+        Log.debug { command }
+      end
 
       output = capture ? IO::Memory.new : Process::Redirect::Close
       error = IO::Memory.new