doc: Fixed command docs in README.md

Author: lud

README.md

@@ -15,12 +15,12 @@ while you focus on problem solving!
   - [Call your solution module manually](#call-your-solution-module-manually)
   - [TL; DR](#tl-dr)
 - [Available Commands](#available-commands)
-  - [mix.aoc.open](#mixaocopen)
-  - [mix.aoc.create](#mixaoccreate)
-  - [mix.aoc.test](#mixaoctest)
-  - [mix.aoc.run](#mixaocrun)
-  - [mix.aoc.fetch](#mixaocfetch)
-  - [mix.aoc.url](#mixaocurl)
+  - [mix aoc.open](#mix-aocopen)
+  - [mix aoc.create](#mix-aoccreate)
+  - [mix aoc.test](#mix-aoctest)
+  - [mix aoc.run](#mix-aocrun)
+  - [mix aoc.fetch](#mix-aocfetch)
+  - [mix aoc.url](#mix-aocurl)
   - [Custom default values for commands](#custom-default-values-for-commands)
 - [Upgrading to `0.12`](#upgrading-to-012)
 
@@ -365,7 +365,7 @@ You may also get a quick summary of options by calling those commands with the
 
 
 <!-- block:mix.aoc.open -->
-### mix.aoc.open
+### mix aoc.open
 
 Opens the puzzle page with your defined browser on on adventofcode.com.
 
@@ -377,15 +377,14 @@ The command to call with the URL will be defined in the following order:
 
 #### Usage
 
-```shell
-mix aoc.open [options]
-```
+    mix aoc.open [options]
+
 
 #### Options
 
-* `-y, --year <integer>`- Year of the puzzle Defaults to today's year or custom default.
-* `-d, --day <integer>`- Day of the puzzle Defaults to today's day or custom default.
-* `--help`- Displays this help.
+* `-y, --year <integer>` - Year of the puzzle Defaults to today's year or custom default.
+* `-d, --day <integer>` - Day of the puzzle Defaults to today's day or custom default.
+* `--help` - Displays this help.
 
 
 <!-- endblock:mix.aoc.open -->
@@ -394,7 +393,7 @@ mix aoc.open [options]
 
 
 <!-- block:mix.aoc.create -->
-### mix.aoc.create
+### mix aoc.create
 
 This task will execute the following operations:
 
@@ -415,15 +414,14 @@ option:
 
 #### Usage
 
-```shell
-mix aoc.create [options]
-```
+    mix aoc.create [options]
+
 
 #### Options
 
-* `-y, --year <integer>`- Year of the puzzle Defaults to today's year or custom default.
-* `-d, --day <integer>`- Day of the puzzle Defaults to today's day or custom default.
-* `--help`- Displays this help.
+* `-y, --year <integer>` - Year of the puzzle Defaults to today's year or custom default.
+* `-d, --day <integer>` - Day of the puzzle Defaults to today's day or custom default.
+* `--help` - Displays this help.
 
 
 <!-- endblock:mix.aoc.create -->
@@ -432,7 +430,7 @@ mix aoc.create [options]
 
 
 <!-- block:mix.aoc.test -->
-### mix.aoc.test
+### mix aoc.test
 
 Runs your test file for the Advent of Code puzzle.
 
@@ -459,20 +457,19 @@ end
 
 #### Usage
 
-```shell
-mix aoc.test [options]
-```
+    mix aoc.test [options]
+
 
 #### Options
 
-* `-y, --year <integer>`- Year of the puzzle Defaults to today's year or custom default.
-* `-d, --day <integer>`- Day of the puzzle Defaults to today's day or custom default.
-* `--trace`- forward option to `mix test`
-* `--stale`- forward option to `mix test`
-* `--failed`- forward option to `mix test`
-* `--seed <integer>`- forward option to `mix test`
-* `--max-failures <integer>`- forward option to `mix test`
-* `--help`- Displays this help.
+* `-y, --year <integer>` - Year of the puzzle Defaults to today's year or custom default.
+* `-d, --day <integer>` - Day of the puzzle Defaults to today's day or custom default.
+* `--trace` - forward option to `mix test`
+* `--stale` - forward option to `mix test`
+* `--failed` - forward option to `mix test`
+* `--seed <integer>` - forward option to `mix test`
+* `--max-failures <integer>` - forward option to `mix test`
+* `--help` - Displays this help.
 
 
 <!-- endblock:mix.aoc.test -->
@@ -481,23 +478,22 @@ mix aoc.test [options]
 
 
 <!-- block:mix.aoc.run -->
-### mix.aoc.run
+### mix aoc.run
 
 Runs your solution with the corresponding year/day input from `priv/inputs`.
 
 #### Usage
 
-```shell
-mix aoc.run [options]
-```
+    mix aoc.run [options]
+
 
 #### Options
 
-* `-y, --year <integer>`- Year of the puzzle Defaults to today's year or custom default.
-* `-d, --day <integer>`- Day of the puzzle Defaults to today's day or custom default.
-* `-p, --part <integer>`- Part of the puzzle Defaults to both parts.
-* `-b, --benchmark`- Runs the solution parts repeatedly for 5 seconds to print statistics about execution time. Defaults to `false`.
-* `--help`- Displays this help.
+* `-y, --year <integer>` - Year of the puzzle Defaults to today's year or custom default.
+* `-d, --day <integer>` - Day of the puzzle Defaults to today's day or custom default.
+* `-p, --part <integer>` - Part of the puzzle Defaults to both parts.
+* `-b, --benchmark` - Runs the solution parts repeatedly for 5 seconds to print statistics about execution time. Defaults to `false`.
+* `--help` - Displays this help.
 
 
 <!-- endblock:mix.aoc.run -->
@@ -506,23 +502,22 @@ mix aoc.run [options]
 
 
 <!-- block:mix.aoc.fetch -->
-### mix.aoc.fetch
+### mix aoc.fetch
 
 This task will fetch the puzzle into `priv/inputs`.
 
 It will not overwrite an existing input file.
 
 #### Usage
 
-```shell
-mix aoc.fetch [options]
-```
+    mix aoc.fetch [options]
+
 
 #### Options
 
-* `-y, --year <integer>`- Year of the puzzle Defaults to today's year or custom default.
-* `-d, --day <integer>`- Day of the puzzle Defaults to today's day or custom default.
-* `--help`- Displays this help.
+* `-y, --year <integer>` - Year of the puzzle Defaults to today's year or custom default.
+* `-d, --day <integer>` - Day of the puzzle Defaults to today's day or custom default.
+* `--help` - Displays this help.
 
 
 <!-- endblock:mix.aoc.fetch -->
@@ -531,7 +526,7 @@ mix aoc.fetch [options]
 
 
 <!-- block:mix.aoc.url -->
-### mix.aoc.url
+### mix aoc.url
 
 Outputs the on adventofcode.com URL for a puzzle.
 
@@ -546,15 +541,14 @@ xdg-open $(mix aoc.url | grep 'https')
 
 #### Usage
 
-```shell
-mix aoc.url [options]
-```
+    mix aoc.url [options]
+
 
 #### Options
 
-* `-y, --year <integer>`- Year of the puzzle Defaults to today's year or custom default.
-* `-d, --day <integer>`- Day of the puzzle Defaults to today's day or custom default.
-* `--help`- Displays this help.
+* `-y, --year <integer>` - Year of the puzzle Defaults to today's year or custom default.
+* `-d, --day <integer>` - Day of the puzzle Defaults to today's day or custom default.
+* `--help` - Displays this help.
 
 
 <!-- endblock:mix.aoc.url -->
@@ -596,4 +590,4 @@ move your old modules.
 
 Sorry for the inconvenience. That change was necessary to have a clean ordering
 of files in the solutions directories and to allow everyone to generate the
-modules in a directory according to their prefix.
+modules in a directory according to their preferred namespace.

mix.exs

@@ -43,7 +43,7 @@ defmodule AoC.MixProject do
   defp deps do
     [
       # Lib
-      {:cli_mate, "~> 0.7", runtime: false},
+      {:cli_mate, "~> 0.8", runtime: false},
       {:req, "~> 0.5"},
       {:benchee, "~> 1.2"},
       {:modkit, "~> 0.6.0"},

mix.lock

@@ -1,13 +1,13 @@
 %{
   "benchee": {:hex, :benchee, "1.4.0", "9f1f96a30ac80bab94faad644b39a9031d5632e517416a8ab0a6b0ac4df124ce", [:mix], [{:deep_merge, "~> 1.0", [hex: :deep_merge, repo: "hexpm", optional: false]}, {:statistex, "~> 1.0", [hex: :statistex, repo: "hexpm", optional: false]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "299cd10dd8ce51c9ea3ddb74bb150f93d25e968f93e4c1fa31698a8e4fa5d715"},
   "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
-  "cli_mate": {:hex, :cli_mate, "0.7.1", "922e3f7fcf9085be01b2e22ba0b16b1e3bb2e88a6af77657964dc0900a97cd4f", [:mix], [], "hexpm", "a8677fbedd9c31caad99c48481e5e3b857d1fe5bc22ba0eaf0501091713b8b53"},
+  "cli_mate": {:hex, :cli_mate, "0.8.1", "376fdc710b9d8936205d4a7d0da98ea76d99f7390ec035242591798c14584e6c", [:mix], [], "hexpm", "553cebbecd823936588854fe185f31ac39d96d66f5db7ddcb107e40a6da0adfe"},
   "credo": {:hex, :credo, "1.7.12", "9e3c20463de4b5f3f23721527fcaf16722ec815e70ff6c60b86412c695d426c1", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "8493d45c656c5427d9c729235b99d498bd133421f3e0a683e5c1b561471291e5"},
   "deep_merge": {:hex, :deep_merge, "1.0.0", "b4aa1a0d1acac393bdf38b2291af38cb1d4a52806cf7a4906f718e1feb5ee961", [:mix], [], "hexpm", "ce708e5f094b9cd4e8f2be4f00d2f4250c4095be93f8cd6d018c753894885430"},
   "dialyxir": {:hex, :dialyxir, "1.4.5", "ca1571ac18e0f88d4ab245f0b60fa31ff1b12cbae2b11bd25d207f865e8ae78a", [:mix], [{:erlex, ">= 0.2.7", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b0fb08bb8107c750db5c0b324fa2df5ceaa0f9307690ee3c1f6ba5b9eb5d35c3"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
-  "ex_doc": {:hex, :ex_doc, "0.37.3", "f7816881a443cd77872b7d6118e8a55f547f49903aef8747dbcb345a75b462f9", [:mix], [{:earmark_parser, "~> 1.4.42", [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", "e6aebca7156e7c29b5da4daa17f6361205b2ae5f26e5c7d8ca0d3f7e18972233"},
+  "ex_doc": {:hex, :ex_doc, "0.38.0", "0ab17291b71f9b2c479c0b92404107ac5005214872c3b43f845f6f644ba14f56", [:mix], [{:earmark_parser, "~> 1.4.44", [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", "dee6d6485ef501384fbfc7c90cb0fe621636078bebc0f7a1fd2ddcc20b185013"},
   "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
   "finch": {:hex, :finch, "0.19.0", "c644641491ea854fc5c1bbaef36bfc764e3f08e7185e1f084e35e0672241b76d", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.6.2 or ~> 1.7", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "fc5324ce209125d1e2fa0fcd2634601c52a787aff1cd33ee833664a5af4ea2b6"},
   "hpax": {:hex, :hpax, "1.0.3", "ed67ef51ad4df91e75cc6a1494f851850c0bd98ebc0be6e81b026e765ee535aa", [:mix], [], "hexpm", "8eab6e1cfa8d5918c2ce4ba43588e894af35dbd8e91e6e55c817bca5847df34a"},

tools/regen-readme.exs

@@ -46,12 +46,12 @@ defmodule Readme do
   defp update_command_blocks(lines_in) do
     blocks =
       %{
-        "mix.aoc.open" => Mix.Tasks.Aoc.Open,
-        "mix.aoc.create" => Mix.Tasks.Aoc.Create,
-        "mix.aoc.test" => Mix.Tasks.Aoc.Test,
-        "mix.aoc.run" => Mix.Tasks.Aoc.Run,
-        "mix.aoc.fetch" => Mix.Tasks.Aoc.Fetch,
-        "mix.aoc.url" => Mix.Tasks.Aoc.Url
+        "mix aoc.open" => Mix.Tasks.Aoc.Open,
+        "mix aoc.create" => Mix.Tasks.Aoc.Create,
+        "mix aoc.test" => Mix.Tasks.Aoc.Test,
+        "mix aoc.run" => Mix.Tasks.Aoc.Run,
+        "mix aoc.fetch" => Mix.Tasks.Aoc.Fetch,
+        "mix aoc.url" => Mix.Tasks.Aoc.Url
       }
 
     Enum.reduce(blocks, lines_in, fn {block_name, module}, lines ->
@@ -60,12 +60,12 @@ defmodule Readme do
         |> Code.fetch_docs()
         |> elem(4)
         |> Map.fetch!("en")
-        |> String.replace("## Usage", "#### Usage")
+        |> String.replace("## Synopsis", "#### Usage")
         |> String.replace("## Options", "#### Options")
 
       block_content = ["### ", block_name, "\n\n" | block_content]
 
-      update_block(lines, block_name, block_content)
+      update_block(lines, String.replace(block_name, " ","."), block_content)
     end)
   end
 end