Gleam与Mix集成项目教程

Gleam与Mix集成项目教程

目录结构及介绍

Gleam与Mix集成项目的目录结构如下：

mix_gleam/
├── github/
│   └── workflows/
├── lib/
├── test/
├── test_projects/
│   └── basic_project/
├── formatter.exs
├── .gitignore
├── CHANGELOG.md
├── LICENCE
├── README.md
├── mix.exs
└── mix.lock

详细介绍

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• lib/: 存放项目的主要代码文件。
• test/: 存放测试代码文件。
• test_projects/basic_project/: 包含一个基本的测试项目。
• formatter.exs: 代码格式化配置文件。
• .gitignore: Git忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENCE: 项目许可证。
• README.md: 项目说明文档。
• mix.exs: 项目的Mix配置文件。
• mix.lock: Mix依赖锁定文件。

项目的启动文件介绍

项目的启动文件主要是mix.exs，它包含了项目的配置信息和依赖管理。以下是mix.exs文件的主要内容：

defmodule MyGleamApp.MixProject do
  use Mix.Project

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

  defp deps do
    [
      {:gleam_stdlib, "~> 0.34 or ~> 1.0"},
      {:gleeunit, "~> 1.0", only: [:dev, :test], runtime: false}
    ]
  end
end

详细介绍

• app: 项目的名称。
• version: 项目的版本号。
• elixir: 所需的Elixir版本。
• start_permanent: 是否在生产环境中永久启动。
• deps: 项目的依赖列表。

项目的配置文件介绍

项目的配置文件主要是mix.exs，它包含了项目的配置信息和依赖管理。以下是mix.exs文件的主要内容：

defmodule MyGleamApp.MixProject do
  use Mix.Project

  def project do
    [
      app: :my_gleam_app,
      version: "0.1.0",
      elixir: "~> 1.15",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      compilers: [:gleam | Mix.compilers()],
      aliases: [
        "deps.get": ["deps.get", "gleam.deps.get"]
      ],
      erlc_paths: ["build/dev/erlang/#{@app}/_gleam_artefacts"],
      erlc_include_path: "build/dev/erlang/#{@app}/include",
      prune_code_paths: false
    ]
  end

  defp deps do
    [
      {:gleam_stdlib, "~> 0.34 or ~> 1.0"},
      {:gleeunit, "~> 1.0", only: [:dev, :test], runtime: false}
    ]
  end
end

详细介绍

• compilers: 编译器列表，包括Gleam编译器。
• aliases: 命令别名，例如deps.get命令。
• erlc_paths: Erlang编译路径。
• erlc_include_path: Erlang包含路径。
• prune_code_paths: 是否修剪代码路径。

以上是Gleam与Mix集成项目的详细教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！