Elixir Phone 项目使用教程

Elixir Phone 项目使用教程

phone Elixir phone number parser for numbers in international standard. 项目地址: https://gitcode.com/gh_mirrors/phone1/phone

1. 项目的目录结构及介绍

phone/
├── bench/
├── lib/
├── test/
├── credo.exs
├── formatter.exs
├── .gitignore
├── sourcelevel.yml
├── travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── coveralls.json
└── mix.exs

目录结构介绍

• bench/: 包含项目的基准测试文件。
• lib/: 包含项目的主要代码文件。
• test/: 包含项目的测试文件。
• credo.exs: 代码质量检查工具 Credo 的配置文件。
• formatter.exs: 代码格式化工具的配置文件。
• .gitignore: Git 忽略文件配置。
• sourcelevel.yml: SourceLevel 的配置文件。
• travis.yml: Travis CI 的配置文件。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• coveralls.json: Coveralls 的配置文件。
• mix.exs: 项目的配置文件，包含依赖项和项目配置。

2. 项目的启动文件介绍

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

defmodule Phone.MixProject do
  use Mix.Project

  def project do
    [
      app: :phone,
      version: "0.5.0",
      elixir: "~> 1.10",
      start_permanent: Mix.env() == :prod,
      deps: deps()
    ]
  end

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      {:ex_doc, "~> 0.21", only: :dev, runtime: false}
    ]
  end
end

主要配置项

• app: 项目的名称，这里是 :phone。
• version: 项目的版本号，这里是 0.5.0。
• elixir: 项目所需的 Elixir 版本。
• start_permanent: 是否在生产环境中永久启动。
• deps: 项目的依赖项，这里只有一个开发依赖 ex_doc。

3. 项目的配置文件介绍

项目的配置文件主要包括 mix.exs 和 credo.exs。

mix.exs

mix.exs 文件已经在启动文件介绍中详细说明，它包含了项目的依赖项和基本配置。

credo.exs

credo.exs 是代码质量检查工具 Credo 的配置文件，用于确保代码风格的一致性和代码质量。以下是 credo.exs 文件的示例内容：

%{
  configs: [
    %{
      name: "default",
      files: %{
        included: ["lib/", "src/", "web/", "apps/"],
        excluded: []
      },
      checks: [
        {Credo.Check.Consistency.TabsOrSpaces},
        {Credo.Check.Design.AliasUsage, if_nested_deeper_than: 2, if_called_more_often_than: 0},
        {Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 80}
      ]
    }
  ]
}

主要配置项

• files: 指定需要检查的文件路径。
• checks: 指定需要执行的检查项，例如代码风格、命名规范等。

通过以上配置文件，可以确保项目的代码质量和一致性。

phone Elixir phone number parser for numbers in international standard. 项目地址: https://gitcode.com/gh_mirrors/phone1/phone