Ormolu安装与配置指南

Ormolu安装与配置指南

ormolu A formatter for Haskell source code 项目地址: https://gitcode.com/gh_mirrors/or/ormolu

1. 项目基础介绍

Ormolu是一个用于格式化Haskell源代码的工具。它的目标是生成风格统一、符合现代Haskell语法的代码格式，并且可以通过GHC（Glasgow Haskell Compiler）的内置解析器来避免解析问题。Ormolu的输出格式旨在与用户的输入布局有一定的关联，使得某些空白字符可以被编程控制，以此简化实现并给予用户一定的布局选择权。

主要编程语言：Haskell

2. 关键技术和框架

• GHC的内置解析器：Ormolu使用GHC的内置解析器来避免因使用haskell-src-exts等库可能引起的解析问题。
• 布局控制：通过用户的输入布局影响输出布局，用户可以在一定程度上控制单行/多行布局的选择。
• 风格一致性：Ormolu旨在生成风格一致的代码，即使对于已经格式化过的代码，再次格式化也不会产生任何改变。

3. 安装和配置

准备工作

在开始安装之前，请确保您的系统中已经安装了以下依赖：

• GHC（Glasgow Haskell Compiler）
• Cabal或Stack（用于构建和安装Haskell库和应用程序的工具）

安装步骤

使用Cabal安装

1. 打开终端或命令提示符。

2. 输入以下命令来安装Ormolu：

cabal install ormolu

使用Stack安装

1. 打开终端或命令提示符。

2. 输入以下命令来安装Ormolu：

stack install ormolu

使用Nix安装

1. 打开终端或命令提示符。

2. 输入以下命令来构建Ormolu：

nix build

3. 若要安装Ormolu，请使用以下命令：

stack install

使用Nix flakes安装

1. 在Nix配置文件中添加以下内容：

{
  inputs = {
    ormolu = {
      url = "github:tweag/ormolu";
    };
  };
  outputs = {
    ormolu = ...
  };
}

2. 按照Nix的指示构建和安装Ormolu。

安装完成后，您可以使用以下命令来格式化Haskell源代码文件：

ormolu <file.hs>

如果要替换原文件，请使用--mode inplace参数：

ormolu --mode inplace <file.hs>

如果要递归地格式化一个目录中的所有.hs文件，请使用以下命令：

ormolu --mode inplace $(find . -name '*.hs')

请确保遵循上述步骤进行操作，以便成功安装和配置Ormolu。

ormolu A formatter for Haskell source code 项目地址: https://gitcode.com/gh_mirrors/or/ormolu