Release v0.3.2

Author: dannote

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.3.2
+
+- Improve compile-time icon discovery for wrapper component `icon` attributes and same-line recoverable HEEx inside EEx blocks
+- Discover literal icon names returned by icon helper functions
+- Include `priv/**/*.heex` templates in scanner source paths
+
 ## v0.3.1
 
 - Fix manifest decoding for Mix tasks when persisted icon field atoms are not loaded yet

README.md

@@ -38,7 +38,7 @@ Add the dependency:
 ```elixir
 def deps do
   [
-    {:phoenix_iconify, "~> 0.1.0"}
+    {:phoenix_iconify, "~> 0.3.2"}
   ]
 end
 ```

lib/phoenix_iconify/scanner.ex

@@ -22,10 +22,11 @@ defmodule PhoenixIconify.Scanner do
     content
     |> tokenize_heex("nofile")
     |> icons_from_tokens()
+    |> Enum.uniq()
   end
 
   defp source_paths do
-    ["lib/**/*.ex", "lib/**/*.heex"]
+    ["lib/**/*.ex", "lib/**/*.heex", "priv/**/*.heex"]
     |> Enum.flat_map(&Path.wildcard/1)
   end
 
@@ -49,11 +50,18 @@ defmodule PhoenixIconify.Scanner do
 
   defp scan_ex(content) do
     case Code.string_to_quoted(content) do
-      {:ok, ast} -> ast |> heex_sigil_sources() |> Enum.flat_map(&scan_heex_content/1)
+      {:ok, ast} -> scan_ast(ast)
       {:error, _} -> []
     end
   end
 
+  defp scan_ast(ast) do
+    heex_icons = ast |> heex_sigil_sources() |> Enum.flat_map(&scan_heex_content/1)
+    icon_function_icons = ast |> icon_function_string_literals()
+
+    heex_icons ++ icon_function_icons
+  end
+
   defp heex_sigil_sources(ast) do
     {_ast, sources} =
       Macro.prewalk(ast, [], fn
@@ -69,10 +77,29 @@ defmodule PhoenixIconify.Scanner do
   end
 
   defp tokenize_heex(content, path) do
+    do_tokenize_heex(content, path)
+  rescue
+    Phoenix.LiveView.Tokenizer.ParseError -> tokenize_heex_lines(content, path)
+  end
+
+  defp tokenize_heex_lines(content, path) do
+    content
+    |> String.split("\n")
+    |> Enum.with_index(1)
+    |> Enum.flat_map(fn {line, line_number} ->
+      try do
+        do_tokenize_heex(line, path, line_number)
+      rescue
+        Phoenix.LiveView.Tokenizer.ParseError -> []
+      end
+    end)
+  end
+
+  defp do_tokenize_heex(content, path, line \\ 1) do
     state = Tokenizer.init(0, path, content, Phoenix.LiveView.HTMLEngine)
 
     {tokens, _cont} =
-      Tokenizer.tokenize(content, [line: 1, column: 1], [], {:text, :enabled}, state)
+      Tokenizer.tokenize(content, [line: line, column: 1], [], {:text, :enabled}, state)
 
     tokens
   end
@@ -85,28 +112,108 @@ defmodule PhoenixIconify.Scanner do
 
   defp icon_from_token({:local_component, "icon", attrs, _meta}) do
     attrs
-    |> Enum.find_value(&name_attr/1)
+    |> Enum.find_value(&icon_name_attr/1)
+    |> List.wrap()
+  end
+
+  defp icon_from_token({:local_component, _name, attrs, _meta}) do
+    attrs
+    |> Enum.find_value(&component_icon_attr/1)
     |> List.wrap()
   end
 
   defp icon_from_token(_token), do: []
 
-  defp name_attr({"name", {:string, name, _meta}, _attr_meta}) do
+  defp icon_name_attr({"name", {:string, name, _meta}, _attr_meta}) do
     normalize_name(name)
   end
 
-  defp name_attr({"name", {:expr, expr, _meta}, _attr_meta}) do
+  defp icon_name_attr({"name", {:expr, expr, _meta}, _attr_meta}) do
     case Code.string_to_quoted(expr) do
       {:ok, name} when is_binary(name) -> normalize_name(name)
       _ -> nil
     end
   end
 
-  defp name_attr(_attr), do: nil
+  defp icon_name_attr(_attr), do: nil
+
+  defp component_icon_attr({"icon", {:string, name, _meta}, _attr_meta}) do
+    normalize_name(name)
+  end
+
+  defp component_icon_attr({"icon", {:expr, expr, _meta}, _attr_meta}) do
+    case Code.string_to_quoted(expr) do
+      {:ok, name} when is_binary(name) -> normalize_name(name)
+      _ -> nil
+    end
+  end
+
+  defp component_icon_attr(_attr), do: nil
+
+  defp icon_function_string_literals(ast) do
+    {_ast, icons} =
+      Macro.prewalk(ast, [], fn
+        {kind, _meta, [{name, _name_meta, args}, [do: body]]} = node, icons
+        when kind in [:def, :defp] and is_atom(name) and is_list(args) ->
+          if icon_function?(name) do
+            {node, string_literals(body) ++ icons}
+          else
+            {node, icons}
+          end
+
+        {kind, _meta, [{name, _name_meta, args}, body]} = node, icons
+        when kind in [:def, :defp] and is_atom(name) and is_list(args) ->
+          if icon_function?(name) do
+            {node, string_literals(body) ++ icons}
+          else
+            {node, icons}
+          end
+
+        node, icons ->
+          {node, icons}
+      end)
+
+    icons
+    |> Enum.map(&normalize_name/1)
+    |> Enum.reject(&is_nil/1)
+  end
+
+  defp icon_function?(name) do
+    name
+    |> Atom.to_string()
+    |> String.contains?("icon")
+  end
+
+  defp string_literals(ast) do
+    {_ast, strings} =
+      Macro.prewalk(ast, [], fn
+        string, strings when is_binary(string) -> {string, [string | strings]}
+        node, strings -> {node, strings}
+      end)
+
+    strings
+  end
 
   defp normalize_name("hero-" <> _rest = name), do: PhoenixIconify.normalize_name(name)
 
   defp normalize_name(name) do
-    if String.contains?(name, ":"), do: name
+    if valid_iconify_name?(name), do: name
+  end
+
+  defp valid_iconify_name?(name) when is_binary(name) do
+    case String.split(name, ":", parts: 2) do
+      [prefix, icon] -> valid_name_part?(prefix) and valid_name_part?(icon)
+      _ -> false
+    end
+  end
+
+  defp valid_iconify_name?(_name), do: false
+
+  defp valid_name_part?(part) do
+    part != "" and part |> String.to_charlist() |> Enum.all?(&valid_name_character?/1)
+  end
+
+  defp valid_name_character?(character) do
+    character in ?a..?z or character in ?A..?Z or character in ?0..?9 or character in [?-, ?_]
   end
 end

mix.exs

@@ -1,7 +1,7 @@
 defmodule PhoenixIconify.MixProject do
   use Mix.Project
 
-  @version "0.3.1"
+  @version "0.3.2"
   @source_url "https://github.com/elixir-volt/phoenix_iconify"
 
   def project do

test/phoenix_iconify/scanner_test.exs

@@ -35,6 +35,18 @@ defmodule PhoenixIconify.ScannerTest do
       assert "heroicons:sun-20-solid" in icons
     end
 
+    test "finds literal icon strings passed through component attributes" do
+      content = ~s(<.nav_item icon="lucide:messages-square">Sessions</.nav_item>)
+      icons = Scanner.scan_heex_content(content)
+      assert "lucide:messages-square" in icons
+    end
+
+    test "recovers same-line icons when the surrounding HEEx cannot be tokenized as a whole" do
+      content = ~s(<%= if true do %>\n<.icon name="lucide:circle-check" />\n<% end %>)
+      icons = Scanner.scan_heex_content(content)
+      assert "lucide:circle-check" in icons
+    end
+
     test "ignores icons without prefix:name format" do
       content = ~s(<.icon name="just-a-name" />)
       icons = Scanner.scan_heex_content(content)