Skip to content

Handle missing project version #732

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

Closed
wants to merge 1 commit into from
Closed

Handle missing project version #732

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
10 changes: 9 additions & 1 deletion lib/ex_doc/formatter/epub.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,18 @@ defmodule ExDoc.Formatter.EPUB do
output =
config.output
|> Path.expand()
|> Path.join("#{config.project}-v#{config.version}")
|> Path.join(project_directory(config))
%{config | output: output}
end

defp project_directory(config) do
if config.version do
"#{config.project}-v#{config.version}"
else
config.project
end
end

defp generate_extras(config) do
for {_title, extras} <- config.extras do
Enum.each(extras, fn %{id: id, title: title, content: content} ->
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/epub/templates/content_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
unique-identifier="project-<%= config.project %>"
version="3.0">
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
<dc:title><%= config.project %> - <%= config.version %></dc:title>
<dc:title><%= config.project %> <%= if config.version do %> - <%= config.version %><% end %></dc:title>
<dc:identifier id="project-<%= config.project %>"><%= uuid %></dc:identifier>
<dc:language><%= config.language %></dc:language>
<meta property="dcterms:modified"><%= datetime %></meta>
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/epub/templates/head_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<meta charset="utf-8" />
<title><%= page.title %> - <%= config.project %> v<%= config.version %></title>
<title><%= page.title %> - <%= config.project %><%= if config.version do %> v<%= config.version %><% end %></title>
<meta name="generator" content="ExDoc v<%= ExDoc.version %>" />
<link type="text/css" rel="stylesheet" href="<%= H.asset_rev "#{config.output}/OEBPS", "dist/epub*.css" %>" />
<script src="<%= H.asset_rev "#{config.output}/OEBPS", "dist/app*.js" %>"></script>
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/epub/templates/title_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<%= head_template(config, %{title: "Cover"}) %>
<div class="title-container">
<h1><%= config.project %></h1>
<h2>v<%= config.version %></h2>
<%= if config.version do %><h2>v<%= config.version %></h2><% end %>
<%= if logo = config.logo do %>
<div><img src="assets/logo<%= Path.extname(logo) %>" alt="Logo"/></div>
<% end %>
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/html/templates/api_reference_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1>
<small class="visible-xs"><%= config.project %> v<%= config.version %></small>
<small class="visible-xs"><%= config.project %> <%= if config.version do %>v<%= config.version %><% end %></small>
API Reference
</h1>

Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/html/templates/head_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v<%= ExDoc.version %>">
<title><%= page.title %> – <%= config.project %> v<%= config.version %></title>
<title><%= page.title %> – <%= config.project %><%= if config.version do %> v<%= config.version %><% end %></title>
<link rel="stylesheet" href="<%= asset_rev config.output, "dist/app*.css" %>" />
<%= if config.canonical do %>
<link rel="canonical" href="<%= config.canonical %>" />
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/html/templates/module_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<%= sidebar_template(config, nodes_map) %>

<h1>
<small class="visible-xs"><%= config.project %> v<%= config.version %></small>
<small class="visible-xs"><%= config.project %><%= if config.version do %> v<%= config.version %><% end %></small>
<%= module_title(module) %>
<%= if module.source_url do %>
<a href="<%= module.source_url %>" title="View Source" class="view-source" rel="help">
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/formatter/html/templates/redirect_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<title><%= config.project %> v<%= config.version %> – Documentation</title>
<title><%= config.project %><%= if config.version do %> v<%= config.version %><% end %> – Documentation</title>
<meta http-equiv="refresh" content="0; url=<%= h(redirect_to) %>">
<meta name="robots" content="noindex">
<meta name="generator" content="ExDoc v<%= ExDoc.version %>">
Expand Down
8 changes: 5 additions & 3 deletions lib/ex_doc/formatter/html/templates/sidebar_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
<h1 class="sidebar-projectName">
<%= config.project %>
</h1>
<h2 class="sidebar-projectVersion">
v<%= config.version %>
</h2>
<%= if config.version do %>
<h2 class="sidebar-projectVersion">
v<%= config.version %>
</h2>
<% end %>
</div>
<%= if config.logo do %>
<img src="<%= logo_path(config) %>" alt="<%= config.project %>" class="sidebar-projectImage">
Expand Down
11 changes: 1 addition & 10 deletions lib/mix/tasks/docs.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ defmodule Mix.Tasks.Docs do
end

project = to_string(config[:name] || config[:app])
version = fetch_version!(config)
version = config[:version]
options =
config
|> get_docs_opts()
Expand All @@ -140,15 +140,6 @@ defmodule Mix.Tasks.Docs do
end
end

defp fetch_version!(config) do
case Keyword.fetch(config, :version) do
{:ok, version} ->
version
:error ->
raise ArgumentError, ":version key is required in config, got: #{inspect(config)}"
end
end

defp get_formatters(options) do
case Keyword.get_values(options, :formatter) do
[] -> options[:formatters] || [ExDoc.Config.default(:formatter)]
Expand Down
10 changes: 2 additions & 8 deletions test/mix/tasks/docs_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,13 @@ defmodule Mix.Tasks.DocsTest do

test "supports umbrella project" do
Mix.Project.in_project(:umbrella, "test/fixtures/umbrella", fn _mod ->
assert [{"umbrella", "1.2.3-dev", [formatter: "html", deps: deps, source_beam: _]}] =
run([], [app: :umbrella, apps_path: "apps/", version: "1.2.3-dev"])
assert [{"umbrella", nil, [formatter: "html", deps: deps, source_beam: _]}] =
run([], [app: :umbrella, apps_path: "apps/"])

assert List.keyfind(deps, Application.app_dir(:foo), 0) ==
{Application.app_dir(:foo), "https://hexdocs.pm/foo/0.1.0/"}
assert List.keyfind(deps, Application.app_dir(:bar), 0) ==
{Application.app_dir(:bar), "https://hexdocs.pm/bar/0.1.0/"}
end)
end

test "raise when version is not provided" do
assert_raise ArgumentError, ~r/:version key is required in config, got: /, fn ->
run([], [app: :ex_doc])
end
end
end