Better TypeScript search

royalicing · royalicing · commit 1e62977c72b0 · 2022-09-06T22:31:05.000+10:00
diff --git a/lib/components_guide/research/sources/typescript.ex b/lib/components_guide/research/sources/typescript.ex
@@ -45,16 +45,24 @@ defmodule ComponentsGuide.Research.Sources.Typescript do
   end
 
   defmodule Interface do
-    defstruct name: nil, line_start: nil, line_end: nil
+    defstruct name: nil, doc: nil, line_start: nil, line_end: nil
+  end
+
+  defmodule Namespace do
+    defstruct name: nil, doc: nil, line_start: nil, line_end: nil
   end
 
   defmodule GlobalVariable do
-    defstruct name: nil, line_start: nil, line_end: nil
+    defstruct name: nil, doc: nil, line_start: nil, line_end: nil
+  end
+
+  defmodule GlobalFunction do
+    defstruct name: nil, doc: nil, line_start: nil, line_end: nil
   end
 
   defmodule Parser do
     defmodule State do
-      defstruct mode: nil, output: []
+      defstruct mode: nil, prev_doc: nil, output: []
     end
 
     def parse(source) when is_binary(source) do
@@ -83,19 +91,104 @@ defmodule ComponentsGuide.Research.Sources.Typescript do
     end
 
     defmodule ModeDefinition do
-      defstruct type: nil, name: nil, line_start: nil, line_end: nil
+      defstruct type: nil, name: nil, doc: nil, line_start: nil, line_end: nil
+    end
+
+    defmodule JSDoc do
+      defstruct message: nil, line_start: nil
+    end
+
+    def do_reduce({"/**" <> rest_of_comment, n}, %State{mode: nil} = state) do
+      {mode, prev_doc} =
+        case rest_of_comment |> String.replace_suffix("*/", "") do
+          # <<a:bytes-size(byte_size(rest_of_comment))>> -> {%ModeDefinition{type: :doc_comment, line_start: n}, nil}
+          s when byte_size(rest_of_comment) == byte_size(s) ->
+            {%JSDoc{message: String.trim(rest_of_comment), line_start: n}, nil}
+
+          message ->
+            {nil, %JSDoc{message: String.trim(message), line_start: n}}
+        end
+
+      %State{state | mode: mode, prev_doc: prev_doc}
     end
 
     def do_reduce({"interface " <> name_and_extends, n}, %State{mode: nil} = state) do
       name = extract_name(name_and_extends)
-      mode = %ModeDefinition{type: :interface, name: name, line_start: n}
-      %State{state | mode: mode}
+
+      {doc, line_start} = read_prev_doc(state, n)
+
+      mode = %ModeDefinition{type: :interface, name: name, doc: doc, line_start: line_start}
+      %State{state | mode: mode, prev_doc: nil}
+    end
+
+    def do_reduce({"declare namespace " <> name_and_extends, n}, %State{mode: nil} = state) do
+      name = extract_name(name_and_extends)
+
+      {doc, line_start} = read_prev_doc(state, n)
+
+      mode = %ModeDefinition{type: :namespace, name: name, doc: doc, line_start: line_start}
+      %State{state | mode: mode, prev_doc: nil}
     end
 
     def do_reduce({"declare var " <> name_and_extends, n}, %State{mode: nil} = state) do
       name = extract_name(name_and_extends)
-      mode = %ModeDefinition{type: :global_var, name: name, line_start: n}
-      %State{state | mode: mode}
+
+      case name_and_extends |> String.trim_trailing() |> String.ends_with?(";") do
+        true ->
+          {doc, line_start} = read_prev_doc(state, n)
+
+          output_item = %GlobalVariable{
+            name: name,
+            doc: doc,
+            line_start: line_start,
+            line_end: n
+          }
+
+          %State{mode: nil, output: [output_item | state.output], prev_doc: nil}
+
+        false ->
+          mode = %ModeDefinition{type: :global_var, name: name, line_start: n}
+          %State{state | mode: mode, prev_doc: nil}
+      end
+    end
+
+    def do_reduce({"declare function " <> name_and_more, n}, %State{mode: nil} = state) do
+      name = extract_name(name_and_more)
+
+      {doc, line_start} = read_prev_doc(state, n)
+
+      output_item = %GlobalFunction{
+        name: name,
+        doc: doc,
+        line_start: line_start,
+        line_end: n
+      }
+
+      %State{mode: nil, output: [output_item | state.output], prev_doc: nil}
+    end
+
+    def do_reduce({line, _n}, %State{mode: %JSDoc{message: message}} = state) do
+      case line |> String.ends_with?("*/") do
+        false ->
+          line =
+            case line |> String.trim() do
+              "*" <> rest -> rest |> String.trim_leading()
+              s -> s
+            end
+
+          message =
+            case message do
+              "" -> line
+              message -> message <> "\n" <> line
+            end
+
+          mode = %JSDoc{state.mode | message: message}
+          %State{state | mode: mode}
+
+        true ->
+          prev_doc = %JSDoc{message: message, line_start: state.mode.line_start}
+          %State{state | mode: nil, prev_doc: prev_doc}
+      end
     end
 
     def do_reduce({"}" <> _, n}, %State{mode: %ModeDefinition{}} = state) do
@@ -104,10 +197,28 @@ defmodule ComponentsGuide.Research.Sources.Typescript do
       output_item =
         case mode.type do
           :interface ->
-            %Interface{name: mode.name, line_start: mode.line_start, line_end: n}
+            %Interface{
+              name: mode.name,
+              doc: mode.doc,
+              line_start: mode.line_start,
+              line_end: n
+            }
+
+          :namespace ->
+            %Namespace{
+              name: mode.name,
+              doc: mode.doc,
+              line_start: mode.line_start,
+              line_end: n
+            }
 
           :global_var ->
-            %GlobalVariable{name: mode.name, line_start: mode.line_start, line_end: n}
+            %GlobalVariable{
+              name: mode.name,
+              doc: mode.doc,
+              line_start: mode.line_start,
+              line_end: n
+            }
         end
 
       %State{mode: nil, output: [output_item | state.output]}
@@ -116,10 +227,16 @@ defmodule ComponentsGuide.Research.Sources.Typescript do
     def do_reduce(_, state), do: state
 
     defp extract_name(name_and_extends) do
-      case String.split(name_and_extends, [" ", ":"], parts: 2) do
+      case String.split(name_and_extends, [" ", ":", "("], parts: 2) do
         [name | _] -> name
         _ -> nil
       end
     end
+
+    defp read_prev_doc(%State{prev_doc: %JSDoc{message: doc, line_start: doc_n}}, _n) do
+      {doc, doc_n}
+    end
+
+    defp read_prev_doc(_, n), do: {nil, n}
   end
 end
diff --git a/lib/components_guide_web/controllers/research_controller.ex b/lib/components_guide_web/controllers/research_controller.ex
@@ -9,14 +9,26 @@ defmodule ComponentsGuideWeb.ResearchController do
   alias ComponentsGuide.Research.Sources.Typescript
 
   def show(conn, %{"section" => "dom-types"}) do
+    as_ms = &System.convert_time_unit(&1, :native, :millisecond)
+
     url = "https://cdn.jsdelivr.net/npm/typescript@4.7.4/lib/lib.dom.d.ts"
     {:ok, source} = ComponentsGuide.Research.Source.text_at(url)
+    start = System.monotonic_time()
     types = Typescript.Parser.parse(source)
+    duration = System.monotonic_time() - start
+    IO.inspect(as_ms.(duration), label: "parse")
     types_sources = Typescript.Parser.extract_line_ranges(source, types)
+    duration = System.monotonic_time() - start
+    IO.inspect(as_ms.(duration), label: "parse + extract")
+
+    IO.inspect(types |> Enum.map(fn %{__struct__: type} -> type end) |> Enum.uniq(),
+      label: "types"
+    )
 
-    results = Enum.zip_with(types, types_sources, fn type, type_source ->
-      %{name: type.name, source: type_source}
-    end)
+    results =
+      Enum.zip_with(types, types_sources, fn type, type_source ->
+        %{name: type.name, doc: type.doc, source: type_source}
+      end)
 
     conn
     |> assign(:page_title, "Search DOM Types")
diff --git a/lib/components_guide_web/templates/research/dom-types.html.heex b/lib/components_guide_web/templates/research/dom-types.html.heex
@@ -9,7 +9,7 @@
   <dl>
   <%= for result <- @results do %>
     <div>
-      <dt class="font-bold" data-body={result.source}><%= result.name %></dt>
+      <dt class="font-bold" data-body={result.doc || "" <> " " <>  result.source}><%= result.name %></dt>
       <dd><pre class="language-ts"><code><%= result.source %></code></pre></dd>
     </div>
   <% end %>
diff --git a/test/components_guide/research/sources/typescript_test.exs b/test/components_guide/research/sources/typescript_test.exs
@@ -1,7 +1,13 @@
 defmodule ComponentsGuide.Research.Sources.TypescriptTest do
   use ExUnit.Case, async: true
 
-  alias ComponentsGuide.Research.Sources.Typescript.{Parser, Interface}
+  alias ComponentsGuide.Research.Sources.Typescript.{
+    Parser,
+    Interface,
+    Namespace,
+    GlobalVariable,
+    GlobalFunction
+  }
 
   @typescript_source ~S"""
   /*! *****************************************************************************
@@ -52,29 +58,100 @@ defmodule ComponentsGuide.Research.Sources.TypescriptTest do
       prototype: Blob;
       new(blobParts?: BlobPart[], options?: BlobPropertyBag): Blob;
   };
+
+  /**
+   * Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.
+   *
+   * Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.
+   *
+   * A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.
+   *
+   * If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".
+   *
+   * Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned.
+   */
+  declare function postMessage(message: any, targetOrigin: string, transfer?: Transferable[]): void;
+
+  /** Moves the focus to the window's browsing context, if any. */
+  declare function focus(): void;
+
+  declare function requestAnimationFrame(callback: FrameRequestCallback): number;
+
+  declare var console: Console;
+
+  /** Holds useful CSS-related methods. No object with this interface are implemented: it contains only static methods and therefore is a utilitarian interface. */
+  declare namespace CSS {
+      function escape(ident: string): string;
+      function supports(property: string, value: string): boolean;
+      function supports(conditionText: string): boolean;
+  }
   """
 
   test "parse" do
     assert Parser.parse(@typescript_source) == [
-             %ComponentsGuide.Research.Sources.Typescript.Interface{
+             %Interface{
                name: "AddEventListenerOptions",
                line_start: 24,
                line_end: 28
              },
-             %ComponentsGuide.Research.Sources.Typescript.Interface{
+             %Interface{
                name: "AesCbcParams",
                line_start: 30,
                line_end: 32
              },
-             %ComponentsGuide.Research.Sources.Typescript.Interface{
+             %Interface{
                name: "Blob",
-               line_start: 35,
+               doc:
+                 "A file-like object of immutable, raw data. Blobs represent data that isn't necessarily in a JavaScript-native format. The File interface is based on Blob, inheriting blob functionality and expanding it to support files on the user's system.",
+               line_start: 34,
                line_end: 42
              },
-             %ComponentsGuide.Research.Sources.Typescript.GlobalVariable{
+             %GlobalVariable{
                name: "Blob",
                line_start: 44,
                line_end: 47
+             },
+             %GlobalFunction{
+               name: "postMessage",
+               doc:
+                 ~S"""
+                 Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.
+
+                 Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.
+
+                 A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.
+
+                 If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".
+
+                 Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned.
+                 """
+                 |> String.trim_trailing(),
+               line_start: 49,
+               line_end: 60
+             },
+             %GlobalFunction{
+               name: "focus",
+               doc: "Moves the focus to the window's browsing context, if any.",
+               line_start: 62,
+               line_end: 63
+             },
+             %GlobalFunction{
+               name: "requestAnimationFrame",
+               line_start: 65,
+               line_end: 65
+             },
+             %GlobalVariable{
+               name: "console",
+               doc: nil,
+               line_start: 67,
+               line_end: 67
+             },
+             %Namespace{
+               name: "CSS",
+               doc:
+                 "Holds useful CSS-related methods. No object with this interface are implemented: it contains only static methods and therefore is a utilitarian interface.",
+               line_start: 69,
+               line_end: 74
              }
            ]
   end
