Eiji

Eiji

How about add optional dependencies?

defmodule MyApp.MixFile do
  use Mix.Project

  def project do
    [
      app: :my_app,
      version: "0.1.0",
      elixir: "~> 1.4",
      elixirc_paths: elixirc_paths(Mix.env),
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
      aliases: aliases(),
      deps: deps(),
      optional_deps: optional_deps(),
    ]
  end

  # ...
end

and example code:

defmodule MyApp.Things.Special do
  @behavior MyApp.Thing
  # don't compile this module if we don't have an optional library
  @module_depends_on: :optional_library

  def example(), do: OptionalLibrary.example()

  # or:

  # don't compile this method if we don't have an another optional library
  @depends_on: :another_optional_library
  def something(), do: AnotherOptionalLibrary.something()
end

mix deps.get should ask if we want an optional dependency in our setup.

Here I think like Gentoo user. In this source based distribution we can choose USE flags so we can compile package for example: with sound support and without bluetooth support. Of course it’s only simple example that probably should be more explained and discussed.

What do you think about my idea? Maybe instead of choosing packages we should choose something like USE flags, so we could provide easy pre-setup for deployment administrators?

Showing Posts 1 to 2

josevalim

josevalim

Creator of Elixir

We already support optional dependencies by specifying optional: true in your dependencies and then you can use something like if Code.ensure_loaded?(ModuleInADep) to check if a dependency is available or not.

Eiji

Eiji OP

@josevalim: Thanks for response. I see that I was not clear …

I found Mix.Tasks.Deps docs for it:

:optional - marks the dependency as optional. In such cases, the current project will always include the optional dependency but any other project that depends on the current project won’t be forced to use the optional dependency. However, if the other project includes the optional dependency on its own, the requirements and options specified here will also be applied.
It’s good for libraries, so primary project decides if dependency is required or not - that’s ok, but it’s not what I was looking for.

First of all my example is primary project - not 3rd party library - it’s ready (only example case) app to deploy.
Now we have based linux admin that got task to install our project and configure it. He needs to know what exactly packages provide features that he needs- I think it’s not clear for non-elixir administrators. We already know for what are floki, flow and other projects, but not everyone needs to know them.

Let me give another more complex example:

defmodule Example.Mixfile do
  use Mix.Project

  def application(), do: [extra_applications: [:logger]]

  def project do
    [
      app: :example,
      build_embedded: Mix.env == :prod,
      deploy_deps: deploy_deps(),
      deps: [],
      elixir: "~> 1.4.0",
      start_permanent: Mix.env == :prod,
      version: "0.1.0",
    ]
  end

  defp deploy_deps do
    [
      {
        # Simple groups descritpion like:
        :audio, [
          # optional package list for support audio
        ]
      }
    }
  end
end

and fetching dependencies:

mix deps.get
Running dependency resolution...

Getting required dependencies:
* Getting first_required_dependency (Hex package)
  Checking package (https://repo.hex.pm/tarballs/flow-0.11.0.tar)
  Fetched package

Would you like to add: "audio" support? [Y/n] Y
* Getting first_optional_audio_dependency (Hex package)
  Checking package (https://repo.hex.pm/tarballs/flow-0.11.0.tar)
  Fetched package
* Getting first_optional_audio_dependency (Hex package)
  Checking package (https://repo.hex.pm/tarballs/flow-0.11.0.tar)
  Fetched package

Would you like to add: "..." support? [Y/n] n
* Package first_optional_..._dependency (Hex package) is skipped.

Secondly, see comparison of if and module attribute:

if Code.ensure_loaded?(ModuleInADep) do
  defmodule ModuleName do
    # ...
  end
end

defmodule ModuleName do
  if Code.ensure_loaded?(ModuleInADep) do
    def method_a_name(), do: ModuleInADep.method_name()
  end
  
  if Code.ensure_loaded?(ModuleInBDep) do
    def method_b_name(), do: ModuleInBDep.method_name()
  end
end

# compare to:

defmodule ModuleName do
  # for example: where Experimental.Flow is declared?
  # I think that package name is much more cleaner here.
  @module_depends_on :package_name
  # ...
end

defmodule ModuleName do
  @depends_on: :optional_library_a
  def method_a_name(), do: ModuleInADep.method_name()
  
  @depends_on: :optional_library_b
  def method_b_name(), do: ModuleInBDep.method_name()
end

What do you think about it?

— All posts loaded —

Where Next? Top

Trending in Discussions Top

AstonJ
The obligatory hello world thread! Who are you and where are you from? :stuck_out_tongue:
4663 61218 595
New
cblavier
Hey there, It’s been more than a year since we started using LiveView as our main UI library and building a whole library of UI componen...
515 12931 101
New
wmnnd
Hey folks, I wanted to share with you a project I’ve been working on for a while: It’s an Open Source (AGPLv3) newsletter tool. Think Ma...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
sntran
In my third year of college, around 2010, I found Erlang. A few years later, I found Elixir. I liked the ideas at once: many small proces...
New
Ganna
Hi everyone, I have 8 years of production experience with Erlang/OTP and I’m just starting to get to know Elixir. What would you learn f...
New
gtcode
I’ve been tinkering with Lynx (by José) via hold_ledger. I used AI to write the code, a separate specification, the tests, and the Lean p...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New
webofbits
With AI doing more of the implementation work, I’ve been wondering how much coding I should deliberately keep doing myself. My main conc...
#ai
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews