exercism / exercism/elixir-analyzer

Universal checks for every single solution?

Open
#97 21 comments 0 reactions 0 assignees View on GitHub
discussion 💬
Dominant language
Elixir
Stars
33
Forks
33
PR merge metrics
No merged PRs in 30d

Description

As I mentor, I keep seeing some reoccurring problems with solutions that are exercise-independent and could, at least partially, be detected automatically.

A code snippet from a real recent solution:
```elixir
@spec reverse(list) :: list
defp reverseHelper([], reversed) do
reversed
end
defp reverseHelper([x|xs], reversed) do
reverseHelper(xs, [x|reversed])
end

def reverse(l) do
reverseHelper(l,[])
end
```

The analyzer could detect and give a suggestion to the user that:
- `@spec` for a function should be placed directly above that function definition, there shouldn't be a different function definition in between
- function (and variable) names should use snake_case

More opinionated, but we could also check if each public function has a `@spec` and `@doc` and nudge students to add them (for practice exercises only).

Without parsing the AST, we could check if the code is intended with spaces or with tabs.

I think in particular the camelCase and indenting are worth doing in the analyzer, because they're hard no-nos in community Elixir code, but they're annoying details that are pretty uncomfortable to point out to a new comer. It would be nicer if a machine did that 🙂.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.