[Empire Elixir] Giving Back - Building Your First Elixir Package

Transcript

1. Giving Back Building Your First Elixir Package
2. Generating a new package mix new crazy_pants
3. Generating a new package -> mix new crazy_pants * creating README.md * creating .gitignore * creating mix.exs * creating config * creating config/config.exs * creating lib * creating lib/crazy_pants.ex * creating test * creating test/test_helper.exs * creating test/crazy_pants_test.exs Your Mix project was created successfully. You can use "mix" to compile it, test it, and more: cd crazy_pants mix test Run "mix help" for more commands.
4. Brian Cardarella CEO of DockYard
5. inquisitor mail ecto_fixtures courier Elixir Packages I’ve Written
6. What we’ll cover • Customizing the package • Writing good documentation • Typespecs • Using your package • Distributing • Contributing to Elixir Core
7. Customizing the package -> mix new crazy_pants * creating README.md * creating .gitignore * creating mix.exs * creating config * creating config/config.exs * creating lib * creating lib/crazy_pants.ex * creating test * creating test/test_helper.exs * creating test/crazy_pants_test.exs Your Mix project was created successfully. You can use "mix" to compile it, test it, and more: cd crazy_pants mix test Run "mix help" for more commands.
8. Customizing the package defmodule CrazyPants.Mixfile do use Mix.Project def project do [app: :crazy_pants, version: "0.0.1", elixir: "~> 1.2", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, deps: deps] end # Configuration for the OTP application # # Type "mix help compile.app" for more information def application do [applications: [:logger]] end # Dependencies can be Hex packages: # # {:mydep, "~> 0.3.0"} # # Or git/path repositories: # # {:mydep, git: "https://github.com/elixir-lang/mydep.git", tag: "0.1.0"} # # Type "mix help deps" for more examples and options defp deps do [] end end
9. Customizing the package defmodule CrazyPants.Mixfile do use Mix.Project def project do [app: :crazy_pants, version: "0.0.1", elixir: "~> 1.2", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, package: package(), description: description(), deps: deps] end def package do [maintainers: ["Krazy Kat"], licenses: ["MIT"], links: %{"GitHub" => "https://github.com/whodat/crazy_pants"}] end def description do "These pretzels are making me thirsty" end
10. defmodule CrazyPants.Mixfile do use Mix.Project def project do [app: :crazy_pants, version: "0.0.1", elixir: "~> 1.2", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, package: package(), description: description(), deps: deps] end def package do [maintainers: ["Krazy Kat"], licenses: ["MIT"], links: %{"GitHub" => "https://github.com/whodat/crazy_pants"}] end def description do "These pretzels are making me thirsty" end Customizing the package
11. Writing good documentation http://elixir-lang.org/docs/stable/elixir/writing-documentation.html
12. Writing good documentation ....CrazyPants.drop(1,2,3) `CrazyPants`
13. Writing good documentation defmodule CrazyPants @moduledoc """ This is the greatest library every written """ @doc """ This is the best function ever written """ def drop(location) do "They're at the #{location}” end end
14. Writing good documentation defp deps do [ {:earmark, "~> 0.1", only: :dev}, {:ex_doc, "~> 0.11", only: :dev} ] end
15. Writing good documentation mix docs
16. Writing good documentation open doc/index.html
17. Writing good documentation
18. Writing good documentation defmodule CrazyPants.Mixfile do use Mix.Project def project do [app: :crazy_pants, version: "0.0.1", elixir: "~> 1.2", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, package: package(), description: description(), deps: deps, docs: [ main: "CrazyPants" ]] end
19. Writing good documentation
20. Writing good documentation
21. Writing good documentation
22. Writing good documentation defmodule CrazyPants.Mixfile do use Mix.Project def project do [app: :crazy_pants, version: "0.0.1", elixir: "~> 1.2", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, package: package(), description: description(), deps: deps, docs: [ main: “CrazyPants”, logo: “crazy_pants.jpg” ]] end
23. Writing good documentation
24. Typespecs
25. Typespecs defmodule CrazyPants do @moduledoc """ This is the greatest library ever written """ @doc """ This is the greatest function ever written """ @spec drop(binary) :: binary def drop(location) do "They're at the #{location}" end end
26. Typespecs
27. Typespecs defmodule CrazyPantsTest do use ExUnit.Case test "using numbers" do assert CrazyPants.number_drop(1) == "They're at the 1" end end ➜ mix test . Finished in 0.02 seconds (0.02s on load, 0.00s on tests) 1 test, 0 failures
28. Typespecs defp deps do [{:earmark, "~> 0.1", only: :dev}, {:ex_doc, "~> 0.11", only: :dev}, {:dialyxir, "~> 0.3.3", only: :dev}] end ➜ mix dialyzer.plt Starting PLT Core Build ... this will take awhile
29. Typespecs ➜ mix dialyzer Compiled lib/crazy_pants.ex Starting Dialyzer crazy_pants.ex:15: The call 'Elixir.CrazyPants':drop(1) breaks the contract (binary()) -> binary() done in 0m0.80s done (warnings were emitted)
30. Typespecs defmodule CrazyPants do @moduledoc """ This is the greatest library ever written """ @doc """ This is the greatest function ever written """ @spec drop(binary) :: binary def drop(location) do "They're at the #{location}" end def num_drop() do drop(1) end end
31. Typespecs defmodule CrazyPants do @moduledoc """ This is the greatest library ever written """ @doc """ This is the greatest function ever written """ @spec drop(binary) :: binary def drop(location) do "They're at the #{location}" end def num_drop() do 1 |> Integer.to_string() |> drop() end end
32. Typespecs ➜ mix dialyzer Compiled lib/crazy_pants.ex Starting Dialyzer Proceeding with analysis... done in 0m0.75s done (passed successfully)
33. Typespecs
34. Using your package defp deps do [{:crazy_pants, path: "/path/to/crazy_pants"}] end
35. Distributing
36. Distributing defmodule CrazyPants.Mixfile do use Mix.Project def project do [app: :crazy_pants, version: "0.0.1", elixir: "~> 1.2", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, package: package(), description: description(), deps: deps, docs: [ main: “CrazyPants”, logo: “crazy_pants.jpg” ]] end
37. Distributing
38. Distributing ➜ git tag v0.0.1 ➜ git push --tags
39. Distributing
40. Distributing ➜ mix hex.publish Publishing crazy_pants 0.0.1 Dependencies: Files: lib/crazy_pants.ex mix.exs README.md App: crazy_pants Name: crazy_pants Description: These pretzels are making me thirsty Version: 0.0.1 Build tools: mix Licenses: MIT Maintainers: Krazy Kat Links: GitHub: https://github.com/whodat/crazy_pants Elixir: ~> 1.2 WARNING! Excluded dependencies (not part of the Hex package): earmark ex_doc dialyxir Before publishing, please read Hex Code of Conduct: https://hex.pm/policies/ codeofconduct Proceed? [Yn]
41. Distributing [#########################] 100% Published at https://hex.pm/packages/crazy_pants/0.0.1 Don't forget to upload your documentation with `mix hex.docs`
42. Distributing ➜ mix hex.docs Docs successfully generated. View them at "doc/index.html". [#########################] 100% Published docs for crazy_pants 0.0.1 Hosted at https://hexdocs.pm/crazy_pants/0.0.1
43. Distributing
44. inquisitor mail ecto_fixtures courier Elixir Packages I’ve Written crazy_pants
45. inquisitor mail ecto_fixtures courier Elixir Packages I’ve Written
49. Other places to promote your package • reddit.com/r/elixir • elixir-lang-talk Google Group • phoenix-talk Google Group • https://elixirstatus.com • Elixir Slack • #elixir-lang IRC
50. Other places to promote your package http://www.meetup.com/topics/elixir/
51. Want to build something amazing? dockyard.com Thank you!