Add ignored files part

Author: vpellan

.github/scripts/typing_stats_compare.rb

@@ -1,58 +1,51 @@
 #!/usr/bin/env ruby
 
-require 'json'
+# frozen_string_literal: true
 
-current_stats = JSON.parse(File.read(ENV['CURRENT_STATS_PATH']), symbolize_names: true)
-base_stats = JSON.parse(File.read(ENV['BASE_STATS_PATH']), symbolize_names: true)
+require "json"
+
+head_stats = JSON.parse(File.read(ENV["CURRENT_STATS_PATH"]), symbolize_names: true)
+base_stats = JSON.parse(File.read(ENV["BASE_STATS_PATH"]), symbolize_names: true)
 
 # If a file is added in contrib, currently the paths will have no diff.
-ignored_files_paths_added = current_stats[:ignored_files][:paths] - base_stats[:ignored_files][:paths]
-ignored_files_paths_removed = base_stats[:ignored_files][:paths] - current_stats[:ignored_files][:paths]
-
-steep_ignores_added = current_stats[:steep_ignore_comments] - base_stats[:steep_ignore_comments]
-steep_ignores_removed = base_stats[:steep_ignore_comments] - current_stats[:steep_ignore_comments]
-
-untyped_methods_added = current_stats[:untyped_methods] - base_stats[:untyped_methods]
-untyped_methods_removed = base_stats[:untyped_methods] - current_stats[:untyped_methods]
-
-partially_typed_methods_added = current_stats[:partially_typed_methods] - base_stats[:partially_typed_methods]
-partially_typed_methods_removed = base_stats[:partially_typed_methods] - current_stats[:partially_typed_methods]
-
-untyped_others_added = current_stats[:untyped_others] - base_stats[:untyped_others]
-untyped_others_removed = base_stats[:untyped_others] - current_stats[:untyped_others]
-
-partially_typed_others_added = current_stats[:partially_typed_others] - base_stats[:partially_typed_others]
-partially_typed_others_removed = base_stats[:partially_typed_others] - current_stats[:partially_typed_others]
-
-diff_stats = {
-  ignored_files: {
-    added: ignored_files_paths_added,
-    removed: ignored_files_paths_removed
-  },
-  steep_ignores: {
-    added: steep_ignores_added,
-    removed: steep_ignores_removed
-  },
-  methods: {
-    untyped: {
-      added: untyped_methods_added,
-      removed: untyped_methods_removed
-    },
-    partially_typed: {
-      added: partially_typed_methods_added,
-      removed: partially_typed_methods_removed
-    }
-  },
-  others: {
-    untyped: {
-      added: untyped_others_added,
-      removed: untyped_others_removed
-    },
-    partially_typed: {
-      added: partially_typed_others_added,
-      removed: partially_typed_others_removed
-    }
-  }
+ignored_files = {
+  added: head_stats[:ignored_files][:paths] - base_stats[:ignored_files][:paths],
+  removed: base_stats[:ignored_files][:paths] - head_stats[:ignored_files][:paths]
 }
 
-puts diff_stats.to_json
+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]
+  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)
+
+  summary = +"This PR "
+  summary << "adds **#{ignored_files_added.size}** ignored files " if ignored_files_added.any?
+  summary << "and " if ignored_files_added.any? && ignored_files_removed.any?
+  summary << "removes **#{ignored_files_removed.size}** ignored files " if ignored_files_removed.any?
+  if typed_files_percentage_base != typed_files_percentage_head
+    summary << "which #{(typed_files_percentage_base > typed_files_percentage_head) ? "decreases" : "increases"} the percentage of typed files from #{typed_files_percentage_base}% to #{typed_files_percentage_head}% (**#{typed_files_percentage_head - typed_files_percentage_base}**%)"
+  end
+  summary << "."
+
+  <<~IGNORED_FILES
+    ### Ignored files
+    #{summary}
+    <details><summary>Ignored files</summary>
+      #{"<em>Added:</em>" if ignored_files_added.any?}
+      #{"<pre><code>#{ignored_files_added.join("\n")}</code></pre>" if ignored_files_added.any?}
+      #{"<em>Removed:</em>" if ignored_files_removed.any?}
+      #{"<pre><code>#{ignored_files_removed.join("\n")}</code></pre>" if ignored_files_removed.any?}
+    </details>
+
+    *__Note__: Ignored files are excluded from the next sections.*
+
+  IGNORED_FILES
+end
+
+result = +""
+result << ignored_files_summary(head_stats, base_stats)
+result

.github/workflows/typing-stats.yml

@@ -15,6 +15,24 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-24.04
     steps:
+      - name: Find existing comment
+        id: comment
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const options = github.rest.issues.listComments.endpoint.merge({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+            });
+            const comments = await github.paginate(options)
+            const comment = comments.find((cmnt) => {
+              return cmnt.body.startsWith("<!-- TYPING_STATS_HIDDEN_MARKER -->")
+            })
+
+            return undefined === comment ? null : comment.id
+
       - name: Checkout current branch
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
@@ -58,5 +76,32 @@ jobs:
         env:
           CURRENT_STATS_PATH: ${{ runner.temp }}/typing-stats-current.json
           BASE_STATS_PATH: ${{ runner.temp }}/typing-stats-base.json
-        # run: ruby ${{ runner.temp }}/typing_stats_compare.rb >> "${{ runner.temp }}/typing-stats-compare.json"
-        run: ruby ${{ runner.temp }}/typing_stats_compare.rb
+        run: ruby ${{ runner.temp }}/typing_stats_compare.rb >> "${{ runner.temp }}/typing-stats-compare.md"
+
+      - name: Write comment
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            var fs = require('fs')
+
+            const previousCommentId = ${{steps.comment.outputs.result}}
+            const commentContent = fs.readFileSync("${{ runner.temp }}/typing-stats-compare.md", "utf8")
+            const commentBody = `<!-- TYPING_STATS_HIDDEN_MARKER -->
+            ## Typing analysis
+
+            ${commentContent}
+            `
+
+            const options = {
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              body: commentBody
+            }
+
+            if (null === previousCommentId) {
+              await github.rest.issues.createComment(options)
+            } else {
+              await github.rest.issues.updateComment({...options, comment_id: previousCommentId})
+            }