From ec70c01b5f1b105b2de03cd49d088f01912779a8 Mon Sep 17 00:00:00 2001 From: James Harton Date: Fri, 10 Jul 2020 17:29:11 +1200 Subject: [PATCH] Initial commit from `mix new`. --- .formatter.exs | 4 ++++ .gitignore | 24 ++++++++++++++++++++++++ README.md | 21 +++++++++++++++++++++ lib/wopr.ex | 18 ++++++++++++++++++ lib/wopr/application.ex | 19 +++++++++++++++++++ mix.exs | 29 +++++++++++++++++++++++++++++ test/test_helper.exs | 1 + test/wopr_test.exs | 8 ++++++++ 8 files changed, 124 insertions(+) create mode 100644 .formatter.exs create mode 100644 .gitignore create mode 100644 README.md create mode 100644 lib/wopr.ex create mode 100644 lib/wopr/application.ex create mode 100644 mix.exs create mode 100644 test/test_helper.exs create mode 100644 test/wopr_test.exs diff --git a/.formatter.exs b/.formatter.exs new file mode 100644 index 0000000..d2cda26 --- /dev/null +++ b/.formatter.exs @@ -0,0 +1,4 @@ +# Used by "mix format" +[ + inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] +] diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7ddcae7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# The directory Mix will write compiled artifacts to. +/_build/ + +# If you run "mix test --cover", coverage assets end up here. +/cover/ + +# The directory Mix downloads your dependencies sources to. +/deps/ + +# Where third-party dependencies like ExDoc output generated docs. +/doc/ + +# Ignore .fetch files in case you like to edit your project deps locally. +/.fetch + +# If the VM crashes, it generates a dump, let's ignore it too. +erl_crash.dump + +# Also ignore archive artifacts (built via "mix archive.build"). +*.ez + +# Ignore package tarball (built via "mix hex.build"). +wopr-*.tar + diff --git a/README.md b/README.md new file mode 100644 index 0000000..be827fe --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# WOPR + +**TODO: Add description** + +## Installation + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed +by adding `wopr` to your list of dependencies in `mix.exs`: + +```elixir +def deps do + [ + {:wopr, "~> 0.1.0"} + ] +end +``` + +Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) +and published on [HexDocs](https://hexdocs.pm). Once published, the docs can +be found at [https://hexdocs.pm/wopr](https://hexdocs.pm/wopr). + diff --git a/lib/wopr.ex b/lib/wopr.ex new file mode 100644 index 0000000..f2c3940 --- /dev/null +++ b/lib/wopr.ex @@ -0,0 +1,18 @@ +defmodule WOPR do + @moduledoc """ + Documentation for `WOPR`. + """ + + @doc """ + Hello world. + + ## Examples + + iex> WOPR.hello() + :world + + """ + def hello do + :world + end +end diff --git a/lib/wopr/application.ex b/lib/wopr/application.ex new file mode 100644 index 0000000..2820c82 --- /dev/null +++ b/lib/wopr/application.ex @@ -0,0 +1,19 @@ +defmodule WOPR.Application do + # See https://hexdocs.pm/elixir/Application.html + # for more information on OTP Applications + @moduledoc false + + use Application + + def start(_type, _args) do + children = [ + # Starts a worker by calling: WOPR.Worker.start_link(arg) + # {WOPR.Worker, arg} + ] + + # See https://hexdocs.pm/elixir/Supervisor.html + # for other strategies and supported options + opts = [strategy: :one_for_one, name: WOPR.Supervisor] + Supervisor.start_link(children, opts) + end +end diff --git a/mix.exs b/mix.exs new file mode 100644 index 0000000..ba16b42 --- /dev/null +++ b/mix.exs @@ -0,0 +1,29 @@ +defmodule WOPR.MixProject do + use Mix.Project + + def project do + [ + app: :wopr, + version: "0.1.0", + elixir: "~> 1.10", + start_permanent: Mix.env() == :prod, + deps: deps() + ] + end + + # Run "mix help compile.app" to learn about applications. + def application do + [ + extra_applications: [:logger], + mod: {WOPR.Application, []} + ] + end + + # Run "mix help deps" to learn about dependencies. + defp deps do + [ + # {:dep_from_hexpm, "~> 0.3.0"}, + # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"} + ] + end +end diff --git a/test/test_helper.exs b/test/test_helper.exs new file mode 100644 index 0000000..869559e --- /dev/null +++ b/test/test_helper.exs @@ -0,0 +1 @@ +ExUnit.start() diff --git a/test/wopr_test.exs b/test/wopr_test.exs new file mode 100644 index 0000000..c6e1822 --- /dev/null +++ b/test/wopr_test.exs @@ -0,0 +1,8 @@ +defmodule WOPRTest do + use ExUnit.Case + doctest WOPR + + test "greets the world" do + assert WOPR.hello() == :world + end +end