Skip to content

ModuleDispatcher: dispatch on symbols (module name) instead of dispatching on modules #127

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ModuleDispatcher: dispatch on symbols (module name) instead of dispatching on modules #127

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
11 changes: 6 additions & 5 deletions src/ExplicitImports.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,21 +321,21 @@ end
struct ModuleDispatcher{T} end

"""
ignore_submodules(::ModuleDispatcher{mod}) where {mod}
ignore_submodules(::ModuleDispatcher{modname}) where {modname}

Tell ExplicitImports to ignore direct submodules of `mod`. For example, ExplicitImports
Tell ExplicitImports to ignore direct submodules of `modname`. For example, ExplicitImports
vendors a copy of JuliaSyntax to avoid compatibility issues. In order for ExplicitImports to ignore
that submodule when analyzing itself, we add a method:

```julia
ExplicitImports.ignore_submodules(::ExplicitImports.ModuleDispatcher{ExplicitImports}) = (ExplicitImports.Vendored,)
ExplicitImports.ignore_submodules(::ExplicitImports.ModuleDispatcher{:ExplicitImports}) = (ExplicitImports.Vendored,)
```

Other packages can add methods to `ignore_submodules` in the same way (presumably via a package extension).
"""
ignore_submodules(::ModuleDispatcher{T}) where {T} = ()

ignore_submodules(::ModuleDispatcher{ExplicitImports}) = (Vendored,)
ignore_submodules(::ModuleDispatcher{:ExplicitImports}) = (Vendored,)

# recurse through to find all submodules of `mod`
function _find_submodules(mod)
Expand All @@ -354,7 +354,8 @@ function _find_submodules(mod)
end
if is_submodule
submod = getglobal(mod, name)
if submod ∉ sub_modules && submod ∉ ignore_submodules(ModuleDispatcher{mod}())
modname = Symbol(mod)
if submod ∉ sub_modules && submod ∉ ignore_submodules(ModuleDispatcher{modname}())
union!(sub_modules, _find_submodules(submod))
end
end
Expand Down
Loading