Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a newline after moduledocs #105

Closed
wants to merge 1 commit into from
Closed

Add a newline after moduledocs #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lib/style/module_directives.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ defmodule Styler.Style.ModuleDirectives do
@directives ~w(alias import require use)a
@attr_directives ~w(moduledoc shortdoc behaviour)a

@moduledoc_false {:@, [line: nil], [{:moduledoc, [line: nil], [{:__block__, [line: nil], [false]}]}]}
@moduledoc_false {:@, [end_of_expression: [newlines: 2, line: nil], line: nil],
[{:moduledoc, [line: nil], [{:__block__, [line: nil], [false]}]}]}

def run({{:defmodule, _, children}, _} = zipper, ctx) do
[name, [{{:__block__, do_meta, [:do]}, _body}]] = children
Expand Down Expand Up @@ -149,7 +150,7 @@ defmodule Styler.Style.ModuleDirectives do
end)

shortdocs = directives[:"@shortdoc"] || []
moduledocs = directives[:"@moduledoc"] || List.wrap(moduledoc)
moduledocs = (directives[:"@moduledoc"] || List.wrap(moduledoc)) |> reset_newlines()
behaviours = expand_and_sort(directives[:"@behaviour"] || [])

uses = (directives[:use] || []) |> Enum.flat_map(&expand_directive/1) |> reset_newlines()
Expand Down
6 changes: 6 additions & 0 deletions test/style/module_directives_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,15 @@ defmodule Styler.Style.ModuleDirectivesTest do

defmodule B do
@moduledoc false

defmodule C do
@moduledoc false
end
end

defmodule Bar do
@moduledoc false

alias Bop.Bop

:ok
Expand All @@ -100,11 +102,13 @@ defmodule Styler.Style.ModuleDirectivesTest do

defmodule Foo do
@moduledoc false

use Bar
end

defmodule Foo do
@moduledoc false

alias Foo.Bar
alias Foo.Baz
end
Expand Down Expand Up @@ -175,6 +179,7 @@ defmodule Styler.Style.ModuleDirectivesTest do
|> File.read!()
|> String.split("<!-- MDOC !-->")
|> Enum.fetch!(1)

@behaviour Chaotic
@behaviour Lawful

Expand Down Expand Up @@ -397,6 +402,7 @@ defmodule Styler.Style.ModuleDirectivesTest do
defmodule Foo do
# mdf
@moduledoc false

alias A.A
# B
alias B.B
Expand Down