Apply reviewers suggestions

Noarkhh · Noarkhh · commit 4aea944c0b58 · 2025-10-30T12:34:18.000+01:00
diff --git a/guides/packages/00_General.md b/guides/packages/00_General.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_sdk
 Full power of Membrane in a single package 
 
diff --git a/guides/packages/02_Plugins_|_General_purpose.md b/guides/packages/02_Plugins_|_General_purpose.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_file_plugin
 Membrane plugin for reading and writing to files 
 
diff --git a/guides/packages/03_Plugins_|_Streaming_protocols.md b/guides/packages/03_Plugins_|_Streaming_protocols.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_webrtc_plugin
 Plugin for streaming via WebRTC 
 
diff --git a/guides/packages/04_Plugins_|_Containers.md b/guides/packages/04_Plugins_|_Containers.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_mp4_plugin
 Utilities for MP4 container parsing and serialization and elements for muxing the stream to CMAF 
 
diff --git a/guides/packages/05_Plugins_|_Audio_codecs.md b/guides/packages/05_Plugins_|_Audio_codecs.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_aac_plugin
 AAC parser and complementary elements for AAC codec 
 
diff --git a/guides/packages/06_Plugins_|_Video_codecs.md b/guides/packages/06_Plugins_|_Video_codecs.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_h26x_plugin
 Membrane h264 and h265 parsers 
 
diff --git a/guides/packages/07_Plugins_|_Raw_audio.md b/guides/packages/07_Plugins_|_Raw_audio.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_raw_audio_parser_plugin
 Membrane element for parsing raw audio 
 
diff --git a/guides/packages/08_Plugins_|_Raw_video.md b/guides/packages/08_Plugins_|_Raw_video.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_raw_video_parser_plugin
 Membrane plugin for parsing raw video streams 
 
diff --git a/guides/packages/09_Plugins_|_External_APIs.md b/guides/packages/09_Plugins_|_External_APIs.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_aws_plugin
 [Maintainer: [fishjam-dev](https://github.com/fishjam-dev)]  
 
diff --git a/guides/packages/10_Formats.md b/guides/packages/10_Formats.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## membrane_rtp_format
 Real-time Transport Protocol format for Membrane Framework 
 
diff --git a/guides/packages/11_Standalone_media_libs.md b/guides/packages/11_Standalone_media_libs.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## ex_webrtc
 [Maintainer: [elixir-webrtc](https://github.com/elixir-webrtc)] An Elixir implementation of the W3C WebRTC API 
 
diff --git a/guides/packages/12_Utils.md b/guides/packages/12_Utils.md
@@ -1,3 +1,4 @@
+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
 ## unifex
 Tool for generating interfaces between native C code and Elixir 
 
diff --git a/scripts/elixir/update_packages_list.exs b/scripts/elixir/update_packages_list.exs
@@ -154,25 +154,26 @@ gh_req_timeout = 500
 # for debugging, allows mocking requests for particular repos
 gh_req_mock = false
 
+# gh token for larger request rate
+gh_token_header =
+  case System.get_env("GITHUB_TOKEN") do
+    nil -> []
+    token -> [Authorization: "Bearer #{token}"]
+  end
+
 # fetch repos from the known organizations
 repos =
   ["membraneframework", "membraneframework-labs", "fishjam-dev"]
   |> Enum.flat_map(fn org ->
     Stream.from_index()
     |> Stream.map(fn page ->
-      Process.sleep(gh_req_timeout)
+      if gh_token_header == [], do: Process.sleep(gh_req_timeout)
       url = "https://api.github.com/orgs/#{org}/repos?per_page=100&page=#{page}"
       Logger.debug("Fetching #{url}")
 
-      headers =
-        case System.get_env("GITHUB_TOKEN") do
-          nil -> []
-          token -> [Authorization: "Bearer #{token}"]
-        end
-
       resp =
         Req.get!(url,
-          headers: headers,
+          headers: gh_token_header,
           decode_json: [keys: :atoms]
         ).body
 
@@ -233,18 +234,13 @@ packages =
             %{owner: %{login: :mock}, html_url: :mock, description: :mock}
 
           owner != nil ->
+            if gh_token_header == [], do: if(gh_token_header == [])
             Process.sleep(gh_req_timeout)
             url = "https://api.github.com/repos/#{owner}/#{name}"
             Logger.debug("Fetching #{url}")
 
-            headers =
-              case System.get_env("GITHUB_TOKEN") do
-                nil -> []
-                token -> [Authorization: "Bearer #{token}"]
-              end
-
             Req.get!(url,
-              headers: headers,
+              headers: gh_token_header,
               decode_json: [keys: :atoms]
             ).body
 
@@ -256,14 +252,31 @@ packages =
         end
 
       hex = Req.get!("https://hex.pm/api/packages/#{name}", decode_json: [keys: :atoms])
-      is_hex_present = hex.status == 200
+
+      hex_badge =
+        if hex.status == 200 and hex.body.url != nil do
+          "[![Hex.pm](https://img.shields.io/hexpm/v/#{name}.svg)](#{hex.body.url})"
+        end
+
+      hexdocs_badge =
+        if hex.status == 200 and hex.body.docs_html_url != nil do
+          "[![Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](#{hex.body.docs_html_url})"
+        end
+
+      owner_prefix =
+        case repo.owner.login do
+          "membraneframework-labs" -> "[Labs] "
+          "membraneframework" -> ""
+          owner -> "[Maintainer: [#{owner}](https://github.com/#{owner})] "
+        end
 
       Map.merge(package, %{
         owner: repo.owner.login,
         url: repo.html_url,
         description: repo.description,
-        hex_url: if(is_hex_present, do: hex.body.url),
-        hexdocs_url: if(is_hex_present, do: hex.body.docs_html_url)
+        owner_prefix: owner_prefix,
+        hex_badge: hex_badge,
+        hexdocs_badge: hexdocs_badge
       })
 
     other ->
@@ -278,77 +291,20 @@ header = """
 | --- | --- | --- |
 """
 
-packages_docs_path = "guides/packages"
-
-File.rm_rf!(packages_docs_path)
-File.mkdir_p(packages_docs_path)
-
 packages_md =
   packages
   |> Enum.map_reduce(
-    %{is_header_present: false, file_path: nil, file_number: 0, section: nil},
+    %{is_header_present: false},
     fn
       %{type: :markdown, content: content}, acc ->
-        # So that the files have correct order
-        prefix = "#{acc.file_number}_" |> String.pad_leading(3, "0")
-
-        {filename, section} =
-          case content do
-            "### " <> section -> {section, section}
-            "#### " <> subsection -> {"#{acc.section} | #{subsection}", acc.section}
-          end
-
-        file_path =
-          Path.join(packages_docs_path, prefix <> filename <> ".md") |> String.replace(" ", "_")
-
-        acc = %{
-          acc
-          | is_header_present: false,
-            file_path: file_path,
-            section: section,
-            file_number: acc.file_number + 1
-        }
-
-        {"\n" <> content, acc}
+        {"\n" <> content, %{acc | is_header_present: false}}
 
       %{type: :package} = package, acc ->
-        prefix =
-          case package.owner do
-            "membraneframework-labs" -> "[Labs] "
-            "membraneframework" -> ""
-            _other -> "[Maintainer: [#{package.owner}](https://github.com/#{package.owner})] "
-          end
-
-        hex_badge =
-          if package.hex_url,
-            do:
-              "[![Hex.pm](https://img.shields.io/hexpm/v/#{package.name}.svg)](#{package.hex_url})"
-
-        hexdocs_badge =
-          if package.hexdocs_url,
-            do:
-              "[![Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](#{package.hexdocs_url})"
-
-        github_badge =
-          "[![GitHub](https://img.shields.io/badge/github-code-white.svg?logo=github)](#{package.url})"
-
-        markdown_link = "[#{package.name}](#{package.url})"
-
         readme_result = """
         #{if acc.is_header_present, do: "", else: header}\
-        | #{markdown_link} | #{prefix}#{package.description} | #{hex_badge} #{hexdocs_badge} |\
-        """
-
-        docs_result = """
-        ## #{package.name}
-        #{prefix}#{package.description} 
-
-        #{hex_badge} #{hexdocs_badge} #{github_badge}
-         
+        | [#{package.name}](#{package.url}) | #{package.owner_prefix}#{package.description} | #{package.hex_badge} #{package.hexdocs_badge} |\
         """
 
-        File.write(acc.file_path, docs_result, [:append])
-
         {readme_result, %{acc | is_header_present: true}}
     end
   )
@@ -376,4 +332,53 @@ File.read!(readme_path)
 )
 |> then(&File.write!(readme_path, &1))
 
+# update packages in docs
+packages_docs_path = "guides/packages"
+
+File.rm_rf!(packages_docs_path)
+File.mkdir_p(packages_docs_path)
+
+packages
+|> Enum.reduce(
+  %{file_path: nil, file_number: 0, section: nil},
+  fn
+    %{type: :markdown, content: content}, acc ->
+      # So that the files have correct order
+      prefix = "#{acc.file_number}_" |> String.pad_leading(3, "0")
+
+      {filename, section} =
+        case content do
+          "### " <> section -> {section, section}
+          "#### " <> subsection -> {"#{acc.section} | #{subsection}", acc.section}
+        end
+
+      file_path =
+        Path.join(packages_docs_path, prefix <> filename <> ".md") |> String.replace(" ", "_")
+
+      if filename != "Plugins" do
+        File.write!(
+          file_path,
+          "<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->\n"
+        )
+      end
+
+      %{acc | file_path: file_path, section: section, file_number: acc.file_number + 1}
+
+    %{type: :package} = package, acc ->
+      github_badge =
+        "[![GitHub](https://img.shields.io/badge/github-code-white.svg?logo=github)](#{package.url})"
+
+      docs_result = """
+      ## #{package.name}
+      #{package.owner_prefix}#{package.description} 
+
+      #{package.hex_badge} #{package.hexdocs_badge} #{github_badge}
+       
+      """
+
+      File.write(acc.file_path, docs_result, [:append])
+      acc
+  end
+)
+
 IO.puts("Packages updated successfully.")

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_sdk`
`2`	`3`	`Full power of Membrane in a single package`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_file_plugin`
`2`	`3`	`Membrane plugin for reading and writing to files`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_webrtc_plugin`
`2`	`3`	`Plugin for streaming via WebRTC`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_mp4_plugin`
`2`	`3`	`Utilities for MP4 container parsing and serialization and elements for muxing the stream to CMAF`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_aac_plugin`
`2`	`3`	`AAC parser and complementary elements for AAC codec`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_h26x_plugin`
`2`	`3`	`Membrane h264 and h265 parsers`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_raw_audio_parser_plugin`
`2`	`3`	`Membrane element for parsing raw audio`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_raw_video_parser_plugin`
`2`	`3`	`Membrane plugin for parsing raw video streams`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_aws_plugin`
`2`	`3`	`[Maintainer: [fishjam-dev](https://github.com/fishjam-dev)]`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	+<!-- Generated code, do not edit. See `scripts/elixir/update_packages_list.exs`. -->
`1`	`2`	`## membrane_rtp_format`
`2`	`3`	`Real-time Transport Protocol format for Membrane Framework`
`3`	`4`