Show inside ignored folders in comment

Author: vpellan

.github/scripts/typing_stats_compare.rb

@@ -111,13 +111,13 @@ def create_summary(
 
 def ignored_files_summary(head_stats, base_stats)
   # This will skip the summary if files are added/removed from contrib folders for now.
-  ignored_files_added = head_stats[:ignored_files][:paths] - base_stats[:ignored_files][:paths]
-  ignored_files_removed = base_stats[:ignored_files][:paths] - head_stats[:ignored_files][:paths]
+  ignored_files_added = head_stats[:ignored_files] - base_stats[:ignored_files]
+  ignored_files_removed = base_stats[:ignored_files] - head_stats[:ignored_files]
 
   return nil if ignored_files_added.empty? && ignored_files_removed.empty?
 
-  typed_files_percentage_base = ((base_stats[:total_files_size] - base_stats[:ignored_files][:size]) / base_stats[:total_files_size].to_f * 100).round(2)
-  typed_files_percentage_head = ((head_stats[:total_files_size] - head_stats[:ignored_files][:size]) / head_stats[:total_files_size].to_f * 100).round(2)
+  typed_files_percentage_base = ((base_stats[:total_files_size] - base_stats[:ignored_files].size) / base_stats[:total_files_size].to_f * 100).round(2)
+  typed_files_percentage_head = ((head_stats[:total_files_size] - head_stats[:ignored_files].size) / head_stats[:total_files_size].to_f * 100).round(2)
 
   intro = create_intro(
     added: ignored_files_added,

.github/scripts/typing_stats_compute.rb

@@ -10,23 +10,29 @@
 PROTOTYPE_INITIALIZE = /\s*(?:public|private)?\s*def\s+initialize:\s*#{PARAMETERS}(?:\s*\??\{\s*#{PARAMETERS}\s*->\s*untyped\s*\})?\s*->\s*void/
 PROTOTYPE_METHOD = /\s*(?:public|private)?\s*def\s+(?:self\??\.)?(?:[^\s]+):\s*#{PARAMETERS}(?:\s*\??\{\s*#{PARAMETERS}\s*->\s*untyped\s*\})?\s*->\s*untyped/
 
-# TODO: Find untyped/partially typed attributes, instance variables, class variables, constants
-
 steepfile_path = Pathname(ENV["STEEPFILE_PATH"])
 project = Steep::Project.new(steepfile_path: steepfile_path).tap do |project|
   Steep::Project::DSL.parse(project, steepfile_path.read, filename: steepfile_path.to_s)
 end
 datadog_target = project.targets&.find { |target| target.name == :datadog }
 loader = ::Steep::Services::FileLoader.new(base_dir: project.base_dir)
 
-ignored_paths = datadog_target&.source_pattern&.ignores
+ignored_paths_with_folders = datadog_target&.source_pattern&.ignores
+
+ignored_files = ignored_paths_with_folders.each_with_object([]) do |ignored_path, result|
+  # If the ignored path is a folder, add all the .rb files in the folder to the ignored paths
+  if ignored_path.end_with?("/")
+    result.push(*Dir.glob(ignored_path + "**/*.rb"))
+  else
+    result.push(ignored_path)
+  end
+end
 
 # List signature files that are not related to ignored files
 signature_paths_with_ignored_files = loader.each_path_in_patterns(datadog_target.signature_pattern)
 signature_paths = signature_paths_with_ignored_files.reject do |sig_path|
-  # replace sig/ with lib/ and .rbs with .rb
   corresponding_lib_file = sig_path.to_s.sub(/^sig/, "lib").sub(/\.rbs$/, ".rb")
-  ignored_paths.any? do |ignored|
+  ignored_paths_with_folders.any? do |ignored|
     if ignored.end_with?("/")
       # Directory ignore - check if signature file is inside this directory
       corresponding_lib_file.start_with?(ignored)
@@ -37,14 +43,6 @@
   end
 end
 
-# Ignored files stats
-ignored_files_size = ignored_paths.inject(0) do |result, path|
-  if path.end_with?("/")
-    result + Dir.glob(path + "**/*.rb").size
-  else
-    result + 1
-  end
-end
 total_files_size = Dir.glob("#{project.base_dir}/lib/**/*.rb").size
 
 # steep:ignore comments stats
@@ -121,10 +119,7 @@
 
 resulting_stats = {
   total_files_size: total_files_size,
-  ignored_files: {
-    size: ignored_files_size, # Required as we don't list all ignored files, but only their paths
-    paths: ignored_paths
-  },
+  ignored_files: ignored_files,
 
   steep_ignore_comments: ignore_comments,