Add hex.pm package info (#4)

Author: magnetised

README.md

@@ -12,13 +12,13 @@
   </picture>
 </a>
 
-[![License - Apache 2.0](https://img.shields.io/badge/license-Apache_2.0-blue)](main/LICENSE)
+[![License - Apache 2.0](https://img.shields.io/badge/license-Apache_2.0-blue)](./LICENSE)
 
 # PgQuery
 
 An Elixir interface to the [lib_pg_query postgres query parser](https://github.com/pganalyze/libpg_query).
 
-``` elixir
+```elixir
 {:ok, ast} = PgQuery.parse("select * from a_table")
 ```
 
@@ -39,7 +39,7 @@ end
 
 ## License
 
-This Elixir interface is distributed under the terms of the [Apache 2.0 license](LICENSE).
+This Elixir interface is distributed under the terms of the [Apache 2.0 license](./LICENSE).
 
 The codebase also contains a git-subtree snapshot of [lib_pg_query](https://github.com/pganalyze/libpg_query) which is distributed under the [BSD 3-Clause license](https://github.com/pganalyze/libpg_query/blob/15-latest/LICENSE).
 

lib/pg_query.ex

@@ -1,4 +1,16 @@
 defmodule PgQuery do
+  @type error() :: %{message: String.t(), cursorpos: non_neg_integer()}
+  @doc """
+  Parses the binary statement `stmt` into a Protobuf AST.
+
+  Raises if the statement is invalid.
+  """
+  @spec parse!(String.t()) :: %PgQuery.ParseResult{} | no_return()
   defdelegate parse!(stmt), to: PgQuery.Parser
+
+  @doc """
+  Parses the binary statement `stmt` into a Protobuf AST.
+  """
+  @spec parse(String.t()) :: {:ok, %PgQuery.ParseResult{}} | {:error, error()}
   defdelegate parse(stmt), to: PgQuery.Parser
 end

mix.exs

@@ -4,11 +4,17 @@ defmodule PgQuery.MixProject do
   def project do
     [
       app: :pg_query_ex,
-      version: "0.1.0",
       elixir: "~> 1.13",
+      version: "0.5.4",
       start_permanent: Mix.env() == :prod,
       compilers: [:elixir_make] ++ Mix.compilers(),
-      deps: deps()
+      deps: deps(),
+      description: description(),
+      name: "PgQuery",
+      package: package(),
+      docs: docs(),
+      source_url: "https://github.com/electric-sql/pg_query_ex",
+      homepage_url: "https://electric-sql.com"
     ]
   end
 
@@ -23,7 +29,45 @@ defmodule PgQuery.MixProject do
   defp deps do
     [
       {:elixir_make, "~> 0.4", runtime: false},
-      {:protox, "~> 1.7"}
+      {:protox, "~> 1.7"},
+      {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
+    ]
+  end
+
+  defp package do
+    # Exclude the test files and other bits and bobs to sneak us in under the
+    # 8MB hex.pm package size limit...
+    c_src = ~w(
+      c_src/libpg_query_ex.c
+      c_src/libpg_query/LICENSE
+      c_src/libpg_query/Makefile
+      c_src/libpg_query/README.md
+      c_src/libpg_query/pg_query.h
+      c_src/libpg_query/patches
+      c_src/libpg_query/protobuf
+      c_src/libpg_query/src
+      c_src/libpg_query/vendor
+    )
+
+    [
+      files: ~w(lib .formatter.exs mix.exs README.* LICENSE Makefile) ++ c_src,
+      licenses: ["Apache-2.0"],
+      links: %{
+        "libpg_query" => "https://github.com/pganalyze/libpg_query",
+        "Github" => "https://github.com/electric-sql/pg_query_ex",
+        "Electric SQL" => "https://electric-sql.com"
+      }
+    ]
+  end
+
+  defp description do
+    "An Elixir interface to the libpg_query postgres query parser. Converts a valid PostgreSQL query into a Protobuf based AST."
+  end
+
+  defp docs do
+    [
+      main: "readme",
+      extras: ["README.md", "LICENSE"]
     ]
   end
 end

mix.lock

@@ -1,5 +1,11 @@
 %{
   "decimal": {:hex, :decimal, "2.0.0", "a78296e617b0f5dd4c6caf57c714431347912ffb1d0842e998e9792b5642d697", [:mix], [], "hexpm", "34666e9c55dea81013e77d9d87370fe6cb6291d1ef32f46a1600230b1d44f577"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.41", "ab34711c9dc6212dda44fcd20ecb87ac3f3fce6f0ca2f28d4a00e4154f8cd599", [:mix], [], "hexpm", "a81a04c7e34b6617c2792e291b5a2e57ab316365c2644ddc553bb9ed863ebefa"},
   "elixir_make": {:hex, :elixir_make, "0.7.5", "784cc00f5fa24239067cc04d449437dcc5f59353c44eb08f188b2b146568738a", [:mix], [{:castore, "~> 0.1", [hex: :castore, repo: "hexpm", optional: true]}], "hexpm", "c3d63e8d5c92fa3880d89ecd41de59473fa2e83eeb68148155e25e8b95aa2887"},
+  "ex_doc": {:hex, :ex_doc, "0.34.2", "13eedf3844ccdce25cfd837b99bea9ad92c4e511233199440488d217c92571e8", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "5ce5f16b41208a50106afed3de6a2ed34f4acfd65715b82a0b84b49d995f95c1"},
+  "makeup": {:hex, :makeup, "1.1.2", "9ba8837913bdf757787e71c1581c21f9d2455f4dd04cfca785c70bbfff1a76a3", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cce1566b81fbcbd21eca8ffe808f33b221f9eee2cbc7a1706fc3da9ff18e6cac"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.16.2", "627e84b8e8bf22e60a2579dad15067c755531fea049ae26ef1020cad58fe9578", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "41193978704763f6bbe6cc2758b84909e62984c7752b3784bd3c218bb341706b"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"},
   "protox": {:hex, :protox, "1.7.2", "ed800ae523fa7b7e68a411645922c8061daacfa57aacff2a38d63aa092304a8c", [:mix], [{:decimal, "~> 1.9 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.2", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "02230413186776adac7d05237e17e4d20e69b270ae086fab6f1fffda8094d9b0"},
 }