[in-review] Code optimisations via adding the credo #285

imahmedismail · 2023-11-09T19:58:54Z

This PR involves the following changes:

Add credo to the project and:
- Run mix credo --all to identify possible code optimizations
- Resolve most of the errors generated by credo such as:
  - Numbers larger than 9999 should be written with underscores: 58_127
  - Modules should have a @moduledoc tag
  - Comparison will always return true

@moduledoc

- Run mix credo --all to identify possible code optimizations - Resolve most of the errors generated by credo such as: - Numbers larger than 9999 should be written with underscores: 58_127 - Modules should have a @moduledoc tag - Comparison will always return true

iamvery

This all seems pretty reasonable to me, and I don't have any strong feelings against Credo. There is one place that I think is a mistake (see requested change).

iamvery · 2023-11-09T22:36:18Z

test/blanks_test.exs

@@ -19,7 +19,7 @@ defmodule BlanksTest do
  end

  test "multiple arguments" do
-    ast = quote do: assert(___ == ___)
+    ast = quote do: assert true == false


Suggested change

ast = quote do: assert true == false

ast = quote do: assert ___ == ___

This is done.
cc: @iamvery

iamvery · 2023-11-10T13:09:11Z

I added configuration for credo to run in CI using --strict mode and fixed the suggestions it made. Thanks for the idea and getting this started!

imahmedismail changed the title ~~[in-review] Add credo to the project and:~~ [in-review] Code optimisations via adding the credo Nov 9, 2023

iamvery requested changes Nov 9, 2023

View reviewed changes

Revert back test/blanks_test.exs to original state

ca3e758

imahmedismail requested a review from iamvery November 10, 2023 08:21

iamvery added 4 commits November 10, 2023 07:00

Run credo in CI

cbd5df4

Skip a couple warnings

9a6999e

More explicit credo command in CI

ec227f7

Fix results from $ mix credo suggest --all --strict

07f24b3

iamvery merged commit 0eb56c2 into elixirkoans:master Nov 10, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[in-review] Code optimisations via adding the credo #285

[in-review] Code optimisations via adding the credo #285

imahmedismail commented Nov 9, 2023

iamvery left a comment

iamvery Nov 9, 2023

imahmedismail Nov 10, 2023 •

edited

Loading

iamvery commented Nov 10, 2023

	ast = quote do: assert true == false
	ast = quote do: assert ___ == ___

[in-review] Code optimisations via adding the credo #285

[in-review] Code optimisations via adding the credo #285

Conversation

imahmedismail commented Nov 9, 2023

iamvery left a comment

Choose a reason for hiding this comment

iamvery Nov 9, 2023

Choose a reason for hiding this comment

imahmedismail Nov 10, 2023 • edited Loading

Choose a reason for hiding this comment

iamvery commented Nov 10, 2023

imahmedismail Nov 10, 2023 •

edited

Loading