Dotenv Elixir 项目教程
dotenv_elixirA port of dotenv to Elixir项目地址:https://gitcode.com/gh_mirrors/do/dotenv_elixir
1. 项目的目录结构及介绍
dotenv_elixir/
├── .github/
│ └── workflows/
│ └── main.yml
├── lib/
│ ├── dotenv.ex
│ └── dotenv/
│ ├── parser.ex
│ └── transformer.ex
├── test/
│ ├── dotenv_test.exs
│ └── test_helper.exs
├── .formatter.exs
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── mix.exs
└── mix.lock
- .github/workflows/main.yml: GitHub Actions 的工作流配置文件。
- lib/: 包含项目的核心代码。
- dotenv.ex: 主模块文件。
- dotenv/parser.ex: 负责解析
.env
文件的模块。 - dotenv/transformer.ex: 负责转换解析后的数据的模块。
- test/: 包含测试文件。
- dotenv_test.exs: 针对
dotenv
模块的测试。 - test_helper.exs: 测试辅助文件。
- dotenv_test.exs: 针对
- .formatter.exs: Elixir 代码格式化配置文件。
- .gitignore: Git 忽略文件配置。
- CHANGELOG.md: 项目变更日志。
- LICENSE.md: 项目许可证。
- README.md: 项目说明文档。
- mix.exs: 项目的依赖和应用配置文件。
- mix.lock: 锁定依赖版本的文件。
2. 项目的启动文件介绍
项目的启动文件是 lib/dotenv.ex
。这个文件定义了 Dotenv
模块,并包含了加载和解析 .env
文件的主要逻辑。
defmodule Dotenv do
@moduledoc """
Documentation for `Dotenv`.
"""
@doc """
Loads environment variables from a `.env` file.
"""
def load do
# 加载和解析逻辑
end
end
3. 项目的配置文件介绍
- .formatter.exs: 这个文件用于配置 Elixir 代码格式化规则。
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]
- mix.exs: 这个文件包含了项目的依赖、应用配置等信息。
defmodule Dotenv.MixProject do
use Mix.Project
def project do
[
app: :dotenv,
version: "0.1.0",
elixir: "~> 1.11",
start_permanent: Mix.env() == :prod,
deps: deps()
]
end
def application do
[
extra_applications: [:logger]
]
end
defp deps do
[]
end
end
通过这些配置文件,可以管理项目的依赖、编译选项和运行时配置。
dotenv_elixirA port of dotenv to Elixir项目地址:https://gitcode.com/gh_mirrors/do/dotenv_elixir