Games: Documentation and Static Analysis

Mix.install([
  {:jason, "~> 1.4"},
  {:kino, "~> 0.8.0", override: true},
  {:youtube, github: "brooklinjazz/youtube"},
  {:hidden_cell, github: "brooklinjazz/hidden_cell"}
])

Navigation

Return Home Report An Issue

Games: Documentation & DocTesting

Document your existing Games project. Add documentation tests for the Games.RockPaperScissors and Games.Wordle modules.

Games: ExDocs

Add ExDocs to your existing Games project.

Run the following command to generate project documentation. Re-run the command to update project documentation.

mix docs

Games: Typespecs

Add typespecs to your Games.RockPaperScissors and Games.Wordle modules. Each public function should have an associated @spec.

Games: Dialyzer

Add Dialyxir to your existing Games project. You should be able to verify the typespecs in your application by running the following command.

mix dialyzer

Ensure all checks pass and fix any dialyzer errors.

Games: Credo

Add Credo to your existing Games project.

You should be able to run credo with the following command. Ensure that all checks pass and fix any errors or credo suggestions.

mix credo

Mark As Completed

file_name = Path.basename(Regex.replace(~r/#.+/, __ENV__.file, ""), ".livemd")

save_name =
  case Path.basename(__DIR__) do
    "reading" -> "games_documentation_and_static_analysis_reading"
    "exercises" -> "games_documentation_and_static_analysis_exercise"
  end

progress_path = __DIR__ <> "/../progress.json"
existing_progress = File.read!(progress_path) |> Jason.decode!()

default = Map.get(existing_progress, save_name, false)

form =
  Kino.Control.form(
    [
      completed: input = Kino.Input.checkbox("Mark As Completed", default: default)
    ],
    report_changes: true
  )

Task.async(fn ->
  for %{data: %{completed: completed}} <- Kino.Control.stream(form) do
    File.write!(
      progress_path,
      Jason.encode!(Map.put(existing_progress, save_name, completed), pretty: true)
    )
  end
end)

form

Commit Your Progress

Run the following in your command line from the curriculum folder to track and save your progress in a Git commit. Ensure that you do not already have undesired or unrelated changes by running git status or by checking the source control tab in Visual Studio Code.

$ git checkout -b games-documentation-and-static-analysis-exercise
$ git add .
$ git commit -m "finish games documentation and static analysis exercise"
$ git push origin games-documentation-and-static-analysis-exercise

Create a pull request from your games-documentation-and-static-analysis-exercise branch to your solutions branch. Please do not create a pull request to the DockYard Academy repository as this will spam our PR tracker.

DockYard Academy Students Only:

Notify your teacher by including @BrooklinJazz in your PR description to get feedback. You (or your teacher) may merge your PR into your solutions branch after review.

If you are interested in joining the next academy cohort, sign up here to receive more news when it is available.

Up Next