Modify hex docs.open to fetch docs if not present locally #293
Conversation
fteem
force-pushed
the
docs_open_fetch
branch
from
3d1852a to
ae13752
Compare
| end | ||
| unless File.exists?(doc_path) do | ||
| fetch_docs([name, latest_version], opts) | ||
| end | ||
| open_docs([name, latest_version], opts) |
There was a problem hiding this comment.
Should this be open_file like below? It looks like this would loop infinitely.
There was a problem hiding this comment.
I guess it should be open_docs_offline([name, latest_version], opts) so we can drop the unless File.exists? from here as well.
fteem
force-pushed
the
docs_open_fetch
branch
from
ae13752 to
22887d9
Compare
| @@ -123,6 +126,14 @@ defmodule Mix.Tasks.Hex.Docs do | |||
| open_file(index_path) | |||
| end | |||
|
|
|||
| defp find_package_version(name, opts) do | |||
There was a problem hiding this comment.
Honestly I am not very happy with this function, but we somehow need check the latest version based on cache or remote version.
| @@ -113,7 +113,10 @@ defmodule Mix.Tasks.Hex.Docs do | |||
| end | |||
|
|
|||
| defp open_docs_offline([name], opts) do | |||
| latest_version = find_latest_version("#{opts[:home]}/#{name}") | |||
| { is_missing, latest_version } = find_package_version(name, opts) | |||
| if is_missing && Mix.shell.yes?("Documentation file not found, would you like to download it?") do | |||
There was a problem hiding this comment.
This should be done automatically, we should not prompt the user. If the user says no, it would just crash anyway.
| @@ -113,7 +113,10 @@ defmodule Mix.Tasks.Hex.Docs do | |||
| end | |||
|
|
|||
| defp open_docs_offline([name], opts) do | |||
| latest_version = find_latest_version("#{opts[:home]}/#{name}") | |||
| { is_missing, latest_version } = find_package_version(name, opts) | |||
|
Sorry for the back and forth but we should not prompt the user in this On Sat, Sep 24, 2016 at 8:15 PM, Ilija Eftimov [email protected]
Eric Meadows-Jönsson |
fteem
force-pushed
the
docs_open_fetch
branch
from
22887d9 to
ed8f83b
Compare
|
No probs. PR updated. |
Took a stab at #290
With this implementation, the task checks if the documentation for the package is locally present. Otherwise, it will fetch the latest version and open it in the browser.